ALIYUN::CloudPhone::InstanceGroup is used to create and start Elastic Cloud Phone (ECP) instances.
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 you want to use to connect to 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 |
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 to which the ECP instances belong. | The ECP instances must belong to the same security group as the ECS instances. |
AutoRenew | Boolean | No | No | Specifies whether to enable auto-renewal. | This property takes effect only when ChargeType is set to PrePaid. Valid values:
|
VSwitchId | String | Yes | No | The vSwitch ID. | None. |
Period | Integer | No | No | The subscription duration. |
|
AutoPay | Boolean | No | No | Specifies whether to enable automatic payment. | Valid values:
|
InstanceName | String | No | Yes | The instance name. | The name must be 2 to 128 characters in length, and cannot start with The default value of this property is the value of the InstanceId property. |
EipBandwidth | Integer | No | No | The bandwidth of the elastic IP address (EIP). | Valid values: 1 to 200. If you specify this property, an EIP with the specified bandwidth is automatically created and associated with the ECP instance. If the ECP instance is released, the EIP is also released. |
ChargeType | String | No | No | The billing method of the ECP instance. | Valid values:
|
ImageId | String | Yes | No | The image ID. | None. |
VncPassword | String | No | Yes | The password that you want to use to connect to the management 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 instance type. | None. |
Resolution | String | No | No | The resolution of the ECP instance. | You can call the DescribeInstanceTypes operation to query resolutions that are supported by the instance type to select an appropriate resolution. |
PeriodUnit | String | No | No | The unit of the subscription duration. | Valid values:
|
Tag syntax
"Tag": [
{
"Value": String,
"Key": String
}
]
Tag properties
Property | Type | Required | Editable | Description | Constraint |
Value | String | No | No | The tag key of the ECP instance. | None. |
Key | String | Yes | No | The tag value of the ECP instance. | None. |
Return values
Fn::GetAtt
OrderId: the order ID.
InstanceIds: the IDs of the ECP instances.
TradePrice: the price.
PrivateIps: the private IP addresses. This property is supported only by ECP instances in a virtual private cloud (VPC).