調用ALIYUN::POLARDB::DBCluster建立PolarDB叢集 -

ALIYUN::POLARDB::DBCluster類型用於建立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	否	否	專用網路ID。	無
DBClusterDescription	String	否	是	叢集描述。	長度為2~256個字元。以英文字母或漢字開頭，不能以`http://`或`https://`開頭。可包含英文字母、漢字、數字、半形逗號（,）和短劃線（-）。
DBType	String	是	否	資料庫引擎類型。	取值： MySQL PostgreSQL Oracle
ClusterNetworkType	String	否	否	叢集網路類型。	當前僅支援專用網路，取值：VPC。
RenewalStatus	String	否	是	自動續約狀態。	取值： AutoRenewal：自動續約。 Normal（預設值）：手動續約。 NotRenewal：不再續約。說明設定為NotRenewal後，系統不再發送到期提醒，只在到期前第三天發送不續約提醒。
AutoRenewPeriod	Integer	否	是	執行個體自動續約時間長度。	取值： 1（預設值） 2 3 6 12 24 36 單位：月。
Period	Integer	否	否	預付費類型（即PayType為Prepaid時）執行個體的時間長度。	取值： 1 2 3 4 5 6 7 8 9 12 24 36 單位：月。
ZoneId	String	否	否	可用性區域ID。	您可以通過DescribeRegions介面查詢可選的可用性區域。
SourceResourceId	String	否	否	源RDS執行個體ID或源PolarDB叢集ID。	當DBType取值為MySQL且DBVersion取值為5.6時，該參數有效。如果CreationOption值不等於Normal，該參數必填。
SecurityGroupIds	List	否	是	安全性群組ID列表。	最多支援3個安全性群組。
Tags	List	否	是	標籤。	最多支援添加20個標籤。更多資訊，請參見Tags屬性。
MaintainTime	String	否	是	叢集的可維護時間。	格式：HH:mmZ-HH:mmZ。例如：16:00Z-17:00Z，表示0點到1點（UTC+08:00）可進行例行維護。
DBVersion	String	是	否	資料庫版本號碼。	取值：當DBType取值為MySQL時：5.6、8.0。當DBType取值為PostgreSQL時：11。當DBType取值為Oracle時：11。
CreationOption	String	否	否	建立方式。	取值： Normal（預設值）：建立一個全新的PolarDB叢集。 CloneFromPolarDB：從現有PolarDB叢集複製資料到新的PolarDB叢集。 CloneFromRDS：從現有RDS執行個體複製資料到新的PolarDB叢集。 MigrationFromRDS：從現有RDS執行個體遷移資料到新的PolarDB叢集。當DBType取值為MySQL且DBVersion取值為5.6時，該參數取值為CloneFromRDS或MigrationFromRDS。
DBNodeClass	String	是	否	節點規格。	更多資訊，請參見計費項目概覽。
VSwitchId	String	否	否	交換器ID。	無
SecurityIPList	String	否	否	PolarDB叢集白名單。	無
CloneDataPoint	String	否	否	複製資料的時間節點。	取值： LATEST（預設值）：最新時間點的資料。說明當CreationOption取值為CloneFromRDS時，該參數取值為LATEST。 BackupID：歷史備份組ID。 Timestamp：記錄點，格式：`yyyy-MM-ddTHH:mm:ssZ`（UTC時間）。當DBType取值為MySQL且DBVersion取值為5.6，並且CreationOption取值為CloneFromRDS或CloneFromPolarDB時，該參數有效。
PayType	String	是	否	付費類型。	取值： Postpaid：隨用隨付。 Prepaid：預付費（訂用帳戶）。
CreationCategory	String	否	否	叢集系列。	取值：Normal（標準版）。
BackupRetentionPolicyOnClusterDeletion	String	否	否	刪除叢集時備份組保留原則。	取值： ALL：持續保留全部備份。 LATEST：持續保留最後一個備份（刪除前自動備份）。 NONE（預設值）：叢集刪除時不保留備份組。說明僅當DBType取值為MySQL時，該參數生效。
ResourceGroupId	String	否	是	資源群組ID。	無
DefaultTimeZone	String	否	否	叢集時區（UTC）。	預設取值為SYSTEM，預設時區與Region所在時區一致。可選取值範圍為-12:00~+13:00內的所有整數時間點，如 00:00。說明僅當DBType取值為MySQL時，該參數生效。
GDNId	String	否	否	全球資料庫網路ID。	當CreationOption取值為CreateGdnStandby時，該參數必填。
LowerCaseTableNames	Integer	否	否	表名是否區分大小寫。	取值： 1（預設值）：不區分大小寫。 0：區分大小寫。說明僅當DBType為MySQL時，該參數生效。
DBClusterParameters	Map	否	是	PolarDB叢集的參數。	更多資訊，請參見DBClusterParameters屬性。
TDEStatus	Boolean	否	是	是否開啟透明資料加密（TDE）。	取值： true：開啟。說明 TDE功能開啟後不可關閉。 false（預設值）：關閉。說明當DBType取值為PostgreSQL或DBType取值為Oracle時，該參數生效。
PeriodUnit	String	否	否	時間長度單位。	取值： Year：年。 Month：月。
ScaleRoNumMin	Integer	否	否	唯讀節點數的最小擴容和縮容限制。	無
ScaleMax	Integer	否	否	單節點擴容和縮容的最大限制。	無
AllowShutDown	Boolean	否	否	是否開啟無活動暫停。	取值： true：開啟無活動暫停。 false：關閉無活動暫停。
ServerlessType	String	否	否	Serverless服務類型。	取值：AgileServerless。
ScaleRoNumMax	Integer	否	否	唯讀節點數的最大擴容和縮容限制。	無
ScaleMin	Integer	否	否	單節點擴容和縮容的最小限制。	無
StorageType	String	否	否	儲存類型。	企業版儲存類型取值如下： PSL5 PSL4 標準版儲存類型取值如下： ESSDPL1 ESSDPL2 ESSDPL3 說明 Serverless叢集不支援該參數。
LooseXEngine	String	否	否	開啟X-Engine儲存引擎功能。	取值： ON：叢集開啟X-Engine引擎 OFF：叢集關閉X-Engine引擎說明當參數CreationOption不等於CreateGdnStandby，DBType為MySQL且DBVersion為8.0時，該參數才生效。開啟X-Engine引擎的節點記憶體規格必須大於等於16 GB。
LoosePolarLogBin	String	否	否	開啟Binlog功能。	取值： ON：叢集開啟Binlog功能 OFF：叢集關閉Binlog功能說明當參數DBType為MySQL時，該參數才生效。
StorageSpace	Integer	否	否	按空間計費（訂用帳戶）的儲存空間。	單位：GB。說明 PolarDB MySQL標準版儲存空間的取值範圍：20~32000。
ProxyType	String	否	否	資料庫代理類型。	取值： OFF（預設）：關閉資料庫代理。 EXCLUSIVE：企業獨享版 GENERAL：企業通用版
StandbyAZ	String	否	否	儲存熱備叢集的可用性區域。	適用於標準版3AZ情境。說明開啟了多可用性區域資料強一致，該參數才生效。
LooseXEngineUseMemoryPct	Integer	否	否	設定開啟X-Engine儲存引擎比例。	取值範圍10~90的整數。說明當參數LooseXEngine為ON時，該參數才生效。
StorageUpperBound	Integer	否	否	設定標準版叢集儲存自動擴容上限。	單位：GB。說明取值最大為32000。
StrictConsistency	String	否	否	叢集是否開啟了多可用性區域資料強一致。	取值： ON：表示開啟了多可用性區域資料強一致，適用於標準版3AZ情境。 OFF：表示未開啟多可用性區域資料強一致。
StoragePayType	String	否	否	儲存計費類型。	取值： Postpaid：按容量計費（隨用隨付）。 Prepaid：按空間計費（訂用帳戶）。
DBNodeNum	Integer	否	否	標準版節點個數。	取值： 1（預設）：表示只有1個讀寫節點。 2：表示有1個唯讀節點和1個讀寫節點。說明企業版預設有2個節點，標準版預設有1個節點。僅PolarDB MySQL版支援該參數。
ProxyClass	String	否	否	標準版資料庫代理規格。	取值： polar.maxscale.g2.medium.c：2核。 polar.maxscale.g2.large.c：4核。 polar.maxscale.g2.xlarge.c：8核。 polar.maxscale.g2.2xlarge.c：16核。 polar.maxscale.g2.3xlarge.c：24核。 polar.maxscale.g2.4xlarge.c：32核。 polar.maxscale.g2.8xlarge.c：64核。
HotStandbyCluster	String	否	否	是否開啟熱備叢集。	取值： ON（預設）：開啟熱備叢集。 OFF：關閉熱備叢集。 STANDBY：標準版開啟熱備叢集。說明標準版叢集的預設值為STANDBY。
StorageAutoScale	String	否	否	標準版叢集是否開啟儲存自動擴容。	取值： Enable：開啟儲存自動擴容。 Disable：關閉儲存自動擴容。
Architecture	String	否	否	CPU 架構。	取值： X86 ARM
DBMinorVersion	String	否	否	資料庫引擎小版本號碼。	取值： 8.0.2 8.0.1
ParameterGroupId	String	否	否	參數模板ID。	您可以通過DescribeParameterGroups介面查看目標地區的參數模板列表，包括參數模板ID。
RestartMasterNode	Boolean	否	否	是否重啟主節點。	取值： true：重啟主節點。 false：不重啟主節點。
ColdStorageOption	Map	否	否	冷資料歸檔選項。	更多資訊，請參見ColdStorageOption屬性。
ProvisionedIops	Integer	否	否	ESSD AutoPL 雲端硬碟預配置的讀寫 IOPS。	可能值：0~min{50,000, 1000容量-基準效能}。基準效能=min{1,800+50容量, 50000}。說明當 StorageType 為 ESSDAUTOPL 時才支援該參數。

Tags文法

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

Tags屬性

屬性名稱	類型	必須	允許更新	描述	約束
Key	String	是	否	標籤鍵。	長度為1~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://` 。
Value	String	否	否	標籤值。	長度為0~128個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://` 。

DBClusterParameters文法

"DBClusterParameters": {
  "Parameters": String,
  "EffectiveTime": String
}

DBClusterParameters屬性

屬性名稱

類型

必須

允許更新

描述

約束

Parameters

String

否

是

參數及其值的JSON字串。

參數的值都是字串類型。

EffectiveTime

String

否

是

參數的生效時間。

取值：

Auto：自動確定何時生效。
Immediately：立即生效。
MaintainTime：叢集維護期間生效。

ColdStorageOption文法

"ColdStorageOption": {
  "Description": String,
  "Enable": Boolean
}

ColdStorageOption屬性

屬性名稱

類型

必須

允許更新

描述

約束

Description

String

否

描述資訊。

如果設定了描述資訊，則表示開啟了冷資料歸檔功能。長度不超過256個字元。

Enable

Boolean

否

開啟冷資料歸檔功能。

取值：

true
false

傳回值

Fn::GetAtt

DBClusterId：叢集ID。
OrderId：訂單ID。
DBNodeIds：叢集節點ID。
PrimaryEndpointId：主地址ID。
CustomEndpointIds：自訂叢集地址ID。
CustomConnectionStrings：自訂串連串。
PrimaryConnectionString：主串連串。
ClusterConnectionString：自訂串連串。
ClusterEndpointId：叢集地址ID。
PrimaryEndpointIds：叢集主地址ID列表。
PrimaryConnectionStrings：叢集主地址串連串列表。
ColdStorageInstanceId：冷資料庫執行個體ID。
DBClusterDescription：叢集描述。

樣本

YAML

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: 現有Virtual Private Cloud絡的執行個體ID
    Label:
      en: VPC ID
      zh-cn: Virtual Private Cloud執行個體ID
  VSwitchZoneId:
    AssociationProperty: ALIYUN::ECS::Instance:ZoneId
    Type: String
    Description:
      zh-cn: 交換器可用性區域
      en: VSwitch Availability Zone
    Label:
      zh-cn: 交換器可用性區域
      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: 現有業務網路交換器的執行個體ID
    Label:
      en: VSwitch ID
      zh-cn: 交換器執行個體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

JSON

{
  "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": "現有Virtual Private Cloud絡的執行個體ID"
      },
      "Label": {
        "en": "VPC ID",
        "zh-cn": "Virtual Private Cloud執行個體ID"
      }
    },
    "VSwitchZoneId": {
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
      "Type": "String",
      "Description": {
        "zh-cn": "交換器可用性區域",
        "en": "VSwitch Availability Zone"
      },
      "Label": {
        "zh-cn": "交換器可用性區域",
        "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": "現有業務網路交換器的執行個體ID"
      },
      "Label": {
        "en": "VSwitch ID",
        "zh-cn": "交換器執行個體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"
        ]
      }
    }
  }
}

更多樣本，請參見建立PolarDB叢集、為PolarDB資料庫建立帳號、在PolarDB叢集下建立一個新的資料庫、增加PolarDB叢集節點、授權普通帳號訪問PolarDB叢集的某個資料庫、修改允許訪問資料庫叢集的IP名單和建立PolarDB叢集的公網地址的組合樣本：YAML樣本。