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,
"DeletionProtection": Boolean,
"SSLEnabled": String
}
}プロパティ
プロパティ | タイプ | 必須 | 更新を許可 | 説明 | 制約 |
DBType | String | はい | いいえ | データベースエンジンのタイプ。 | 有効な値:
|
DBNodeClass | String | はい | いいえ | ノードの仕様。 | ノード仕様の詳細については、次のドキュメントをご参照ください。
説明 PolarDB for MySQL Cluster Edition クラスターのサーバーレスクラスターを作成するには、このパラメーターを polar.mysql.sl.small に設定します。 PolarDB for MySQL Standard Edition クラスターのサーバーレスクラスターを作成するには、このパラメーターを polar.mysql.sl.small.c に設定します。 PolarDB for PostgreSQL (Oracle 互換) または PolarDB for PostgreSQL クラスターのサーバーレスクラスターを作成するには、このパラメーターを polar.pg.sl.small.c に設定します。 |
DBVersion | String | はい | いいえ | データベースエンジンのバージョン。 | 有効な値:
|
PayType | String | はい | はい | 課金方法。 | 有効な値:
|
AutoRenewPeriod | Integer | いいえ | はい | インスタンスの自動更新期間。 | 有効な値:
単位: 月。 |
DBClusterDescription | String | いいえ | はい | クラスタの説明。 | 説明は 2～256 文字である必要があります。 文字または漢字で始まる必要があります。 |
ClusterNetworkType | String | いいえ | いいえ | クラスタのネットワークタイプ。 | VPC のみがサポートされています。 値を VPC に設定します。 |
RenewalStatus | String | いいえ | はい | 自動更新ステータス。 | 有効な値:
|
Period | Integer | いいえ | はい | PayType を Prepaid に設定した場合のインスタンスのサブスクリプション期間。 | 有効な値:
単位: 月。 |
ZoneId | String | いいえ | いいえ | ゾーンの ID。 | DescribeRegions 操作を呼び出して、利用可能なゾーンをクエリできます。 |
SourceResourceId | String | いいえ | いいえ | ソース RDS インスタンスまたは PolarDB クラスターの ID。 | ソース RDS インスタンスまたは PolarDB クラスターの ID。 このパラメーターは、CreationOption が MigrationFromRDS、CloneFromRDS、CloneFromPolarDB、または RecoverFromRecyclebin に設定されている場合にのみ必須です。
|
SecurityGroupIds | List | いいえ | はい | セキュリティグループの ID。 | 最大 3 つのセキュリティグループを指定できます。 |
Tags | List | いいえ | はい | タグ。 | 最大 20 個のタグを追加できます。 詳細については、タグのプロパティ を参照してください。 |
MaintainTime | String | いいえ | はい | クラスタのメンテナンスウィンドウ。 | 時刻は HH:mmZ-HH:mmZ 形式です。 たとえば、16:00Z-17:00Z は、00:00 から 01:00 (UTC+8) まで定期メンテナンスを実行できることを示します。 |
CreationOption | String | いいえ | いいえ | クラスターの作成に使用されるメソッド。 | 有効な値:
デフォルト値: Normal。 説明 DBType が MySQL に設定され、DBVersion が 8.0 に設定されている場合、このパラメーターを CreateGdnStandby に設定できます。 |
VSwitchId | String | いいえ | いいえ | vSwitch の ID。 | なし |
SecurityIPList | String | いいえ | いいえ | PolarDB クラスターの IP アドレスホワイトリスト。 | 説明 ホワイトリストに複数の IP アドレスを追加できます。 IP アドレスはカンマ (,) で区切ります。 |
CloneDataPoint | String | いいえ | いいえ | データのクローン元となる特定時点。 | 有効な値:
説明 CreationOption が CloneFromRDS に設定されている場合、このパラメーターを LATEST にのみ設定できます。 |
CreationCategory | String | いいえ | いいえ | クラスタのエディション。 | 有効な値:
説明 Basic エディションは、PolarDB for MySQL 5.6、5.7、8.0、PolarDB for PostgreSQL 14、および PolarDB for PostgreSQL (Oracle 互換) 2.0 でサポートされています。 MySQL 8.0 は ArchiveNormal と NormalMultimaster をサポートしています。 SENormal エディションは、PolarDB for MySQL 5.6、5.7、8.0、および PolarDB for PostgreSQL 14 でサポートされています。 |
BackupRetentionPolicyOnClusterDeletion | String | いいえ | いいえ | クラスターを削除するときのバックアップセットのデータ保持ポリシー。 | 有効な値:
クラスターを作成するときのデフォルト値は NONE です。 これは、クラスターが削除されてもバックアップセットが保持されないことを意味します。 説明
|
ResourceGroupId | String | いいえ | はい | リソースグループの ID。 | なし |
DefaultTimeZone | String | いいえ | いいえ | クラスターのタイムゾーン。 時刻は UTC である必要があります。 | デフォルト値は SYSTEM で、タイムゾーンがリージョンのタイムゾーンと同じであることを示します。 このパラメーターは、-12:00 から +13:00 までの 1 時間単位の値 (00:00 など) に設定できます。 説明 このパラメーターは、DBType が MySQL に設定されている場合にのみ有効です。 |
GDNId | String | いいえ | いいえ | グローバル データベース ネットワーク (GDN) の ID。 | このパラメーターは、CreationOption が CreateGdnStandby に設定されている場合に必須です。 |
LowerCaseTableNames | Integer | いいえ | いいえ | テーブル名で大文字と小文字を区別するかどうかを指定します。 | 有効な値:
説明 このパラメーターは、DBType が MySQL に設定されている場合にのみ有効です。 |
DBClusterParameters | Map | いいえ | はい | PolarDB クラスターのパラメーター。 | 詳細については、DBClusterParameters プロパティ を参照してください。 |
DeletionProtection | Boolean | いいえ | はい | 削除保護を有効にするかどうかを指定します。 | 有効な値:
|
TDEStatus | Boolean | いいえ | はい | 透過的データ暗号化 (TDE) を有効にするかどうかを指定します。 | 有効な値:
説明 このパラメーターは、DBType が PostgreSQL または Oracle に設定されている場合にのみ有効です。 |
PeriodUnit | String | いいえ | はい | サブスクリプション期間の単位。 | 有効な値:
|
ScaleRoNumMin | Integer | いいえ | いいえ | スケーリングの読み取り専用ノードの最小数。 | 有効な値: 0 ～ 15。 説明 このパラメーターは、サーバーレスクラスターでのみサポートされます。 |
ScaleMax | Integer | いいえ | いいえ | 単一ノードのスケールアウトおよびスケールインの最大制限。 | 有効な値: 1 PCU～32 PCU。 説明 このパラメーターは、サーバーレスクラスターでのみサポートされます。 |
AllowShutDown | Boolean | いいえ | いいえ | 無操作サスペンションを有効にするかどうかを指定します。 | 有効な値:
説明 このパラメーターは、サーバーレスクラスターでのみサポートされます。 |
ServerlessType | String | いいえ | いいえ | サーバーレスサービスのタイプ。 | 値を AgileServerless に設定します。 説明 このパラメーターは、サーバーレスクラスターでのみサポートされます。 |
ScaleRoNumMax | Integer | いいえ | いいえ | スケーリングの読み取り専用ノードの最大数。 | 有効な値: 0～15。 説明 このパラメーターは、サーバーレスクラスターでのみサポートされます。 |
ScaleMin | Integer | いいえ | いいえ | スケーリング用の単一ノードの PCU の最小数。 | 有効な値: 1 PCU～31 PCU。 説明 このパラメーターは、サーバーレスクラスターでのみサポートされます。 |
SSLEnabled | String | いいえ | はい | SSL ステータスを変更します。 | 有効な値:
|
StorageType | String | いいえ | いいえ | ストレージタイプ。 | Enterprise Edition クラスターの有効な値:
Standard Edition クラスターの有効な値:
|
LooseXEngine | String | いいえ | いいえ | X-Engine ストレージエンジンを有効にするかどうかを指定します。 | 有効な値:
説明 このパラメーターは、CreationOption が CreateGdnStandby に設定されておらず、DBType が MySQL に設定され、DBVersion が 8.0 に設定されている場合にのみ有効です。 X-Engine が有効になっているノードのメモリは 16 GB 以上である必要があります。 |
LoosePolarLogBin | String | いいえ | いいえ | バイナリログを有効にするかどうかを指定します。 | 有効な値:
説明 このパラメーターは、DBType が MySQL に設定されている場合にのみ有効です。 |
StorageSpace | Integer | いいえ | いいえ | サブスクリプションクラスターのストレージ容量。 | 単位: GB。 説明
|
ProxyType | String | いいえ | いいえ | データベースプロキシのエディション。 | 有効な値:
説明 プロキシのエディションは、クラスターノードのエディションと同じである必要があります。 ノードが汎用仕様の場合、プロキシエディションを Standard Enterprise Edition に設定します。 ノードが専用仕様の場合、プロキシエディションを Dedicated Enterprise Edition に設定します。 |
StandbyAZ | String | いいえ | いいえ | ストレージ ホットスタンバイクラスターのゾーン。 | このパラメーターは、3 ゾーンの Standard Edition クラスターに適用できます。 説明 このパラメーターは、マルチゾーンクラスターで強力な整合性が有効になっている場合にのみ有効です。 |
LooseXEngineUseMemoryPct | Integer | いいえ | いいえ | X-Engine ストレージエンジンの比率を設定します。 | 10 から 90 までの整数。 説明 このパラメーターは、LooseXEngine が ON に設定されている場合にのみ有効です。 |
StorageUpperBound | Integer | いいえ | いいえ | Standard Edition クラスターの自動ストレージ拡張の上限。 | 単位: GB。 説明 最大値は 32000 です。 |
StrictConsistency | String | いいえ | いいえ | マルチゾーンクラスターで強力な整合性を有効にするかどうかを指定します。 | 有効な値:
|
StoragePayType | String | いいえ | いいえ | ストレージの課金方法。 | 有効な値:
|
DBNodeNum | Integer | いいえ | いいえ | Standard Edition および Enterprise Edition クラスターのノード数。 | 有効な値:
説明
|
ProxyClass | String | いいえ | いいえ | Standard Edition クラスターのデータベースプロキシの仕様。 | 有効な値:
|
HotStandbyCluster | String | いいえ | いいえ | ホットスタンバイクラスター機能を有効にするかどうかを指定します。 | 有効な値:
説明 Standard Edition クラスタのデフォルト値は [STANDBY] です。 |
StorageAutoScale | String | いいえ | いいえ | Standard Edition クラスターの自動ストレージ拡張を有効にするかどうかを指定します。 | 有効な値:
|
Architecture | String | いいえ | いいえ | CPU アーキテクチャ。 | 有効な値:
|
DBMinorVersion | String | いいえ | いいえ | データベースエンジンのマイナーバージョン。 | 有効な値:
説明 このパラメーターは、DBType が MySQL に設定され、DBVersion が 8.0 に設定されている場合にのみ有効です。 |
VpcId | String | いいえ | いいえ | 仮想プライベート クラウド (VPC) の ID。 | なし |
ParameterGroupId | String | いいえ | いいえ | パラメータ テンプレートの ID。 | DescribeParameterGroups 操作を呼び出して、パラメーターテンプレート ID を含む、ターゲットリージョン内のパラメーターテンプレートをクエリできます。 |
RestartMasterNode | Boolean | いいえ | いいえ | プライマリ ノードを再起動するかどうかを指定します。 | 有効な値:
|
ColdStorageOption | Map | いいえ | いいえ | コールドデータアーカイブのオプション。 | 詳細については、ColdStorageOption プロパティ を参照してください。 |
ProvisionedIops | Integer | いいえ | いいえ | ESSD AutoPL ディスクのプロビジョニングされた読み取り/書き込み IOPS。 | 有効な値: 0 ～ min{50,000、1,000 × 容量 - ベースライン IOPS}。 ベースライン IOPS = min{1,800 + 50 × 容量, 50,000}。 説明 このパラメーターは、StorageType が ESSDAUTOPL に設定されている場合にのみサポートされます。 |
タグの構文
"Tags": [
{
"Key": String,
"Value": String
}
] タグのプロパティ
プロパティ | タイプ | 必須 | 更新を許可 | 説明 | 制約 |
キー | 文字列 | はい | いいえ | タグのキー。 | キーは 1～128 文字である必要があります。 |
値 | 文字列 | いいえ | いいえ | タグの値。 | 値は 0～128 文字である必要があります。 |
DBClusterParameters 構文
"DBClusterParameters": {
"Parameters": String, // パラメータ
"EffectiveTime": String // 有効時間
}DBClusterParameters プロパティ
プロパティ | 型 | 必須 | 更新を許可 | 説明 | 制約 |
Parameters | String | いいえ | はい | パラメーターとその値で構成される JSON 文字列。 | パラメーター値は文字列タイプです。 |
EffectiveTime | String | いいえ | はい | パラメータが有効になる時間。 | 有効な値:
|
ColdStorageOption 構文
"ColdStorageOption": {
// 説明
"Description": String,
// 有効化
"Enable": Boolean
}ColdStorageOption プロパティ
プロパティ | タイプ | 必須 | 更新を許可 | 説明 | 制約 |
Description | String | いいえ | いいえ | 説明。 | 説明を指定すると、コールドデータアーカイブ機能が有効になります。 説明は最大 256 文字です。 |
Enable | Boolean | いいえ | いいえ | コールドデータアーカイブ機能を有効にするかどうかを指定します。 | 有効な値:
|
戻り値
Fn::GetAtt
DBClusterId: クラスターの ID。
OrderId: 注文の ID。
DBNodeIds: クラスターノードの ID。
PrimaryEndpointId: プライマリエンドポイントの ID。
CustomEndpointIds: カスタムエンドポイントの ID。
CustomConnectionStrings: カスタム接続文字列。
PrimaryConnectionString: プライマリ接続文字列。
ClusterConnectionString: クラスター接続文字列。
ClusterEndpointId: クラスターエンドポイントの ID。
PrimaryEndpointIds: プライマリエンドポイント ID のリスト。
PrimaryConnectionStrings: プライマリ接続文字列のリスト。
ColdStorageInstanceId: コールドストレージインスタンスの ID。
DBClusterDescription: クラスターの説明。
Arn: クラスターの Alibaba Cloud リソースネーム (ARN)。
例
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
VpcId:
AssociationProperty: ALIYUN::ECS::VPC::VPCId
Type: String
Description:
ja: VPC の ID。 vpc- で始まる ID は、Virtual Private Cloud コンソールで確認できます。
Label:
ja: VPC ID
VSwitchZoneId:
AssociationProperty: ALIYUN::ECS::Instance:ZoneId
Type: String
Description:
ja: VSwitch 可用性ゾーン
Label:
ja: VSwitch 可用性ゾーン
VSwitchId:
AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
AssociationPropertyMetadata:
VpcId: ${VpcId}
ZoneId: ${VSwitchZoneId}
Type: String
Description:
ja: vSwitch の ID。 ID は Virtual Private Cloud コンソールで確認できます。
Label:
ja: VSwitch ID
DBType:
Type: String
Description: |-
データベースタイプ。 有効な値:
MySQL
PostgreSQL
Oracle
Default: MySQL
DBVersion:
Type: String
Description: |-
データベースのバージョン。 有効な値:
MySQL: 5.6 または 8.0
PostgreSQL: 11
Oracle: 11
Default: '5.6'
DBNodeClass:
Type: String
Description: クラスターのノード仕様。 詳細については、「仕様と料金」をご参照ください。
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: PolarDB クラスターの ID。
Value:
Fn::GetAtt:
- DBCluster
- DBClusterId{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"VpcId": {
"AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
"Type": "String",
"Description": {
"ja": "VPC の ID。 vpc- で始まる ID は、Virtual Private Cloud コンソールで確認できます。"
},
"Label": {
"ja": "VPC ID"
}
},
"VSwitchZoneId": {
"AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
"Type": "String",
"Description": {
"ja": "VSwitch 可用性ゾーン"
},
"Label": {
"ja": "VSwitch 可用性ゾーン"
}
},
"VSwitchId": {
"AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
"AssociationPropertyMetadata": {
"VpcId": "${VpcId}",
"ZoneId": "${VSwitchZoneId}"
},
"Type": "String",
"Description": {
"ja": "vSwitch の ID。 ID は Virtual Private Cloud コンソールで確認できます。"
},
"Label": {
"ja": "VSwitch ID"
}
},
"DBType": {
"Type": "String",
"Description": "データベースタイプ。 有効な値:\nMySQL\nPostgreSQL\nOracle",
"Default": "MySQL"
},
"DBVersion": {
"Type": "String",
"Description": "データベースのバージョン。 有効な値:\nMySQL: 5.6 または 8.0\nPostgreSQL: 11\nOracle: 11",
"Default": "5.6"
},
"DBNodeClass": {
"Type": "String",
"Description": "クラスターのノード仕様。 詳細については、「仕様と料金」をご参照ください。",
"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": "PolarDB クラスターの ID。",
"Value": {
"Fn::GetAtt": [
"DBCluster",
"DBClusterId"
]
}
}
}
}PolarDB for PostgreSQL サーバーレスの例
ROSTemplateFormatVersion: '2015-09-01'
Resources:
VPC:
Type: ALIYUN::ECS::VPC
Properties:
VpcName: polardb-test
CidrBlock: 192.168.0.0/16
VSwitch:
Type: ALIYUN::ECS::VSwitch
Properties:
VSwitchName: polardb-test
VpcId:
Ref: VPC
CidrBlock: 192.168.1.0/24
ZoneId: cn-beijing-k
PolardbCluster:
Type: ALIYUN::POLARDB::DBCluster
Properties:
VpcId:
Ref: VPC
CreationCategory: Normal
StorageType: PSL5
DBType: PostgreSQL
ClusterNetworkType: VPC
DBVersion: '16'
PayType: Postpaid
ZoneId: cn-beijing-k
VSwitchId:
Ref: VSwitch
DBNodeClass: polar.pg.sl.small
SecurityIPList: 0.0.0.0/0
ServerlessType: AgileServerless
ScaleMin: 1
ScaleMax: 3
ScaleRoNumMin: 1
ScaleRoNumMax: 2
HotStandbyCluster: 'OFF'
{
"ROSTemplateFormatVersion": "2015-09-01",
"Resources": {
"VPC": {
"Type": "ALIYUN::ECS::VPC",
"Properties": {
"VpcName": "polardb-test",
"CidrBlock": "192.168.0.0/16"
}
},
"VSwitch": {
"Type": "ALIYUN::ECS::VSwitch",
"Properties": {
"VSwitchName": "polardb-test",
"VpcId": {
"Ref": "VPC"
},
"CidrBlock": "192.168.1.0/24",
"ZoneId": "cn-beijing-k"
}
},
"PolardbCluster": {
"Type": "ALIYUN::POLARDB::DBCluster",
"Properties": {
"VpcId": {
"Ref": "VPC"
},
"CreationCategory": "Normal",
"StorageType": "PSL5",
"DBType": "PostgreSQL",
"ClusterNetworkType": "VPC",
"DBVersion": "16",
"PayType": "Postpaid",
"ZoneId": "cn-beijing-k",
"VSwitchId": {
"Ref": "VSwitch"
},
"DBNodeClass": "polar.pg.sl.small",
"SecurityIPList": "0.0.0.0/0",
"ServerlessType": "AgileServerless",
"ScaleMin": 1,
"ScaleMax": 3,
"ScaleRoNumMin": 1,
"ScaleRoNumMax": 2,
"HotStandbyCluster": "OFF"
}
}
}
}PolarDB クラスターの作成、データベースアカウントの作成、データベースの作成、ノードの追加、データベースへの標準アカウントのアクセス権限の付与、IP アドレスホワイトリストの変更、およびパブリックエンドポイントの作成方法を示すその他の例については、「YAML の例」をご参照ください。