ALIYUN::ADB::DBCluster is used to create an AnalyticDB for MySQL cluster.
Syntax
{
"Type": "ALIYUN::ADB::DBCluster",
"Properties": {
"DBNodeStorage": Integer,
"PeriodType": String,
"DBClusterCategory": String,
"ZoneId": String,
"ResourceGroupId": String,
"VPCId": String,
"VSwitchId": String,
"Mode": String,
"DBClusterDescription": String,
"ComputeResource": String,
"Period": Integer,
"PayType": String,
"ElasticIOResource": Integer,
"DBClusterVersion": String,
"DBNodeGroupCount": Integer,
"ExecutorCount": Integer,
"DBClusterClass": String,
"Tags": List
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
DBNodeStorage | Integer | No | Yes | The storage capacity of the node. Unit: GB. | This property is required if you set the Mode property to Reserver. Unit: GB. Valid values:
Note The storage capacity smaller than 1,000 GB increases in increments of 100 GB. The storage capacity larger than 1,000 GB increases in increments of 1,000 GB. |
PeriodType | String | No | No | The unit of the subscription duration of the cluster. | This property is required if you set the PayType property to Prepaid. Valid values:
|
DBClusterCategory | String | Yes | Yes | The edition of the cluster. | Valid values:
For more information, see Editions. |
ZoneId | String | No | No | The zone ID of the cluster. | You can call the DescribeRegions operation to query the most recent zone list. |
ResourceGroupId | String | No | Yes | The ID of the resource group. | None |
VPCId | String | Yes | No | The ID of the virtual private cloud (VPC) in which you want to create cluster. | None |
VSwitchId | String | Yes | No | The ID of the vSwitch to which you want to connect the cluster. | None |
Mode | String | Yes | No | The mode of the cluster. | Valid values:
|
DBClusterDescription | String | No | No | The description of the cluster. | None |
ComputeResource | String | No | Yes | The computing resource that you want to allocate to the cluster. |
This property is required if you set the Mode property to Flexible. Note You can call the DescribeAvailableResource operation to query the computing resources that are available within a specific region. |
Period | Integer | No | No | The subscription period of the cluster. | This property is required if you set the PayType property to Prepaid. Valid values:
|
PayType | String | Yes | No | The billing method of the cluster. | Valid values:
|
ElasticIOResource | Integer | No | Yes | The elastic I/O units (EIUs) of the cluster. | This property is required if you set the Mode property to Flexible. For more information, see Use EIUs to scale up storage resources. |
DBClusterVersion | String | Yes | No | The version of the cluster. | Set the value to 3.0. |
DBNodeGroupCount | Integer | No | Yes | The number of node groups in the cluster. | The value of this property must be an integer that ranges from 1 to 200. Note This property is required if you set the Mode property to Reserver. |
ExecutorCount | Integer | No | No | The number of compute nodes in the cluster if you set the Mode property to Flexible. | None |
DBClusterClass | String | No | Yes | The specification of the cluster. | Valid values:
Note This property is required if you set the Mode property to Reserver. |
Tags | List | No | Yes | The tags of the cluster. | You can specify up to 20 tags for the cluster. For more information, see Tags properties. |
Tags syntax
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
Key | String | Yes | No | The key of the tag. | The tag key must be 1 to 128 characters in length and cannot contain |
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length and cannot contain |
Return values
Fn::GetAtt
DBClusterId: the ID of the cluster.
OrderId: the order ID of the cluster.
ConnectionString: the VPC endpoint of the cluster.