ALIYUN::CloudPhone::InstanceGroup リソースタイプ - ROS

ALIYUN::CloudPhone::InstanceGroup は、クラウドフォンを作成および起動するために使用されます。

構文

{
  "Type": "ALIYUN::CloudPhone::InstanceGroup",
  "Properties": {
    "KeyPairName": String,
    "Description": String,
    "Amount": Integer,
    "SecurityGroupId": String,
    "AutoRenew": Boolean,
    "VSwitchId": String,
    "Period": Integer,
    "AutoPay": Boolean,
    "InstanceName": String,
    "EipBandwidth": Integer,
    "ChargeType": String,
    "ImageId": String,
    "VncPassword": String,
    "Tag": List,
    "InstanceType": String,
    "Resolution": String,
    "PeriodUnit": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
ImageId	String	はい	はい	イメージ ID。	なし。
InstanceType	String	はい	いいえ	クラウドフォンのタイプ ID。	なし。
SecurityGroupId	String	はい	いいえ	クラウドフォンが属するセキュリティグループの ID。	クラウドフォンは、Elastic Compute Service (ECS) インスタンスと同じセキュリティグループに属している必要があります。
VSwitchId	String	はい	いいえ	vSwitch ID。	なし。
Amount	Integer	いいえ	いいえ	作成する ECS インスタンスの数。	有効な値: 1 ～ 100。デフォルト値: 1。
AutoPay	Boolean	いいえ	いいえ	自動支払いを有効にするかどうかを指定します。	有効な値: true (デフォルト) false
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	このプロパティは、ChargeType が PrePaid に設定されている場合にのみ有効になります。有効な値: true false (デフォルト)
ChargeType	String	いいえ	いいえ	クラウドフォンの課金方法。	有効な値: PrePaid: サブスクリプション PostPaid (デフォルト): 従量課金制
Description	String	いいえ	はい	クラウドフォンの説明。	説明は 2 ～ 256 文字で、`http://` または `https://` で始めることはできません。
EipBandwidth	Integer	いいえ	いいえ	Elastic IP アドレス (EIP) の帯域幅。	有効な値: 1 ～ 200。このプロパティを指定すると、指定された帯域幅の EIP が自動的に作成され、クラウドフォンに関連付けられます。クラウドフォンがリリースされると、EIP もリリースされます。
InstanceName	String	いいえ	はい	クラウドフォンの名前。	名前は 2 ～ 128 文字で、`http://` または `https://` で始めることはできません。文字、数字、コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を使用できます。このプロパティのデフォルト値は、InstanceId プロパティの値です。
KeyPairName	String	いいえ	はい	クラウドフォンへの接続に使用するキーペアの名前。	なし。
Period	Integer	いいえ	いいえ	サブスクリプション期間。	PeriodUnit が Month に設定されている場合の有効な値: 1、2、3、6。 PeriodUnit が Year に設定されている場合の有効な値: 1 ～ 5。
PeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値: Year Month (デフォルト)
Resolution	String	いいえ	はい	クラウドフォンの解像度。	DescribeInstanceTypes オペレーションを呼び出して、クラウドフォンタイプでサポートされている解像度を照会し、適切な解像度を選択できます。
Tag	List	いいえ	はい	クラウドフォンのタグ。	詳細については、タグのプロパティをご参照ください。
VncPassword	String	いいえ	はい	クラウドフォンの管理端末への接続に使用するパスワード。	なし。

タグの構文

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

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	クラウドフォンのタグキー。	なし。
Value	String	いいえ	いいえ	クラウドフォンのタグ値。	なし。

戻り値

Fn::GetAtt

OrderId: 注文 ID。
InstanceIds: クラウドフォンの ID。
TradePrice: 価格。
PrivateIps: プライベート IP アドレス。このプロパティは、仮想プライベートクラウド (VPC) に存在するクラウドフォンでのみサポートされています。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecurityGroupId:
    Type: String
    Description: 'ECS インスタンスを作成するためのセキュリティグループ。クラシックインスタンスの場合は、セキュリティグループが VPC に属していない必要があります。VPC インスタンスの場合は、セキュリティグループが指定された VPC に属していることを確認してください。' # ECS instance を作成するためのセキュリティグループ。 クラシックインスタンスの場合は、セキュリティグループが VPC に属していない必要があります。VPC インスタンスの場合は、セキュリティグループが指定された VPC に属していることを確認してください。
  VSwitchId:
    Type: String
    Description: 'vswitch id' # vswitch ID
  ImageId:
    Type: String
    Description: 'The image id' # イメージ ID
  VncPassword:
    Type: String
    Description: |-
      クラウドフォン VNC パスワード。
      パスワードは 6 文字で、大文字、小文字の英字とアラビア数字のみを含める必要があります。
    AllowedPattern: '[a-zA-Z0-9]{6}'
  InstanceType:
    Type: String
    Description: 'instance type' # インスタンスタイプ
Resources:
  InstanceGroup:
    Type: ALIYUN::CloudPhone::InstanceGroup
    Properties:
      SecurityGroupId:
        Ref: SecurityGroupId
      VSwitchId:
        Ref: VSwitchId
      ImageId:
        Ref: ImageId
      VncPassword:
        Ref: VncPassword
      InstanceType:
        Ref: InstanceType
Outputs:
  OrderId:
    Description: 'oder id' # 注文 ID
    Value:
      Fn::GetAtt:
        - InstanceGroup
        - OrderId
  InstanceIds:
    Description: 'instance ids' # インスタンス ID
    Value:
      Fn::GetAtt:
        - InstanceGroup
        - InstanceIds
  TradePrice:
    Description: 'price' # 価格
    Value:
      Fn::GetAtt:
        - InstanceGroup
        - TradePrice

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecurityGroupId": {
      "Type": "String",
      "Description": "ECS インスタンスを作成するためのセキュリティグループ。クラシックインスタンスの場合は、セキュリティグループが VPC に属していない必要があります。VPC インスタンスの場合は、セキュリティグループが指定された VPC に属していることを確認してください。" // Security group to create ecs instance. For classic instance need the security group not belong to VPC, for VPC instance, please make sure the security group belong to specified VPC.
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "vSwitch ID" // vswitch id
    },
    "ImageId": {
      "Type": "String",
      "Description": "イメージ ID" // The image id
    },
    "VncPassword": {
      "Type": "String",
      "Description": "クラウドフォン VNC パスワード。\nパスワードは 6 文字で、大文字、小文字の英字とアラビア数字のみを含める必要があります。", // Cloud phone VNC password.\nThe password must be six characters long, and must contain only uppercase, \nlowercase English letters and Arabic numerals.
      "AllowedPattern": "[a-zA-Z0-9]{6}"
    },
    "InstanceType": {
      "Type": "String",
      "Description": "インスタンスタイプ" // instance type
    }
  },
  "Resources": {
    "InstanceGroup": {
      "Type": "ALIYUN::CloudPhone::InstanceGroup",
      "Properties": {
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "ImageId": {
          "Ref": "ImageId"
        },
        "VncPassword": {
          "Ref": "VncPassword"
        },
        "InstanceType": {
          "Ref": "InstanceType"
        }
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Description": "注文 ID", // oder id
      "Value": {
        "Fn::GetAtt": [
          "InstanceGroup",
          "OrderId"
        ]
      }
    },
    "InstanceIds": {
      "Description": "インスタンス ID", // instance ids
      "Value": {
        "Fn::GetAtt": [
          "InstanceGroup",
          "InstanceIds"
        ]
      }
    },
    "TradePrice": {
      "Description": "価格", // price
      "Value": {
        "Fn::GetAtt": [
          "InstanceGroup",
          "TradePrice"
        ]
      }
    }
  }
}

構文

プロパティ

タグの構文

タグのプロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式