ALIYUN::ClickHouse::DBCluster類型用於建立ClickHouse叢集。
文法
{
"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
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Category | String | 是 | 否 | 叢集系列。 | 取值:
|
DBClusterNetworkType | String | 是 | 否 | 網路類型。 | 取值:VPC,表示專用網路。 |
DBClusterType | String | 是 | 是 | 叢集類型。 | 叢集規格。
|
DBClusterVersion | String | 是 | 否 | 執行個體版本。 | 取值:
|
DBNodeCount | Integer | 是 | 是 | 節點群組數量。 | 取值範圍:
單位:個。 |
DBNodeStorage | Integer | 是 | 是 | 節點儲存空間。 | 取值範圍:100~10000。 單位:GB。 每100 GB遞增。 |
DbNodeStorageType | String | 是 | 否 | 節點儲存空間類型。 | 取值:
|
PaymentType | String | 是 | 否 | 付費類型。 | 取值:
|
DBClusterDescription | String | 否 | 是 | 叢集備忘資訊。 | 無 |
EncryptionKey | String | 否 | 否 | Key Management Service的密鑰ID。 | 無 |
EncryptionType | String | 否 | 否 | 加密類型。 | 取值:CloudDisk,表示雲端硬碟加密 。 |
Period | String | 否 | 否 | 預付費叢集的付費周期。 | 取值:
說明 當PaymentType取值為Prepaid時,該參數必須指定。 |
UsedTime | Integer | 否 | 否 | 執行個體使用時間。 | 取值範圍:
|
VpcId | String | 否 | 否 | 專用網路ID。 | 無 |
VSwitchId | String | 否 | 否 | 交換器ID。 | 無 |
ZoneId | String | 否 | 否 | 可用性區域ID。 | 您可以調用DescribeRegions介面查詢可用的可用性區域。 |
傳回值
Fn::GetAtt
DBClusterId:執行個體ID。
PublicPort:公網連接埠。
Bid:商務程序的ID。
LockReason:鎖定原因。
LockMode:鎖定模式。
DBClusterVersion:執行個體版本。
CommodityCode:售賣商品代碼。
VpcId:專用網路ID。
Engine:引擎。
Category:叢集系列。
DBClusterType:叢集類型。
DBClusterNetworkType:網路類型。
EncryptionType:加密類型。
VpcCloudInstanceId:VPC雲執行個體ID。
Port:串連連接埠。
PaymentType:支付方式。
DBNodeStorage:節點儲存空間。
PublicConnectionString:公網串連地址。
EngineVersion:引擎版本。
IsExpired:執行個體是否已到期。
VSwitchId:交換器ID。
Period:預付費叢集的付費周期。
StorageType:儲存類型。
DBNodeCount:節點群組數量。
AliUid:阿里雲帳號。
DBClusterDescription:執行個體描述。
ConnectionString:連接字串。
ZoneId:可用性區域ID。
EncryptionKey:KMS密鑰ID。
DbNodeStorageType:節點儲存類型。
DBNodeClass:節點類型。
樣本
YAML
格式
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
VpcId:
Type: String
AssociationProperty: ALIYUN::ECS::VPC::VPCId
ZoneId:
Type: String
AssociationProperty: ZoneId
VSwitchId:
Type: String
AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
AssociationPropertyMetadata:
ZoneId: ${ZoneId}
VpcId: ${VpcId}
PaymentType:
Type: String
Description: PayType
Default: Month
Resources:
ClickHouseDBCluster:
Type: ALIYUN::ClickHouse::DBCluster
Properties:
DbNodeStorageType: cloud_essd
DBNodeStorage: 100
Category: Basic
ZoneId:
Ref: ZoneId
VSwitchId:
Ref: VSwitchId
Period: Month
DBClusterNetworkType: VPC
DBClusterType: S8
VpcId:
Ref: VpcId
DBClusterVersion: 21.8.10.19
DBNodeCount: 3
UsedTime: 1
PaymentType: Prepaid
JSON
格式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"VpcId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
},
"ZoneId": {
"Type": "String",
"AssociationProperty": "ZoneId"
},
"VSwitchId": {
"Type": "String",
"AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
"AssociationPropertyMetadata": {
"ZoneId": "${ZoneId}",
"VpcId": "${VpcId}"
}
},
"PaymentType": {
"Type": "String",
"Description": "PayType",
"Default": "Month"
}
},
"Resources": {
"ClickHouseDBCluster": {
"Type": "ALIYUN::ClickHouse::DBCluster",
"Properties": {
"DbNodeStorageType": "cloud_essd",
"DBNodeStorage": 100,
"Category": "Basic",
"ZoneId": {
"Ref": "ZoneId"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"Period": "Month",
"DBClusterNetworkType": "VPC",
"DBClusterType": "S8",
"VpcId": {
"Ref": "VpcId"
},
"DBClusterVersion": "21.8.10.19",
"DBNodeCount": 3,
"UsedTime": 1,
"PaymentType": "Prepaid"
}
}
}
}