AnalyticDB for MySQL クラスターを作成するための ALIYUN::ADB::DBCluster の使用方法 - 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,
    "Tags": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DBClusterCategory	String	はい	はい	エディション。	有効値: Cluster: クラスター版のリザーブドモード。説明クラスター版のリザーブドモードのクラスターは、中国本土内のリージョンとシンガポールリージョンでのみサポートされています。シンガポールリージョンでは、従量課金制でのみクラスター版のリザーブドモードのクラスターを購入できます。 MixedStorage: クラスター版のエラスティックモード。説明 DBClusterCategory を Cluster に設定する場合は、Mode を Reserver に設定する必要があります。 DBClusterCategory を MixedStorage に設定する場合は、Mode を Flexible に設定する必要があります。そうしないと、クラスターの作成に失敗します。詳細については、「エディション」をご参照ください。
DBClusterVersion	String	はい	いいえ	クラスターのバージョン。	値を 3.0 に設定します。
Mode	String	はい	いいえ	モード。	有効値: Reserver: リザーブドモード。 Flexible: エラスティックモード。説明このプロパティを指定しない場合、デフォルト値の Reserver が使用されます。
PayType	String	はい	いいえ	課金方法。	有効値: Postpaid: 従量課金。 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。有効値: DBClusterClass が C8 に設定されている場合の有効値: 100 から 1000。 DBClusterClass が C32 に設定されている場合の有効値: 100 から 8000。説明 1,000 GB 未満のストレージ容量は 100 GB 単位で増加します。 1,000 GB を超えるストレージ容量は 1,000 GB 単位で増加します。
ElasticIOResource	Integer	いいえ	はい	エラスティック I/O ユニット ( EIU ) の数。	このプロパティは、Mode が Flexible に設定されている場合にのみ指定する必要があります。詳細については、「エラスティック I/O リソースのスケールアウト」をご参照ください。
ExecutorCount	Integer	いいえ	いいえ	エラスティックモードのクラスターで使用される計算ノードの数。	なし。
Period	Integer	いいえ	いいえ	サブスクリプション期間。	このプロパティは、PayType が Prepaid に設定されている場合にのみ指定する必要があります。有効値: PeriodType が Month に設定されている場合の有効値: 1 から 9。 PeriodType が Year に設定されている場合の有効値: 1 から 3。
PeriodType	String	いいえ	いいえ	クラスターのサブスクリプション期間の単位。	このプロパティは、PayType が Prepaid に設定されている場合にのみ指定する必要があります。有効値: Year Month
ResourceGroupId	String	いいえ	はい	リソースグループの ID。	なし。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。
ZoneId	String	いいえ	いいえ	ゾーンの ID。	DescribeRegions 操作を呼び出して、ゾーンをクエリできます。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字で、`http://` または `https://` を含めることはできません。タグキーは `aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字で、`http://` または `https://` を含めることはできません。タグ値は `aliyun` または `acs:` で始めることはできません。

戻り値

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: |-
      エラスティック IO ユニット
      注: エラスティックモードのクラスターはこのパラメーターを使用します。
    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": "エラスティック IO ユニット\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"
        ]
      }
    }
  }
}