PolarDB-X の ALIYUN::PolarDBX::DBInstance の使用方法 - Resource Orchestration Service

ALIYUN::PolarDBX::DBInstance は、PolarDB for Xscale (PolarDB-X) インスタンスを作成するために使用されます。

構文

{
  "Type": "ALIYUN::PolarDBX::DBInstance",
  "Properties": {
    "TopologyType": String,
    "EngineVersion": String,
    "ResourceGroupId": String,
    "VPCId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "Period": String,
    "PayType": String,
    "DBNodeClass": String,
    "SecondaryZone": String,
    "TertiaryZone": String,
    "DBNodeCount": Integer,
    "PrimaryZone": String,
    "UsedTime": Integer,
    "DBInstanceDescription": String,
    "SecurityIpConfig": Map
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
TopologyType	String	はい	いいえ	トポロジタイプ。	有効な値: 3azones: 3ゾーン 1azone: 単一ゾーン
EngineVersion	String	はい	いいえ	データベースエンジンのバージョン。	インスタンスの課金方法が従量課金制の場合の有効な値: 2.0 および 5.7。インスタンスの課金方法がサブスクリプションの場合の有効な値: 5.7。
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし。
VPCId	String	はい	いいえ	仮想プライベートクラウド (VPC) の ID。	なし。
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	有効な値: true false
VSwitchId	String	はい	いいえ	vSwitch ID。	なし。
Period	String	いいえ	いいえ	課金サイクルの単位。	インスタンスの課金方法がサブスクリプションの場合の有効な値: Year および Month。インスタンスの課金方法が従量課金制の場合の有効な値: Hour。
PayType	String	いいえ	いいえ	インスタンスの課金方法。	サブスクリプション課金方法を指定する有効な値: Subscription、PrePaid、Prepaid、PrePay、PREPAY、および PRE。従量課金制を指定する有効な値: PayOnDemand、PayAsYouGo、PostPaid、PayOnDemand、Postpaid、PostPay、POSTPAY、および POST。
DBNodeClass	String	はい	いいえ	ノードのインスタンスタイプ。	有効な値: polarx.x4.medium.2e: このインスタンスタイプのノードは、2 個の vCPU と 8 GB のメモリで構成されています。 polarx.x4.large.2e: このインスタンスタイプのノードは、4 個の vCPU と 16 GB のメモリで構成されています。 polarx.x8.large.2e: このインスタンスタイプのノードは、4 個の vCPU と 32 GB のメモリで構成されています。 polarx.x4.xlarge.2e: このインスタンスタイプのノードは、8 個の vCPU と 32 GB のメモリで構成されています。 polarx.x8.xlarge.2e: このインスタンスタイプのノードは、8 個の vCPU と 64 GB のメモリで構成されています。 polarx.x4.2xlarge.2e: このインスタンスタイプのノードは、16 個の vCPU と 64 GB のメモリで構成されています。 polarx.x8.2xlarge.2e: このインスタンスタイプのノードは、16 個の vCPU と 128 GB のメモリで構成されています。 polarx.x4.4xlarge.2e: このインスタンスタイプのノードは、32 個の vCPU と 128 GB のメモリで構成されています。 polarx.x8.4xlarge.2e: このインスタンスタイプのノードは、32 個の vCPU と 256 GB のメモリで構成されています。 polarx.st.8xlarge.2e: このインスタンスタイプのノードは、60 個の vCPU と 470 GB のメモリで構成されています。 polarx.st.12xlarge.2e: このインスタンスタイプのノードは、90 個の vCPU と 720 GB のメモリで構成されています。
SecondaryZone	String	いいえ	いいえ	セカンダリゾーン。	なし。
TertiaryZone	String	いいえ	いいえ	ターシャリゾーン。	なし。
DBNodeCount	Integer	はい	いいえ	インスタンス内のノード数。	インスタンスには少なくとも 2 つのノードが含まれている必要があります。
PrimaryZone	String	はい	いいえ	プライマリゾーン。	なし。
UsedTime	Integer	いいえ	いいえ	サブスクリプション期間。	説明 Period が Year に設定されている場合の有効な値: 1、2、および 3。
DBInstanceDescription	String	いいえ	はい	インスタンスの説明。	なし。
SecurityIpConfig	Map	いいえ	いいえ	インスタンスの IP アドレスホワイトリストの構成。	詳細については、SecurityIpConfig プロパティをご参照ください。

SecurityIpConfig 構文

"SecurityIpConfig": {
  "SecurityIPList": String,
  "ModifyMode": String,
  "GroupName": String
}

SecurityIpConfig プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
SecurityIPList	String	いいえ	いいえ	IP アドレスホワイトリスト内の IP アドレス。	複数の IP アドレスはコンマ (,) で区切ります。
ModifyMode	String	いいえ	いいえ	IP アドレスホワイトリストの変更に使用される方法。	有効な値: 0: IP アドレスホワイトリストを上書きして変更します。 1: IP アドレスホワイトリストに IP アドレスを追加します。 2: IP アドレスホワイトリストから IP アドレスを削除します。
GroupName	String	いいえ	いいえ	IP アドレスホワイトリストの名前。	なし。

戻り値

Fn::GetAtt

OrderId: 注文 ID。
DBInstanceName: インスタンス名。
Port: インスタンスの内部ポート。
InnerConnectionString: インスタンスの内部接続文字列。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TopologyType:
    Type: String
    Description: 'インスタンストポロジのタイプ。有効な値：3azones：インスタンスは3つのゾーンにデプロイされます。 1azone：インスタンスは1つのゾーンのみにデプロイされます。'  # Japanese comment added
    AllowedValues:
      - 1azone
      - 3azones
  EngineVersion:
    Type: String
    Description: データベースエンジンのバージョン。 # Japanese comment added
  VPCId:
    Type: String
    Description: インスタンスが属するVPCのID。 # Japanese comment added
  VSwitchId:
    Type: String
    Description: vSwitchのID。 # Japanese comment added
  DBNodeClass:
    Type: String
    Description: 作成するインスタンス内のノードの仕様。 # Japanese comment added
  DBNodeCount:
    Type: Number
    Description: 作成するインスタンス内のノードの数。 # Japanese comment added
    MinValue: 2
  PrimaryZone:
    Type: String
    Description: プライマリゾーン。 # Japanese comment added
Resources:
  DBInstance:
    Type: ALIYUN::PolarDBX::DBInstance
    Properties:
      TopologyType:
        Ref: TopologyType
      EngineVersion:
        Ref: EngineVersion
      VPCId:
        Ref: VPCId
      VSwitchId:
        Ref: VSwitchId
      DBNodeClass:
        Ref: DBNodeClass
      DBNodeCount:
        Ref: DBNodeCount
      PrimaryZone:
        Ref: PrimaryZone
Outputs:
  OrderId:
    Description: 注文のID。 # Japanese comment added
    Value:
      Fn::GetAtt:
        - DBInstance
        - OrderId
  DBInstanceName:
    Description: 作成するインスタンスの名前。 # Japanese comment added
    Value:
      Fn::GetAtt:
        - DBInstance
        - DBInstanceName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TopologyType": {
      "Type": "String",
      "Description": "インスタンストポロジのタイプ。有効な値：3azones：インスタンスは3つのゾーンにデプロイされます。 1azone：インスタンスは1つのゾーンのみにデプロイされます。", // Japanese comment added
      "AllowedValues": [
        "1azone",
        "3azones"
      ]
    },
    "EngineVersion": {
      "Type": "String",
      "Description": "データベースエンジンのバージョン。" // Japanese comment added
    },
    "VPCId": {
      "Type": "String",
      "Description": "インスタンスが属する VPC の ID。" // Japanese comment added
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "vSwitch の ID。" // Japanese comment added
    },
    "DBNodeClass": {
      "Type": "String",
      "Description": "作成するインスタンス内のノードの仕様。" // Japanese comment added
    },
    "DBNodeCount": {
      "Type": "Number",
      "Description": "作成するインスタンス内のノードの数。", // Japanese comment added
      "MinValue": 2
    },
    "PrimaryZone": {
      "Type": "String",
      "Description": "プライマリゾーン。" // Japanese comment added
    }
  },
  "Resources": {
    "DBInstance": {
      "Type": "ALIYUN::PolarDBX::DBInstance",
      "Properties": {
        "TopologyType": {
          "Ref": "TopologyType"
        },
        "EngineVersion": {
          "Ref": "EngineVersion"
        },
        "VPCId": {
          "Ref": "VPCId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "DBNodeClass": {
          "Ref": "DBNodeClass"
        },
        "DBNodeCount": {
          "Ref": "DBNodeCount"
        },
        "PrimaryZone": {
          "Ref": "PrimaryZone"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "注文の ID。", // Japanese comment added
      "Value": {
        "Fn::GetAtt": [
          "DBInstance",
          "OrderId"
        ]
      }
    },
    "DBInstanceName": {
      "Description": "作成するインスタンスの名前。", // Japanese comment added
      "Value": {
        "Fn::GetAtt": [
          "DBInstance",
          "DBInstanceName"
        ]
      }
    }
  }
}