ALIYUN::CloudPhone::InstanceGroup - Resource Orchestration Service

Syntax

{
  "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
  }
}

Properties


Property	Type	Required	Editable	Description	Constraint
KeyPairName	String	No	No	The name of the key pair that is used to create the ECP instance.	None
Description	String	No	Yes	The description of the ECP instance.	The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.
Amount	Integer	No	No	The number of Elastic Compute Service (ECS) instances that you want to create.	Valid values: 1 to 100. Default value: 1.
SecurityGroupId	String	Yes	No	The ID of the security group.	The ECP instance uses the same security group as the ECS instances.
AutoRenew	Boolean	No	No	Specifies whether to enable auto-renewal for the ECP instance.	This property takes effect only if the InstanceChargeType property is set to PrePaid. Valid values: true: enables auto-renewal for the instance. false: does not enable auto-renewal for the instance. This is the default value.
VSwitchId	String	Yes	No	The ID of the vSwitch.	None
Period	Integer	No	No	The subscription duration.	Valid values: If the PeriodUnit property is set to Month, the valid values are 1, 2, 3, and 6. If the PeriodUnit property is set to Year, the valid values are 1, 2, 3, 4, and 5.
AutoPay	Boolean	No	No	Specifies whether to enable automatic payment.	Valid values: true: enables automatic payment. This is the default value. false: disables automatic payment.
InstanceName	String	No	Yes	The name of the ECP instance.	The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). The default value of this property is the value of the InstanceId property.
EipBandwidth	Integer	No	No	The bandwidth of the associated elastic IP address (EIP).	Valid values: 1 to 200. If you set this property, an EIP that has the specified bandwidth is automatically created and associated with the ECP instance. If the ECP instance is released, the EIP instance is also released.
ChargeType	String	No	No	The billing method of the ECP instance.	Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. This is the default value.
ImageId	String	Yes	No	The ID of the image.	None
VncPassword	String	No	Yes	The password used to connect to terminal of the ECP instance.	None
Tag	List	No	Yes	The tags of the ECP instance.	For more information, see Tag properties.
InstanceType	String	Yes	No	The type of the ECP instance.	None
Resolution	String	No	No	The resolution to be adopted by the ECP instance.	You can call the DescribeInstanceTypes operation to query the resolutions supported by the specified instance type and then select a proper resolution.
PeriodUnit	String	No	No	The unit of the subscription duration.	Default value: Month. Valid values: Year Month

Tag syntax

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

Tag properties


Property	Type	Required	Editable	Description	Constraint
Value	String	No	No	The key of the tag.	None
Key	String	Yes	No	The value of the tag.	None

Return values

Fn::GetAtt

OrderId: the ID of the order.
InstanceIds: the IDs of the ECP instances.
TradePrice: the trading price.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecurityGroupId": {
      "Type": "String",
      "Description": "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"
    },
    "ImageId": {
      "Type": "String",
      "Description": "The image id"
    },
    "VncPassword": {
      "Type": "String",
      "Description": "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": "oder id",
      "Value": {
        "Fn::GetAtt": [
          "InstanceGroup",
          "OrderId"
        ]
      }
    },
    "InstanceIds": {
      "Description": "instance ids",
      "Value": {
        "Fn::GetAtt": [
          "InstanceGroup",
          "InstanceIds"
        ]
      }
    },
    "TradePrice": {
      "Description": "price",
      "Value": {
        "Fn::GetAtt": [
          "InstanceGroup",
          "TradePrice"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecurityGroupId:
    Type: String
    Description: 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
  ImageId:
    Type: String
    Description: The image id
  VncPassword:
    Type: String
    Description: |-
      Cloud phone VNC password.
      The password must be six characters long, and must contain only uppercase,
      lowercase 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: oder id
    Value:
      Fn::GetAtt:
        - InstanceGroup
        - OrderId
  InstanceIds:
    Description: instance ids
    Value:
      Fn::GetAtt:
        - InstanceGroup
        - InstanceIds
  TradePrice:
    Description: price
    Value:
      Fn::GetAtt:
        - InstanceGroup
        - TradePrice