ALIYUN::OTS::InstanceV2 - Resource Orchestration Service

The ALIYUN::OTS::InstanceV2 resource type is used to create a new Tablestore instance.

Syntax

{
  "Type": "ALIYUN::OTS::InstanceV2",
  "Properties": {
    "ClusterType": String,
    "InstanceName": String,
    "InstanceDescription": String,
    "NetworkSourceACL": List,
    "NetworkTypeACL": List,
    "ResourceGroupId": String,
    "Tags": List
  }
}

Properties

Property name	Type	Required	Editable	Description	Constraint
ClusterType	String	Yes	No	Cluster type.	Valid values: SSD: high-performance instance HYBRID: capacity instance
InstanceName	String	Yes	No	Instance name.	Instance naming conventions: Must consist of letters, digits or hyphens(-). The first character must be a letter. The last character cannot be a hyphen(-). Case-insensitive. The length must be between 3 to 16 characters. The instance name cannot contain the following words: ali, ay, ots, taobao, or admin.
InstanceDescription	String	No	Yes	The instance description.	The length must be between 3 to 256 characters.
NetworkSourceACL	List	No	Yes	The list of network sources allowed by the instance.	Maximum of 1 configuration item is supported. Valid values: TRUST_PROXY: Trusted gateway
NetworkTypeACL	List	No	Yes	The types of the network from which access is allowed. Valid values:	Maximum of 3 configuration items are supported. Valid values: INTERNET: Public network VPC: Virtual private cloud network CLASSIC: classic network
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
Tags	List	No	Yes	Tags that are attached to the data cache.	Maximum of 20 tags are supported. For more information, refer to Tags properties.

Tags syntax

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags properties

Property name	Type	Required	Editable	Description	Constraint
Key	String	Yes	No	The tag key.	None
Value	String	Yes	No	The tag value.	None

Return values

Fn::GetAtt

InstanceName: The name of the tablestore instance.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceName:
    Type: String
    Description:
      en: |
        Instance name.The naming specifications for instances are as follows:
        Must consist of English letters, numbers or dash lines (-).
        The first character must be in English letters.
        The end character cannot be a dash (-).
        Insensitive case.
        The length is between 3 and 16 characters.
    Required: true
    AllowedPattern: '[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]$'
    MinLength: 3
    MaxLength: 16
  ClusterType:
    Type: String
    Description:
      en: |-
        Cluster type (i.e. instance specification).
        Enumeration values:
        SSD: High performance.
        HYBRID: Capacity type.
    AllowedValues:
      - SSD
      - HYBRID
    Required: true
Resources:
  InstanceV2:
    Type: ALIYUN::OTS::InstanceV2
    Properties:
      InstanceName:
        Ref: InstanceName
      ClusterType:
        Ref: ClusterType
Outputs:
  InstanceName:
    Description: Name of the tablestore instance.
    Value:
      Fn::GetAtt:
        - InstanceV2
        - InstanceName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceName": {
      "Type": "String",
      "Description": {
        "en": "Instance name.The naming specifications for instances are as follows:\nMust consist of English letters, numbers or dash lines (-).\nThe first character must be in English letters.\nThe end character cannot be a dash (-).\nInsensitive case.\nThe length is between 3 and 16 characters.\n"
      },
      "Required": true,
      "AllowedPattern": "[A-Za-z][A-Za-z0-9\\-]*[A-Za-z0-9]$",
      "MinLength": 3,
      "MaxLength": 16
    },
    "ClusterType": {
      "Type": "String",
      "Description": {
        "en": "Cluster type (i.e. instance specification).\nEnumeration values:\nSSD: High performance.\nHYBRID: Capacity type."
      },
      "AllowedValues": [
        "SSD",
        "HYBRID"
      ],
      "Required": true
    }
  },
  "Resources": {
    "InstanceV2": {
      "Type": "ALIYUN::OTS::InstanceV2",
      "Properties": {
        "InstanceName": {
          "Ref": "InstanceName"
        },
        "ClusterType": {
          "Ref": "ClusterType"
        }
      }
    }
  },
  "Outputs": {
    "InstanceName": {
      "Description": "Name of the tablestore instance.",
      "Value": {
        "Fn::GetAtt": [
          "InstanceV2",
          "InstanceName"
        ]
      }
    }
  }
}