ALIYUN::ADB::DBCluster を呼び出して AnalyticDB for MySQL クラスターを作成する - Resource Orchestration Service

ALIYUN::ADB::DBCluster リソースタイプを使用して、AnalyticDB for MySQL クラスターを作成します。

構文

{
  "Type": "ALIYUN::ADB::DBCluster",
  "Properties": {
    "DBNodeStorage": Integer,
    "PeriodType": String,
    "DBClusterCategory": String,
    "ZoneId": String,
    "ResourceGroupId": String,
    "VPCId": String,
    "VSwitchId": String,
    "Mode": String,
    "DBClusterDescription": String,
    "ComputeResource": String,
    "Period": Integer,
    "PayType": String,
    "ElasticIOResource": Integer,
    "DBClusterVersion": String,
    "DBNodeGroupCount": Integer,
    "ExecutorCount": Integer,
    "DBClusterClass": String,
    "KmsId": String,
    "DiskEncryption": Boolean,
    "EnableSSL": Boolean,
    "Tags": List
  }
}

プロパティ

プロパティ名	タイプ	必須	更新の許可	説明	制約
DBClusterCategory	String	はい	はい	シリーズ	有効値： Cluster: 予約モードクラスターエディション。説明予約モードクラスターエディションは、中国本土およびシンガポールリージョンでのみ購入できます。シンガポールリージョンでは、このエディションは従量課金モードでのみ購入できます。 MixedStorage: エラスティックモードクラスターエディション (新規)。説明 DBClusterCategory が Cluster の場合は、Mode を Reserver に設定します。 DBClusterCategory が MixedStorage の場合は、Mode を Flexible に設定します。そうしないと、クラスターの作成は失敗します。詳細については、「エディション」をご参照ください。
DBClusterVersion	String	はい	いいえ	AnalyticDB for MySQL クラスターのバージョン。	値を 3.0 に設定します。
Mode	String	はい	いいえ	パターン。	有効値：予約済みモード。 Flexible: エラスティックモード。説明このパラメーターを指定しない場合、システムはデフォルトで予約モードを使用します。
PayType	String	はい	いいえ	課金方法。	有効値：後払い: 従量課金。 Prepaid: サブスクリプション (固定期間のサブスクリプション)。
VPCId	String	はい	いいえ	VPC の ID。	なし。
VSwitchId	String	はい	いいえ	vSwitch の ID。	なし。
ComputeResource	String	いいえ	はい	コンピューティングリソース。	コンピューティングリソース。このパラメーターは、Mode が Flexible (エラスティックモード) の場合に必須です。説明 DescribeAvailableResource 操作を呼び出して、指定されたリージョンで利用可能なコンピューティングリソースをクエリします。
DBClusterClass	String	いいえ	はい	仕様。	クラスターの仕様。有効値： C8 C32 説明このパラメーターは、Mode が Reserver (予約モード) の場合に必須です。
DBClusterDescription	String	いいえ	いいえ	備考	なし。
DBNodeGroupCount	Integer	いいえ	はい	ノードグループの数。	有効値：1～200 (整数)。説明このパラメーターは、Mode が Reserver (予約モード) の場合に必須です。
DBNodeStorage	Integer	いいえ	はい	ノードあたりのストレージ容量。	このプロパティは、Mode が Reserver の場合にのみ必須です。単位：GB。有効値：仕様が C8 の場合、有効値は 100～1000 です。仕様が C32 の場合、有効値は 100～8000 です。説明ステップサイズ：1000 GB 未満の値の場合は 100 GB。 1000 GB 以上の値の場合は 1000 GB。
ElasticIOResource	Integer	いいえ	はい	エラスティック I/O ユニット (EIU)。	このプロパティは、Mode が Flexible の場合にのみ必須です。詳細については、「エラスティック I/O ユニット (EIU) のスケールアウト」をご参照ください。
ExecutorCount	Integer	いいえ	いいえ	エラスティックモードのクラスターで使用されるコンピューティングノードの数。	なし。
KmsId	String	いいえ	いいえ	ディスクデータの暗号化に使用されるキーの ID。	説明このパラメーターは、AnalyticDB for MySQL クラスターでディスク暗号化が有効になっている場合にのみ適用されます。
DiskEncryption	Boolean	いいえ	いいえ	ディスク暗号化を有効にするかどうかを指定します。	なし。
EnableSSL	Boolean	いいえ	いいえ	接続に SSL 暗号化を有効にするかどうかを指定します。	有効値： true: 機能を有効にします。 false: シャットダウン。
Period	Integer	いいえ	いいえ	サブスクリプション期間。	このプロパティは、PayType が Prepaid の場合にのみ必須です。有効値：月単位のサブスクリプションの場合：1～9。年単位のサブスクリプションの場合：1～3。
PeriodType	String	いいえ	いいえ	サブスクリプションクラスターが月単位または年単位で課金されるかを指定します。	このプロパティは、PayType が Prepaid の場合にのみ必須です。有効値： Year: 年単位のサブスクリプション。 Month: 月単位のサブスクリプション。
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「Tags プロパティ」をご参照ください。
ZoneId	String	いいえ	いいえ	ゾーンの ID。	DescribeRegions を呼び出して、利用可能なゾーンをクエリします。

Tags の構文

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

Tags プロパティ

プロパティ名	タイプ	必須	更新の許可	説明	制約
Key	String	はい	いいえ	タグキー。	長さ：1～128 文字。 `aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。
Value	String	いいえ	いいえ	タグ値。	長さ：0～128 文字。 `aliyun` または `acs:` で始めることはできません。 `http://` または `https://` を含めることはできません。

戻り値

Fn::GetAtt

DBClusterId: クラスターの ID。
OrderId: 注文の ID。
ConnectionString: VPC の接続文字列。
Arn: リソースの Alibaba Cloud リソースネーム (ARN)。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterCategory:
    Type: String
    Description: |-
      クラスターのエディション。
      予約モードの場合の有効値：
      Basic
      Cluster
      エラスティックモードの場合は、値を MixedStorage に設定します。
    AllowedValues:
      - Basic
      - Cluster
      - MixedStorage
    Default: MixedStorage
  ZoneId:
    AssociationProperty: ALIYUN::ECS::Instance:ZoneId
    Type: String
    Description: クラスターのゾーン ID。DescribeRegions 操作を呼び出して、最新のゾーンリストをクエリできます。
  VPCId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Type: String
    Description: |-
      VPC の ID。
      注：このパラメーターを空のままにすると、指定されたリージョンのデフォルトの VPC または vSwitch が使用されます。リージョンにデフォルトの VPC がない場合は、VPC が作成されます。
  VSwitchId:
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    Type: String
    Description: vSwitch の ID。
    AssociationPropertyMetadata:
      VpcId: VPC
      ZoneId: VSwitchZoneId
  Mode:
    Type: String
    Description: |-
      クラスターのモード。有効値：
      Reserver: 予約モード
      Flexible: エラスティックモード
    AllowedValues:
      - Reserver
      - Flexible
    Default: Flexible
  ComputeResource:
    Type: String
    Description: クラスターのコンピューティングリソース。このパラメーターはエラスティックモードで必須です。
    Default: 8Core32GB
  PayType:
    Type: String
    Description: |-
      クラスターの課金方法。有効値：
      Postpaid: 従量課金
      Prepaid: サブスクリプション
    AllowedValues:
      - Prepaid
      - PostPaid
    Default: PostPaid
  ElasticIOResource:
    Type: Number
    Description: |-
      エラスティック I/O ユニット
      注：エラスティックモードのクラスターではこのパラメーターが使用されます。
    Default: 0
  DBClusterVersion:
    Type: String
    Description: クラスターのバージョン。値を 3.0 に設定します。
    Default: '3.0'
Resources:
  DBCluster:
    Type: ALIYUN::ADB::DBCluster
    Properties:
      DBClusterCategory:
        Ref: DBClusterCategory
      ZoneId:
        Ref: ZoneId
      VPCId:
        Ref: VPCId
      VSwitchId:
        Ref: VSwitchId
      Mode:
        Ref: Mode
      ComputeResource:
        Ref: ComputeResource
      PayType:
        Ref: PayType
      ElasticIOResource:
        Ref: ElasticIOResource
      DBClusterVersion:
        Ref: DBClusterVersion
Outputs:
  DBClusterId:
    Description: クラスターの ID。
    Value:
      Fn::GetAtt:
        - DBCluster
        - DBClusterId
  OrderId:
    Description: 注文の ID。
    Value:
      Fn::GetAtt:
        - DBCluster
        - OrderId
  ConnectionString:
    Description: VPC 接続文字列。
    Value:
      Fn::GetAtt:
        - DBCluster
        - ConnectionString

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterCategory": {
      "Type": "String",
      "Description": "クラスターのエディション。\n予約モードの場合の有効値：\nBasic\nCluster\nエラスティックモードの場合は、値を MixedStorage に設定します。",
      "AllowedValues": [
        "Basic",
        "Cluster",
        "MixedStorage"
      ],
      "Default": "MixedStorage"
    },
    "ZoneId": {
      "AssociationProperty": "ALIYUN::ECS::Instance:ZoneId",
      "Type": "String",
      "Description": "クラスターのゾーン ID。DescribeRegions 操作を呼び出して、最新のゾーンリストをクエリできます。"
    },
    "VPCId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": "VPC の ID。\n注：このパラメーターを空のままにすると、指定されたリージョンのデフォルトの VPC または vSwitch が使用されます。リージョンにデフォルトの VPC がない場合は、VPC が作成されます。"
    },
    "VSwitchId": {
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "Type": "String",
      "Description": "vSwitch の ID。",
      "AssociationPropertyMetadata": {
        "VpcId": "VPC",
        "ZoneId": "VSwitchZoneId"
      }
    },
    "Mode": {
      "Type": "String",
      "Description": "クラスターのモード。有効値：\nReserver: 予約モード\nFlexible: エラスティックモード",
      "AllowedValues": [
        "Reserver",
        "Flexible"
      ],
      "Default": "Flexible"
    },
    "ComputeResource": {
      "Type": "String",
      "Description": "クラスターのコンピューティングリソース。このパラメーターはエラスティックモードで必須です。",
      "Default": "8Core32GB"
    },
    "PayType": {
      "Type": "String",
      "Description": "クラスターの課金方法。有効値：\nPostpaid: 従量課金\nPrepaid: サブスクリプション",
      "AllowedValues": [
        "Prepaid",
        "PostPaid"
      ],
      "Default": "PostPaid"
    },
    "ElasticIOResource": {
      "Type": "Number",
      "Description": "エラスティック I/O ユニット\n注：エラスティックモードのクラスターではこのパラメーターが使用されます。",
      "Default": 0
    },
    "DBClusterVersion": {
      "Type": "String",
      "Description": "クラスターのバージョン。値を 3.0 に設定します。",
      "Default": "3.0"
    }
  },
  "Resources": {
    "DBCluster": {
      "Type": "ALIYUN::ADB::DBCluster",
      "Properties": {
        "DBClusterCategory": {
          "Ref": "DBClusterCategory"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "Mode": {
          "Ref": "Mode"
        },
        "ComputeResource": {
          "Ref": "ComputeResource"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "ElasticIOResource": {
          "Ref": "ElasticIOResource"
        },
        "DBClusterVersion": {
          "Ref": "DBClusterVersion"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "クラスターの ID。",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "DBClusterId"
        ]
      }
    },
    "OrderId": {
      "Description": "注文の ID。",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "OrderId"
        ]
      }
    },
    "ConnectionString": {
      "Description": "VPC 接続文字列。",
      "Value": {
        "Fn::GetAtt": [
          "DBCluster",
          "ConnectionString"
        ]
      }
    }
  }
}