ALIYUN::ClickHouse::DBCluster is used to create an ApsaraDB for ClickHouse cluster.
Syntax
{
"Type": "ALIYUN::ClickHouse::DBCluster",
"Properties": {
"DbNodeStorageType": String,
"DBNodeStorage": Integer,
"EncryptionType": String,
"Category": String,
"ZoneId": String,
"VSwitchId": String,
"DBClusterDescription": String,
"Period": String,
"EncryptionKey": String,
"DBClusterNetworkType": String,
"DBClusterType": String,
"VpcId": String,
"DBClusterVersion": String,
"DBNodeCount": Integer,
"UsedTime": Integer,
"PaymentType": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
DbNodeStorageType | String | Yes | No | The storage type of the node. | Valid values:
|
DBNodeStorage | Integer | Yes | Yes | The storage capacity of the node. | Valid values: 100 to 10000. Unit: GB. The value must be in increments of 100 GB. |
EncryptionType | String | No | No | Specifies whether to enable disk encryption. | Set the value to CloudDisk. This value specifies that disk encryption is used for the cluster. |
Category | String | Yes | No | The edition of the cluster. | Valid values:
|
ZoneId | String | No | No | The zone ID of the cluster. | You can call the DescribeRegions operation to query the most recent zone list. |
VSwitchId | String | No | No | The vSwitch ID of the cluster. | None. |
DBClusterDescription | String | No | Yes | The description of the cluster. | None. |
Period | String | No | No | The billing cycle of the subscription cluster. | Valid values:
Note This property is required if you set PaymentType to Prepaid. |
EncryptionKey | String | No | No | The ID of the key that is provided by Key Management Service (KMS). | None. |
DBClusterNetworkType | String | Yes | No | The network type of the cluster. | Set the value to VPC. This value specifies that the cluster is created in a virtual private cloud (VPC). |
DBClusterType | String | Yes | Yes | The specification of the cluster. |
|
VpcId | String | No | No | The VPC ID of the cluster. | None. |
DBClusterVersion | String | Yes | No | The version of the cluster. | Valid values:
|
DBNodeCount | Integer | Yes | Yes | The number of nodes. | Valid values:
|
UsedTime | Integer | No | No | The usage duration of the cluster. | Valid values:
|
PaymentType | String | Yes | No | The billing method of the cluster. | Valid values:
|
Return values
Fn::GetAtt
DBClusterId: the cluster ID.
PublicPort: the public port.
Bid: the business process ID.
LockReason: the reason why the cluster is locked.
LockMode: the lock mode.
DBClusterVersion: the cluster version.
CommodityCode: the commodity code.
VpcId: the VPC ID.
Engine: the cluster engine.
Category: the cluster edition.
DBClusterType: the cluster specification.
DBClusterNetworkType: the network type.
EncryptionType: indicates whether disk encryption is enabled.
VpcCloudInstanceId: the ID of the cluster of the VPC network type.
Port: the port number that is used to connect to the cluster.
PaymentType: the billing method.
DBNodeStorage: the storage capacity of the node.
PublicConnectionString: the public endpoint.
EngineVersion: the engine version.
IsExpired: indicates whether the cluster is expired.
VSwitchId: the vSwitch ID.
Period: the billing cycle of the subscription cluster.
StorageType: the storage type.
DBNodeCount: the number of node groups.
AliUid: the ID of the Alibaba Cloud account.
DBClusterDescription: the description of the cluster.
ConnectionString: the endpoint of the cluster.
ZoneId: the zone ID.
EncryptionKey: the ID of the key that is provided by KMS.
DbNodeStorageType: the storage type of the node.
DBNodeClass: the node type.