ALIYUN::POLARDB::DBCluster
ALIYUN::POLARDB::DBCluster類型用于創(chuàng)建PolarDB集群。
語法
{
"Type": "ALIYUN::POLARDB::DBCluster",
"Properties": {
"VpcId": String,
"DBClusterDescription": String,
"DBType": String,
"ClusterNetworkType": String,
"RenewalStatus": String,
"AutoRenewPeriod": Integer,
"Period": Integer,
"ZoneId": String,
"SecurityGroupIds": List,
"Tags": List,
"SourceResourceId": String,
"MaintainTime": String,
"DBVersion": String,
"CreationOption": String,
"DBNodeClass": String,
"VSwitchId": String,
"SecurityIPList": String,
"CloneDataPoint": String,
"PayType": String,
"CreationCategory": String,
"BackupRetentionPolicyOnClusterDeletion": String,
"ResourceGroupId": String,
"DefaultTimeZone": String,
"GDNId": String,
"LowerCaseTableNames": Integer,
"DBClusterParameters": Map,
"TDEStatus": Boolean,
"PeriodUnit": String,
"ScaleRoNumMin": Integer,
"ScaleMax": Integer,
"AllowShutDown": Boolean,
"ServerlessType": String,
"ScaleRoNumMax": Integer,
"ScaleMin": Integer,
"StorageType": String,
"LooseXEngine": String,
"LoosePolarLogBin": String,
"StorageSpace": Integer,
"ProxyType": String,
"StandbyAZ": String,
"LooseXEngineUseMemoryPct": Integer,
"StorageUpperBound": Integer,
"StrictConsistency": String,
"StoragePayType": String,
"DBNodeNum": Integer,
"ProxyClass": String,
"HotStandbyCluster": String,
"StorageAutoScale": String,
"Architecture": String,
"DBMinorVersion": String,
"ParameterGroupId": String,
"RestartMasterNode": Boolean,
"ColdStorageOption": Map,
"ProvisionedIops": Integer
}
}屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
VpcId | String | 否 | 否 | 專有網(wǎng)絡(luò)ID。 | 無 |
DBClusterDescription | String | 否 | 是 | 集群描述。 | 長(zhǎng)度為2~256個(gè)字符。以英文字母或漢字開頭，不能以 |
DBType | String | 是 | 否 | 數(shù)據(jù)庫(kù)引擎類型。 | 取值：
|
ClusterNetworkType | String | 否 | 否 | 集群網(wǎng)絡(luò)類型。 | 當(dāng)前僅支持專有網(wǎng)絡(luò)，取值：VPC。 |
RenewalStatus | String | 否 | 是 | 自動(dòng)續(xù)費(fèi)狀態(tài)。 | 取值：
|
AutoRenewPeriod | Integer | 否 | 是 | 實(shí)例自動(dòng)續(xù)費(fèi)時(shí)長(zhǎng)。 | 取值：
單位：月。 |
Period | Integer | 否 | 否 | 預(yù)付費(fèi)類型（即PayType為Prepaid時(shí)）實(shí)例的時(shí)長(zhǎng)。 | 取值：
單位：月。 |
ZoneId | String | 否 | 否 | 可用區(qū)ID。 | 您可以通過DescribeRegions接口查詢可選的可用區(qū)。 |
SourceResourceId | String | 否 | 否 | 源RDS實(shí)例ID或源PolarDB集群ID。 | 當(dāng)DBType取值為MySQL且DBVersion取值為5.6時(shí)，該參數(shù)有效。如果CreationOption值不等于Normal，該參數(shù)必填。 |
SecurityGroupIds | List | 否 | 是 | 安全組ID列表。 | 最多支持3個(gè)安全組。 |
Tags | List | 否 | 是 | 標(biāo)簽。 | 最多支持添加20個(gè)標(biāo)簽。 更多信息，請(qǐng)參見Tags屬性。 |
MaintainTime | String | 否 | 是 | 集群的可維護(hù)時(shí)間。 | 格式：HH:mmZ-HH:mmZ。例如：16:00Z-17:00Z，表示0點(diǎn)到1點(diǎn)（UTC+08:00）可進(jìn)行例行維護(hù)。 |
DBVersion | String | 是 | 否 | 數(shù)據(jù)庫(kù)版本號(hào)。 | 取值：
|
CreationOption | String | 否 | 否 | 創(chuàng)建方式。 | 取值：
當(dāng)DBType取值為MySQL且DBVersion取值為5.6時(shí)，該參數(shù)取值為CloneFromRDS或MigrationFromRDS。 |
DBNodeClass | String | 是 | 否 | 節(jié)點(diǎn)規(guī)格。 | 更多信息，請(qǐng)參見計(jì)費(fèi)項(xiàng)概覽。 |
VSwitchId | String | 否 | 否 | 交換機(jī)ID。 | 無 |
SecurityIPList | String | 否 | 否 | PolarDB集群白名單。 | 無 |
CloneDataPoint | String | 否 | 否 | 克隆數(shù)據(jù)的時(shí)間節(jié)點(diǎn)。 | 取值：
當(dāng)DBType取值為MySQL且DBVersion取值為5.6，并且CreationOption取值為CloneFromRDS或CloneFromPolarDB時(shí)，該參數(shù)有效。 |
PayType | String | 是 | 否 | 付費(fèi)類型。 | 取值：
|
CreationCategory | String | 否 | 否 | 集群系列。 | 取值：Normal（標(biāo)準(zhǔn)版）。 |
BackupRetentionPolicyOnClusterDeletion | String | 否 | 否 | 刪除集群時(shí)備份集保留策略。 | 取值：
說明 僅當(dāng)DBType取值為MySQL時(shí)，該參數(shù)生效。 |
ResourceGroupId | String | 否 | 是 | 資源組ID。 | 無 |
DefaultTimeZone | String | 否 | 否 | 集群時(shí)區(qū)（UTC）。 | 默認(rèn)取值為SYSTEM，默認(rèn)時(shí)區(qū)與Region所在時(shí)區(qū)一致。 可選取值范圍為-12:00~+13:00內(nèi)的所有整數(shù)時(shí)間點(diǎn)，如 00:00。 說明 僅當(dāng)DBType取值為MySQL時(shí)，該參數(shù)生效。 |
GDNId | String | 否 | 否 | 全球數(shù)據(jù)庫(kù)網(wǎng)絡(luò)ID。 | 當(dāng)CreationOption取值為CreateGdnStandby時(shí)，該參數(shù)必填。 |
LowerCaseTableNames | Integer | 否 | 否 | 表名是否區(qū)分大小寫。 | 取值：
說明 僅當(dāng)DBType為MySQL時(shí)，該參數(shù)生效。 |
DBClusterParameters | Map | 否 | 是 | PolarDB集群的參數(shù)。 | 更多信息，請(qǐng)參見DBClusterParameters屬性。 |
TDEStatus | Boolean | 否 | 是 | 是否開啟透明數(shù)據(jù)加密（TDE）。 | 取值：
說明 當(dāng)DBType取值為PostgreSQL或DBType取值為Oracle時(shí)，該參數(shù)生效。 |
PeriodUnit | String | 否 | 否 | 時(shí)長(zhǎng)單位。 | 取值：
|
ScaleRoNumMin | Integer | 否 | 否 | 只讀節(jié)點(diǎn)數(shù)的最小擴(kuò)容和縮容限制。 | 無 |
ScaleMax | Integer | 否 | 否 | 單節(jié)點(diǎn)擴(kuò)容和縮容的最大限制。 | 無 |
AllowShutDown | Boolean | 否 | 否 | 是否開啟無活動(dòng)暫停。 | 取值：
|
ServerlessType | String | 否 | 否 | Serverless服務(wù)類型。 | 取值：AgileServerless。 |
ScaleRoNumMax | Integer | 否 | 否 | 只讀節(jié)點(diǎn)數(shù)的最大擴(kuò)容和縮容限制。 | 無 |
ScaleMin | Integer | 否 | 否 | 單節(jié)點(diǎn)擴(kuò)容和縮容的最小限制。 | 無 |
StorageType | String | 否 | 否 | 存儲(chǔ)類型。 | 企業(yè)版存儲(chǔ)類型取值如下：
標(biāo)準(zhǔn)版存儲(chǔ)類型取值如下：
說明 Serverless集群不支持該參數(shù)。 |
LooseXEngine | String | 否 | 否 | 開啟X-Engine存儲(chǔ)引擎功能。 | 取值：
說明 當(dāng)參數(shù)CreationOption不等于CreateGdnStandby，DBType為MySQL且DBVersion為8.0時(shí)，該參數(shù)才生效。開啟X-Engine引擎的節(jié)點(diǎn)內(nèi)存規(guī)格必須大于等于16 GB。 |
LoosePolarLogBin | String | 否 | 否 | 開啟Binlog功能。 | 取值：
說明 當(dāng)參數(shù)DBType為MySQL時(shí)，該參數(shù)才生效。 |
StorageSpace | Integer | 否 | 否 | 按空間計(jì)費(fèi)（包年包月）的存儲(chǔ)空間。 | 單位：GB。 說明 PolarDB MySQL標(biāo)準(zhǔn)版存儲(chǔ)空間的取值范圍：20~32000。 |
ProxyType | String | 否 | 否 | 數(shù)據(jù)庫(kù)代理類型。 | 取值：
|
StandbyAZ | String | 否 | 否 | 存儲(chǔ)熱備集群的可用區(qū)。 | 適用于標(biāo)準(zhǔn)版3AZ場(chǎng)景。 說明 開啟了多可用區(qū)數(shù)據(jù)強(qiáng)一致，該參數(shù)才生效。 |
LooseXEngineUseMemoryPct | Integer | 否 | 否 | 設(shè)置開啟X-Engine存儲(chǔ)引擎比例。 | 取值范圍10~90的整數(shù)。 說明 當(dāng)參數(shù)LooseXEngine為ON時(shí)，該參數(shù)才生效。 |
StorageUpperBound | Integer | 否 | 否 | 設(shè)置標(biāo)準(zhǔn)版集群存儲(chǔ)自動(dòng)擴(kuò)容上限。 | 單位：GB。 說明 取值最大為32000。 |
StrictConsistency | String | 否 | 否 | 集群是否開啟了多可用區(qū)數(shù)據(jù)強(qiáng)一致。 | 取值：
|
StoragePayType | String | 否 | 否 | 存儲(chǔ)計(jì)費(fèi)類型。 | 取值：
|
DBNodeNum | Integer | 否 | 否 | 標(biāo)準(zhǔn)版節(jié)點(diǎn)個(gè)數(shù)。 | 取值：
說明 企業(yè)版默認(rèn)有2個(gè)節(jié)點(diǎn)，標(biāo)準(zhǔn)版默認(rèn)有1個(gè)節(jié)點(diǎn)。 僅PolarDB MySQL版支持該參數(shù)。 |
ProxyClass | String | 否 | 否 | 標(biāo)準(zhǔn)版數(shù)據(jù)庫(kù)代理規(guī)格。 | 取值：
|
HotStandbyCluster | String | 否 | 否 | 是否開啟熱備集群。 | 取值：
說明 標(biāo)準(zhǔn)版集群的默認(rèn)值為STANDBY。 |
StorageAutoScale | String | 否 | 否 | 標(biāo)準(zhǔn)版集群是否開啟存儲(chǔ)自動(dòng)擴(kuò)容。 | 取值：
|
Architecture | String | 否 | 否 | CPU 架構(gòu)。 | 取值：
|
DBMinorVersion | String | 否 | 否 | 數(shù)據(jù)庫(kù)引擎小版本號(hào)。 | 取值：
|
ParameterGroupId | String | 否 | 否 | 參數(shù)模板ID。 | 您可以通過DescribeParameterGroups接口查看目標(biāo)地域的參數(shù)模板列表，包括參數(shù)模板ID。 |
RestartMasterNode | Boolean | 否 | 否 | 是否重啟主節(jié)點(diǎn)。 | 取值：
|
ColdStorageOption | Map | 否 | 否 | 冷數(shù)據(jù)歸檔選項(xiàng)。 | 更多信息，請(qǐng)參見ColdStorageOption屬性。 |
ProvisionedIops | Integer | 否 | 否 | ESSD AutoPL 云盤預(yù)配置的讀寫 IOPS。 | 可能值：0~min{50,000, 1000*容量-基準(zhǔn)性能}。 基準(zhǔn)性能=min{1,800+50*容量, 50000}。 說明 當(dāng) StorageType 為 ESSDAUTOPL 時(shí)才支持該參數(shù)。 |
Tags語法
"Tags": [
{
"Key": String,
"Value": String
}
] Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標(biāo)簽鍵。 | 長(zhǎng)度為1~128個(gè)字符，不能以 |
Value | String | 否 | 否 | 標(biāo)簽值。 | 長(zhǎng)度為0~128個(gè)字符，不能以 |
DBClusterParameters語法
"DBClusterParameters": {
"Parameters": String,
"EffectiveTime": String
}DBClusterParameters屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Parameters | String | 否 | 是 | 參數(shù)及其值的JSON字符串。 | 參數(shù)的值都是字符串類型。 |
EffectiveTime | String | 否 | 是 | 參數(shù)的生效時(shí)間。 | 取值：
|
ColdStorageOption語法
"ColdStorageOption": {
"Description": String,
"Enable": Boolean
}ColdStorageOption屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Description | String | 否 | 否 | 描述信息。 | 如果設(shè)置了描述信息，則表示開啟了冷數(shù)據(jù)歸檔功能。 長(zhǎng)度不超過256個(gè)字符。 |
Enable | Boolean | 否 | 否 | 開啟冷數(shù)據(jù)歸檔功能。 | 取值：
|
返回值
Fn::GetAtt
DBClusterId：集群ID。
OrderId：訂單ID。
DBNodeIds：集群節(jié)點(diǎn)ID。
PrimaryEndpointId：主地址ID。
CustomEndpointIds：自定義集群地址ID。
CustomConnectionStrings：自定義連接串。
PrimaryConnectionString：主連接串。
ClusterConnectionString：自定義連接串。
ClusterEndpointId：集群地址ID。
PrimaryEndpointIds：集群主地址ID列表。
PrimaryConnectionStrings：集群主地址連接串列表。
ColdStorageInstanceId：冷數(shù)據(jù)庫(kù)實(shí)例ID。
DBClusterDescription：集群描述。
示例
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
VpcId:
AssociationProperty: ALIYUN::ECS::VPC::VPCId
Type: String
Description:
en: Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud
zh-cn: 現(xiàn)有虛擬專有網(wǎng)絡(luò)的實(shí)例ID
Label:
en: VPC ID
zh-cn: 專有網(wǎng)絡(luò)VPC實(shí)例ID
VSwitchZoneId:
AssociationProperty: ALIYUN::ECS::Instance:ZoneId
Type: String
Description:
zh-cn: 交換機(jī)可用區(qū)
en: VSwitch Availability Zone
Label:
zh-cn: 交換機(jī)可用區(qū)
en: VSwitch Availability Zone
VSwitchId:
AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
AssociationPropertyMetadata:
VpcId: ${VpcId}
ZoneId: ${VSwitchZoneId}
Type: String
Description:
en: Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query
zh-cn: 現(xiàn)有業(yè)務(wù)網(wǎng)絡(luò)交換機(jī)的實(shí)例ID
Label:
en: VSwitch ID
zh-cn: 交換機(jī)實(shí)例ID
DBType:
Type: String
Description: |-
Database type, value:
MySQL
PostgreSQL
Oracle
Default: MySQL
DBVersion:
Type: String
Description: |-
The version of the database. Valid values:
MySQL: 5.6 or 8.0
PostgreSQL: 11
Oracle: 11
Default: '5.6'
DBNodeClass:
Type: String
Description: The node specifications of the cluster. For more information, see Specifications and pricing.
Default: polar.mysql.x4.medium
Resources:
DBCluster:
Type: ALIYUN::POLARDB::DBCluster
Properties:
VpcId:
Ref: VpcId
DBType:
Ref: DBType
ClusterNetworkType: VPC
ZoneId:
Ref: VSwitchZoneId
VSwitchId:
Ref: VSwitchId
DBVersion:
Ref: DBVersion
DBNodeClass:
Ref: DBNodeClass
PayType: Postpaid
Outputs:
DBClusterId:
Description: The ID of the ApsaraDB for POLARDB cluster.
Value:
Fn::GetAtt:
- DBCluster
- DBClusterId{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"VpcId": {
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
"Type": "String",
"Description": {
"en": "Please search the ID starting with (vpc-xxx) from console-Virtual Private Cloud",
"zh-cn": "現(xiàn)有虛擬專有網(wǎng)絡(luò)的實(shí)例ID"
},
"Label": {
"en": "VPC ID",
"zh-cn": "專有網(wǎng)絡(luò)VPC實(shí)例ID"
}
},
"VSwitchZoneId": {
"AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
"Type": "String",
"Description": {
"zh-cn": "交換機(jī)可用區(qū)",
"en": "VSwitch Availability Zone"
},
"Label": {
"zh-cn": "交換機(jī)可用區(qū)",
"en": "VSwitch Availability Zone"
}
},
"VSwitchId": {
"AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
"AssociationPropertyMetadata": {
"VpcId": "${VpcId}",
"ZoneId": "${VSwitchZoneId}"
},
"Type": "String",
"Description": {
"en": "Instance ID of existing business network switches, console-Virtual Private Cloud-VSwitches under query",
"zh-cn": "現(xiàn)有業(yè)務(wù)網(wǎng)絡(luò)交換機(jī)的實(shí)例ID"
},
"Label": {
"en": "VSwitch ID",
"zh-cn": "交換機(jī)實(shí)例ID"
}
},
"DBType": {
"Type": "String",
"Description": "Database type, value:\nMySQL\nPostgreSQL\nOracle",
"Default": "MySQL"
},
"DBVersion": {
"Type": "String",
"Description": "The version of the database. Valid values:\nMySQL: 5.6 or 8.0\nPostgreSQL: 11\nOracle: 11",
"Default": "5.6"
},
"DBNodeClass": {
"Type": "String",
"Description": "The node specifications of the cluster. For more information, see Specifications and pricing.",
"Default": "polar.mysql.x4.medium"
}
},
"Resources": {
"DBCluster": {
"Type": "ALIYUN::POLARDB::DBCluster",
"Properties": {
"VpcId": {
"Ref": "VpcId"
},
"DBType": {
"Ref": "DBType"
},
"ClusterNetworkType": "VPC",
"ZoneId": {
"Ref": "VSwitchZoneId"
},
"VSwitchId": {
"Ref": "VSwitchId"
},
"DBVersion": {
"Ref": "DBVersion"
},
"DBNodeClass": {
"Ref": "DBNodeClass"
},
"PayType": "Postpaid"
}
}
},
"Outputs": {
"DBClusterId": {
"Description": "The ID of the ApsaraDB for POLARDB cluster.",
"Value": {
"Fn::GetAtt": [
"DBCluster",
"DBClusterId"
]
}
}
}
}更多示例，請(qǐng)參見創(chuàng)建PolarDB集群、為PolarDB數(shù)據(jù)庫(kù)創(chuàng)建賬號(hào)、在PolarDB集群下創(chuàng)建一個(gè)新的數(shù)據(jù)庫(kù)、增加PolarDB集群節(jié)點(diǎn)、授權(quán)普通賬號(hào)訪問PolarDB集群的某個(gè)數(shù)據(jù)庫(kù)、修改允許訪問數(shù)據(jù)庫(kù)集群的IP名單和創(chuàng)建PolarDB集群的公網(wǎng)地址的組合示例：YAML示例。