DATASOURCE::POLARDB::DBClusters は、PolarDB クラスタに関する情報をクエリするために使用されます。
構文
{
"Type": "DATASOURCE::POLARDB::DBClusters",
"Properties": {
"Description": String,
"DbVersion": String,
"ResourceGroupId": String,
"DbClusterId": String,
"Expired": String,
"DbType": String,
"RefreshOptions": String
}
}プロパティ
プロパティ | タイプ | 必須 | 編集可能 | 説明 | 制約 |
Description | String | いいえ | はい | クラスタの説明。 | なし。 |
DbVersion | String | いいえ | はい | データベースエンジンのバージョン。 | 有効な値:
|
ResourceGroupId | String | いいえ | はい | リソースグループの ID。 | なし。 |
DbClusterId | String | いいえ | はい | クラスタ ID。 | なし。 |
Expired | String | いいえ | はい | クラスタが期限切れかどうかを指定します。 | 有効な値:
|
DbType | String | いいえ | はい | データベースエンジンのタイプ。 | なし。 |
RefreshOptions | String | いいえ | はい | スタックが更新されたときのデータソースリソースの更新ポリシー。 | 有効な値:
|
戻り値
Fn::GetAtt
DbClusterIds: クラスタの ID。
DBClusters: クラスタの詳細。
プロパティ | タイプ | 説明 | 制約 |
DbClusterIds | List | クラスタの ID。 | なし。 |
DBClusters | List | クラスタの詳細。 | なし。 |
Category | String | クラスタのエディション。 | 有効な値:
|
LockMode | String | クラスタのロックモード。 | 有効な値:
|
DeletionLock | String | クラスタがロックされていて削除できないかどうかを示します。 | 有効な値:
説明 このプロパティを 1 に設定すると、クラスタを削除できません。 |
DbClusterId | String | クラスタ ID。 | なし。 |
VpcId | String | 仮想プライベートクラウド (VPC) の ID。 | なし。 |
Description | String | クラスタの説明。 | なし。 |
Tags | List | タグ。 | 例: |
ClusterNetworkType | String | クラスタのネットワークタイプ。 | なし。 |
RegionId | String | リージョン ID。 | なし。 |
ResourceGroupId | String | リソースグループの ID。 | なし。 |
DbNodes | List | ノードの詳細。 | 例: |
DbNodeClass | String | ノードタイプ。 | なし。 |
Expired | String | クラスタが期限切れかどうかを示します。 | 有効な値:
説明 このプロパティは、PaymentType が Prepaid に設定されている場合に戻されます。 |
Status | String | クラスタのステータス。 | なし。 |
DbVersion | String | データベースエンジンのバージョン。 | なし。 |
ZoneId | String | ゾーン ID。 | なし。 |
StorageUsed | String | クラスタの使用済みストレージ。 | 単位: バイト。 |
Engine | String | クラスタのデータベースエンジン。 | なし。 |
StorageSpace | String | サブスクリプション課金方法を使用するストレージスペース。 | 単位: バイト。 |
DbType | String | データベースエンジンのタイプ。 | なし。 |
DbNodeNumber | Integer | ノード数。 | なし。 |
ExpireTime | String | クラスタの有効期限。 |
|
PaymentType | String | 課金方法。 | 有効な値:
|
CreateTime | String | 作成時刻。 | なし。 |
例
ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
ExtensionDataSource:
Type: DATASOURCE::POLARDB::DBClusters
Properties:
DbVersion: '5.7'
Outputs:
DbClusterIds:
Description: クラスタの ID。
Value:
Fn::GetAtt:
- ExtensionDataSource
- DbClusterIds
DBClusters:
Description: DB クラスタのリスト。
Value:
Fn::GetAtt:
- ExtensionDataSource
- DBClusters{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
},
"Resources": {
"ExtensionDataSource": {
"Type": "DATASOURCE::POLARDB::DBClusters",
"Properties": {
"DbVersion": "5.7"
}
}
},
"Outputs": {
"DbClusterIds": {
"Description": "クラスタの ID。",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DbClusterIds"
]
}
},
"DBClusters": {
"Description": "DB クラスタのリスト。",
"Value": {
"Fn::GetAtt": [
"ExtensionDataSource",
"DBClusters"
]
}
}
}
}