ALIYUN::CDDC::MyBase - Resource Orchestration Service - Alibaba Cloud ドキュメントセンター

ALIYUN::CDDC::MyBase は、ApsaraDB for MyBase の専有 MyBase 専用クラスターでホストを作成するために使用されます。

構文

{
  "Type": "ALIYUN::CDDC::MyBase",
  "Properties": {
    "EcsInstanceName": String,
    "PeriodType": String,
    "ResourceGroupId": String,
    "UserData": String,
    "DedicatedHostGroupDescription": String,
    "DedicatedHostGroupId": String,
    "AutoRenew": Boolean,
    "EcsUniqueSuffix": Boolean,
    "ImageId": String,
    "UserDataInBase64": Boolean,
    "EcsHostName": String,
    "Engine": String,
    "PasswordInherit": Boolean,
    "KeyPairName": String,
    "ZoneId": String,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "ECSClassList": List,
    "Period": Integer,
    "PayType": String,
    "InternetChargeType": String,
    "EcsDeploymentSetId": String,
    "InternetMaxBandwidthOut": Integer,
    "VpcId": String,
    "OsPassword": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ECSClassList	List	はい	いいえ	Elastic Compute Service (ECS) インスタンスの仕様。	例: `[{"sysDiskCapacity":40,"instanceType":"ecs.d2s.10xlarge","nodeCount":1,"sysDiskType":"cloud_essd"}]`
Engine	String	はい	いいえ	データベースエンジンの種類。	有効値: AliSQL Tair
PayType	String	はい	いいえ	課金方法。	値を PrePaid に設定します。
Period	Integer	はい	いいえ	サブスクリプションの期間。	なし。
SecurityGroupId	String	はい	いいえ	セキュリティグループの ID。	なし。
VpcId	String	はい	いいえ	仮想プライベートクラウド (VPC) の ID。	なし。
VSwitchId	String	はい	いいえ	vSwitch ID。	なし。
ZoneId	String	はい	いいえ	ゾーン ID。	なし。
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	有効値: true: false (デフォルト)
DedicatedHostGroupDescription	String	いいえ	いいえ	専有 MyBase 専用クラスターの名前。	なし。
DedicatedHostGroupId	String	いいえ	いいえ	専有 MyBase 専用クラスターの ID。	なし。
EcsDeploymentSetId	String	いいえ	いいえ	ECS デプロイメントセットの ID。	なし。
EcsHostName	String	いいえ	いいえ	ホスト名。	Windows: ホスト名は 2 ～ 15 文字で、文字と数字を含めることができます。ホスト名は数字のみを含めることはできません。 Linux などの Windows 以外の OS: ホスト名は 2 ～ 64 文字でなければなりません。ホスト名内の複数のセグメントはピリオド (.) で区切ります。各セグメントには文字と数字を含めることができ、連続したピリオド (.) を含めることはできません。ホスト名はピリオド (.) で開始または終了することはできません。
EcsInstanceName	String	いいえ	いいえ	ECS インスタンスの名前。	名前は 2 ～ 128 文字でなければなりません。文字で始まり、`http://` または `https://` で始めることはできません。文字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。このプロパティのデフォルト値は、InstanceId プロパティの値です。
EcsUniqueSuffix	Boolean	いいえ	いいえ	複数のインスタンスを作成するときに、HostName 値と InstanceName 値に連番の接尾辞を自動的に追加するかどうかを指定します。	連番の接尾辞の範囲は 001 ～ 999 です。有効値: true false (デフォルト) `name_suffix` で指定された接尾辞を含まない `name_prefix[begin_number,bits]` 形式で HostName 値または InstanceName 値を指定した場合、EcsUniqueSuffix は有効になりません。名前は指定された順序でのみソートされます。
ImageId	String	いいえ	いいえ	カスタムイメージの ID。	デフォルトイメージを使用する場合は、このプロパティを空のままにすることができます。
InternetChargeType	String	いいえ	いいえ	ネットワーク使用量の課金方法。	有効値: PayByBandwidth PayByTraffic
InternetMaxBandwidthOut	Integer	いいえ	いいえ	パブリックアウトバウンドトラフィックの最大帯域幅。	単位: Mbit/s。有効値: 0 ～ 100。デフォルト値: 0。このプロパティを 0 より大きい値に設定すると、パブリック IP アドレスが作成されます。
KeyPairName	String	いいえ	いいえ	キーペアの名前。	なし。
OsPassword	String	いいえ	いいえ	ホストのログインパスワード。	パスワードは次の要件を満たしている必要があります。パスワードは 8 ～ 30 文字の長さでなければなりません。大文字、小文字、数字、特殊文字のうち、少なくとも 3 種類の文字タイプを含める必要があります。次の特殊文字がサポートされています: ( ) \ ~ ! @ # $ % ^ & * - _ + = \| { } [ ] : ; ' < > , . ? / `。説明ログインパスワードを後で指定する場合は、このプロパティを空のままにすることができます。このプロパティを指定する場合は、パスワードの漏洩を防ぐために、`HTTPS` を使用してリクエストを送信することをお勧めします。
PasswordInherit	Boolean	いいえ	いいえ	イメージのデフォルトパスワードを使用するかどうかを指定します。	有効値: true false (デフォルト) 説明このプロパティを true に設定すると、OSPassword を空のままにすることができます。
PeriodType	String	いいえ	いいえ	サブスクリプション期間の単位。	値を Monthly に設定します。
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし。
UserData	String	いいえ	いいえ	ユーザーデータ。	生のユーザーデータのサイズは最大 16 KB です。
UserDataInBase64	Boolean	いいえ	いいえ	ユーザーデータを Base64 でエンコードするかどうかを指定します。	有効値: true false

戻り値

Fn::GetAtt

OrderIds: 注文 ID。
InstanceIds: ホスト上に作成される ECS インスタンスの ID。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AutoRenew:
    Description:
      ja: 自動更新を有効にするかどうか。
    Required: false
    Type: Boolean
  DedicatedHostGroupDescription:
    Description:
      ja: 専用クラスターの名前。
    Required: false
    Type: String
  DedicatedHostGroupId:
    Description:
      ja: 専用クラスターの ID。
    Required: false
    Type: String
  ECSClassList:
    AssociationProperty: List[Parameter]
    AssociationPropertyMetadata:
      Parameter:
        Description:
          ja: ECS クラスのプロパティ。
        Required: true
        Type: Json
    Description:
      ja: ECS クラスリスト。
    MaxLength: 1
    MinLength: 1
    Required: true
    Type: Json
  EcsDeploymentSetId:
    Description:
      ja: デプロイメントセットの ID。
    Required: false
    Type: String
  EcsHostName:
    Description:
      ja: ECS インスタンスのホスト名。
    Required: false
    Type: String
  EcsInstanceName:
    Description:
      ja: ECS インスタンスの名前。
    Required: false
    Type: String
  EcsUniqueSuffix:
    Description:
      ja: ECS インスタンスの一意の接尾辞。
    Required: false
    Type: Boolean
  Engine:
    Description:
      ja: データベースの種類。
    Required: true
    Type: String
  ImageId:
    Description:
      ja: イメージ ID。
    Required: false
    Type: String
  InternetChargeType:
    AllowedValues:
    - PayByTraffic
    - PayByBandwidth
    AssociationPropertyMetadata:
      LocaleKey: InternetChargeType
    Description:
      ja: "ネットワーク課金タイプ。値の範囲: \nPayByBandwidth: 固定帯域幅に基づいて課金されます。 \nPayByTraffic: トラフィックの使用量に基づいて課金されます。"
    Required: false
    Type: String
  InternetMaxBandwidthOut:
    Description:
      ja: "インスタンスのパブリックアウトバウンドトラフィックの帯域幅を設定します。単位は Mbps（メガビット/秒）です。\n範囲は [0,200] です。デフォルトは 1 です。 \nプロパティが 0 以外の場合は、インスタンスにパブリック IP が割り当てられます。"
    MinValue: 0
    Required: false
    Type: Number
  KeyPairName:
    Description:
      ja: キーペアの名前。
    Required: false
    Type: String
  OsPassword:
    Description:
      ja: 作成された ECS インスタンスのパスワード。特殊文字、小文字、大文字、数字の少なくとも 3 種類を含める必要があります。
    Required: false
    Type: String
  PasswordInherit:
    Description:
      ja: 親クラスターからパスワードを継承するかどうか。
    Required: false
    Type: Boolean
  PayType:
    AllowedValues:
    - Subscription
    Description:
      ja: 支払いタイプ。現在は PrePaid のみをサポートしています。
    Required: true
    Type: String
  Period:
    AssociationProperty: PayPeriod
    Description:
      ja: サブスクリプションの期間（月単位）。
    MaxValue: 12
    MinValue: 1
    Required: true
    Type: Number
  PeriodType:
    AssociationProperty: PayPeriodUnit
    Description:
      ja: プリペイドタイプ。現在は月額 (月額サブスクリプション) のみをサポートしています。
    Required: false
    Type: String
  ResourceGroupId:
    Description:
      ja: リソースグループ ID。
    Required: false
    Type: String
  SecurityGroupId:
    AssociationProperty: ALIYUN::ECS::SecurityGroup::SecurityGroupId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
    Description:
      ja: セキュリティグループの ID。
    Required: true
    Type: String
  UserData:
    AssociationProperty: TextArea
    Description:
      ja: ユーザー定義スクリプトデータ。元のデータは最大 16 KB です。
    Required: false
    Type: String
  UserDataInBase64:
    Description:
      ja: ECS インスタンスのユーザーデータ。
    Required: false
    Type: Boolean
  VSwitchId:
    AssociationProperty: ALIYUN::VPC::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
      ZoneId: ${ZoneId}
    Description:
      ja: 仮想スイッチ ID。
    Required: true
    Type: String
  VpcId:
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
    Description:
      ja: VPC の ID。
    Required: true
    Type: String
  ZoneId:
    AssociationProperty: ZoneId
    Description:
      ja: アベイラビリティゾーン ID。
    Required: true
    Type: String
Resources:
  MyBase:
    Properties:
      AutoRenew:
        Ref: AutoRenew
      DedicatedHostGroupDescription:
        Ref: DedicatedHostGroupDescription
      DedicatedHostGroupId:
        Ref: DedicatedHostGroupId
      ECSClassList:
        Ref: ECSClassList
      EcsDeploymentSetId:
        Ref: EcsDeploymentSetId
      EcsHostName:
        Ref: EcsHostName
      EcsInstanceName:
        Ref: EcsInstanceName
      EcsUniqueSuffix:
        Ref: EcsUniqueSuffix
      Engine:
        Ref: Engine
      ImageId:
        Ref: ImageId
      InternetChargeType:
        Ref: InternetChargeType
      InternetMaxBandwidthOut:
        Ref: InternetMaxBandwidthOut
      KeyPairName:
        Ref: KeyPairName
      OsPassword:
        Ref: OsPassword
      PasswordInherit:
        Ref: PasswordInherit
      PayType:
        Ref: PayType
      Period:
        Ref: Period
      PeriodType:
        Ref: PeriodType
      ResourceGroupId:
        Ref: ResourceGroupId
      SecurityGroupId:
        Ref: SecurityGroupId
      UserData:
        Ref: UserData
      UserDataInBase64:
        Ref: UserDataInBase64
      VSwitchId:
        Ref: VSwitchId
      VpcId:
        Ref: VpcId
      ZoneId:
        Ref: ZoneId
    Type: ALIYUN::CDDC::MyBase
Outputs:
  InstanceIds:
    Description: 作成された ECS インスタンスのインスタンス ID リスト
    Value:
      Fn::GetAtt:
      - MyBase
      - InstanceIds
  OrderIds:
    Description: 注文 ID リスト。
    Value:
      Fn::GetAtt:
      - MyBase
      - OrderIds

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "EcsInstanceName": {
      "Type": "String",
      "Description": {
        "ja": "ECS インスタンスの名前。"
      },
      "Required": false
    },
    "PeriodType": {
      "AssociationProperty": "PayPeriodUnit",
      "Type": "String",
      "Description": {
        "ja": "プリペイドタイプ。現在は月額 (月額サブスクリプション) のみをサポートしています。"
      },
      "Required": false
    },
    "ResourceGroupId": {
      "Type": "String",
      "Description": {
        "ja": "リソースグループ ID。"
      },
      "Required": false
    },
    "UserData": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "ja": "ユーザー定義スクリプトデータ。元のデータは最大 16 KB です。"
      },
      "Required": false
    },
    "DedicatedHostGroupDescription": {
      "Type": "String",
      "Description": {
        "ja": "専用クラスターの名前。"
      },
      "Required": false
    },
    "DedicatedHostGroupId": {
      "Type": "String",
      "Description": {
        "ja": "専用クラスターの ID。"
      },
      "Required": false
    },
    "AutoRenew": {
      "Type": "Boolean",
      "Description": {
        "ja": "自動更新を有効にするかどうか。"
      },
      "Required": false
    },
    "EcsUniqueSuffix": {
      "Type": "Boolean",
      "Description": {
        "ja": "ECS インスタンスの一意の接尾辞。"
      },
      "Required": false
    },
    "ImageId": {
      "Type": "String",
      "Description": {
        "ja": "イメージ ID。"
      },
      "Required": false
    },
    "UserDataInBase64": {
      "Type": "Boolean",
      "Description": {
        "ja": "ECS インスタンスのユーザーデータ。"
      },
      "Required": false
    },
    "EcsHostName": {
      "Type": "String",
      "Description": {
        "ja": "ECS インスタンスのホスト名。"
      },
      "Required": false
    },
    "Engine": {
      "Type": "String",
      "Description": {
        "ja": "データベースの種類。"
      },
      "Required": true
    },
    "PasswordInherit": {
      "Type": "Boolean",
      "Description": {
        "ja": "親クラスターからパスワードを継承するかどうか。"
      },
      "Required": false
    },
    "KeyPairName": {
      "Type": "String",
      "Description": {
        "ja": "キーペアの名前。"
      },
      "Required": false
    },
    "ZoneId": {
      "AssociationProperty": "ZoneId",
      "Type": "String",
      "Description": {
        "ja": "アベイラビリティゾーン ID。"
      },
      "Required": true
    },
    "VSwitchId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}",
        "ZoneId": "${ZoneId}"
      },
      "AssociationProperty": "ALIYUN::VPC::VSwitch::VSwitchId",
      "Type": "String",
      "Description": {
        "ja": "仮想スイッチ ID。"
      },
      "Required": true
    },
    "SecurityGroupId": {
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}"
      },
      "AssociationProperty": "ALIYUN::ECS::SecurityGroup::SecurityGroupId",
      "Type": "String",
      "Description": {
        "ja": "セキュリティグループの ID。"
      },
      "Required": true
    },
    "ECSClassList": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "Json",
          "Description": {
            "ja": "ECS クラスのプロパティ。"
          },
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "ja": "ECS クラスリスト。"
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 1
    },
    "Period": {
      "AssociationProperty": "PayPeriod",
      "Type": "Number",
      "Description": {
        "ja": "サブスクリプションの期間（月単位）。"
      },
      "Required": true,
      "MinValue": 1,
      "MaxValue": 12
    },
    "PayType": {
      "Type": "String",
      "Description": {
        "ja": "支払いタイプ。現在は PrePaid のみをサポートしています。"
      },
      "AllowedValues": [
        "Subscription"
      ],
      "Required": true
    },
    "InternetChargeType": {
      "AssociationPropertyMetadata": {
        "LocaleKey": "InternetChargeType"
      },
      "Type": "String",
      "Description": {
        "ja": "ネットワーク課金タイプ。値の範囲: \nPayByBandwidth: 固定帯域幅に基づいて課金されます。 \nPayByTraffic: トラフィックの使用量に基づいて課金されます。"
      },
      "AllowedValues": [
        "PayByTraffic",
        "PayByBandwidth"
      ],
      "Required": false
    },
    "EcsDeploymentSetId": {
      "Type": "String",
      "Description": {
        "ja": "デプロイメントセットの ID。"
      },
      "Required": false
    },
    "InternetMaxBandwidthOut": {
      "Type": "Number",
      "Description": {
        "ja": "インスタンスのパブリックアウトバウンドトラフィックの帯域幅を設定します。単位は Mbps（メガビット/秒）です。 \n範囲は [0,200] です。デフォルトは 1 です。 \nプロパティが 0 以外の場合は、インスタンスにパブリック IP が割り当てられます。"
      },
      "Required": false,
      "MinValue": 0
    },
    "VpcId": {
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId",
      "Type": "String",
      "Description": {
        "ja": "VPC の ID。"
      },
      "Required": true
    },
    "OsPassword": {
      "Type": "String",
      "Description": {
        "ja": "作成された ECS インスタンスのパスワード。特殊文字、小文字、大文字、数字の少なくとも 3 種類を含める必要があります。"
      },
      "Required": false
    }
  },
  "Resources": {
    "MyBase": {
      "Type": "ALIYUN::CDDC::MyBase",
      "Properties": {
        "EcsInstanceName": {
          "Ref": "EcsInstanceName"
        },
        "PeriodType": {
          "Ref": "PeriodType"
        },
        "ResourceGroupId": {
          "Ref": "ResourceGroupId"
        },
        "UserData": {
          "Ref": "UserData"
        },
        "DedicatedHostGroupDescription": {
          "Ref": "DedicatedHostGroupDescription"
        },
        "DedicatedHostGroupId": {
          "Ref": "DedicatedHostGroupId"
        },
        "AutoRenew": {
          "Ref": "AutoRenew"
        },
        "EcsUniqueSuffix": {
          "Ref": "EcsUniqueSuffix"
        },
        "ImageId": {
          "Ref": "ImageId"
        },
        "UserDataInBase64": {
          "Ref": "UserDataInBase64"
        },
        "EcsHostName": {
          "Ref": "EcsHostName"
        },
        "Engine": {
          "Ref": "Engine"
        },
        "PasswordInherit": {
          "Ref": "PasswordInherit"
        },
        "KeyPairName": {
          "Ref": "KeyPairName"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "ECSClassList": {
          "Ref": "ECSClassList"
        },
        "Period": {
          "Ref": "Period"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "InternetChargeType": {
          "Ref": "InternetChargeType"
        },
        "EcsDeploymentSetId": {
          "Ref": "EcsDeploymentSetId"
        },
        "InternetMaxBandwidthOut": {
          "Ref": "InternetMaxBandwidthOut"
        },
        "VpcId": {
          "Ref": "VpcId"
        },
        "OsPassword": {
          "Ref": "OsPassword"
        }
      }
    }
  },
  "Outputs": {
    "OrderIds": {
      "Description": "注文 ID リスト。",
      "Value": {
        "Fn::GetAtt": [
          "MyBase",
          "OrderIds"
        ]
      }
    },
    "InstanceIds": {
      "Description": "作成された ECS インスタンスのインスタンス ID リスト",
      "Value": {
        "Fn::GetAtt": [
          "MyBase",
          "InstanceIds"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式