ALIYUN::ECD::DesktopGroup is used to create a cloud computer pool.
Syntax
{
"Type": "ALIYUN::ECD::DesktopGroup",
"Properties": {
"ConnectDuration": Integer,
"DesktopGroupName": String,
"AutoRenew": Boolean,
"VolumeEncryptionEnabled": Boolean,
"AllowBufferCount": Integer,
"GroupVersion": Integer,
"KeepDuration": Integer,
"IdleDisconnectDuration": Integer,
"MaxDesktopsCount": Integer,
"ResetType": Integer,
"MinDesktopsCount": Integer,
"Comments": String,
"PolicyGroupId": String,
"EndUserIds": List,
"Period": Integer,
"DefaultInitDesktopCount": Integer,
"AutoPay": Boolean,
"OfficeSiteId": String,
"BundleId": String,
"StopDuration": Integer,
"ChargeType": String,
"VolumeEncryptionKey": String,
"AllowAutoSetup": Integer,
"BuyDesktopsCount": Integer,
"PeriodUnit": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
BundleId | String | Yes | No | The ID of the cloud computer template. | None. |
ChargeType | String | Yes | No | The billing method of the cloud computers. | Valid values:
|
OfficeSiteId | String | Yes | No | The ID of the office network to which the cloud computer pool belongs. | None. |
PolicyGroupId | String | Yes | No | The ID of the policy that you want to associate with the cloud computer pool. | None. |
AllowAutoSetup | Integer | No | No | Specifies whether to automatically create cloud computers in the subscription cloud computer pool. | You must specify this property only when
|
AllowBufferCount | Integer | No | No | The number of cloud computers that can be reserved in the pay-as-you-go cloud computer pool. | You must specify this property only when
|
AutoPay | Boolean | No | No | Specifies whether to automatically complete the payment for subscription orders. | None. |
AutoRenew | Boolean | No | No | Specifies whether to enable auto-renewal for the subscription cloud computer pool. | Valid values:
|
BuyDesktopsCount | Integer | No | No | The meaning of this property varies based on the billing method of the cloud computer pool. |
Valid values: 0 to 200. |
Comments | String | No | No | The description. | None. |
ConnectDuration | Integer | No | No | The maximum period of time for a session to remain connected. | When the specified maximum period of time is reached, the session is automatically disconnected. Unit: milliseconds. Valid values: 900000 to 345600000. The valid values indicate the time range from 15 minutes to 4 days. |
DefaultInitDesktopCount | Integer | No | No | The number of cloud computers that are automatically created when you create the cloud computer pool. | Default value: 1. |
DesktopGroupName | String | No | No | The name of the cloud computer pool. | The name can be up to 30 characters in length. It must start with a letter and cannot start with |
EndUserIds | List | No | No | The IDs of the authorized users for the cloud computer pool. | None. |
GroupVersion | Integer | No | No | The version of the cloud computer pool. | None. |
IdleDisconnectDuration | Integer | No | No | The maximum period of time after which an established session is disconnected. After an end user connects to a cloud computer, the session is established. If the system detects no inputs from the keyboard or mouse within the specified maximum period of time, the session is disconnected. | Unit: milliseconds. Valid values: 360000 to 3600000. The valid values indicate the time range from 6 minutes to 60 minutes. If the end user is still connecting to the cloud computer 30 seconds before the specified maximum period of time elapses, a message about saving data is sent to the end user. In this case, the end user must save data on the cloud computer to prevent data loss. |
KeepDuration | Integer | No | No | The period of time during which a session remains active after the session is disconnected. | Unit: milliseconds. Valid values: 180000 to 345600000. The valid values indicate the time range from 3 minutes to 4 days. A value of 0 indicates that a session remains active all the time after the session is disconnected. If a session is disconnected regardless of the reason, the session remains active for a period of time. If an end user resumes the session within the specified period of time, the original data can still be accessed. If the end user does not resume the session within the specified period of time, unsaved data is cleared and the session is disconnected. |
MaxDesktopsCount | Integer | No | No | The maximum number of cloud computers that can be contained in the pay-as-you-go cloud computer pool. | Valid values: 0 to 500. |
MinDesktopsCount | Integer | No | No | The maximum number of cloud computers that can be automatically created in the subscription cloud computer pool. | You must specify this property only when |
Period | Integer | No | No | The subscription duration of the cloud computer pool. | You must specify this property only when
|
PeriodUnit | String | No | No | The unit of the subscription duration. | Valid values:
|
ResetType | Integer | No | No | The disk reset type of the cloud computers. | Valid values:
|
StopDuration | Integer | No | No | The period of time after which an idle cloud computer is stopped. | When the specified period of time is reached, the cloud computer is automatically stopped. If an end user connects to the stopped cloud computer, the cloud computer is automatically started. Unit: milliseconds. |
VolumeEncryptionEnabled | Boolean | No | No | Specifies whether to enable disk encryption. | None. |
VolumeEncryptionKey | String | No | No | The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled. | None. |
Return values
Fn::GetAtt
DesktopGroupId: the ID of the cloud computer pool.
Examples
YAML
format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
PolicyGroupId:
Type: String
Description:
en: The ID of the policy.
Required: true
OfficeSiteId:
Type: String
Description:
en: The ID of the workspace.
Required: true
BundleId:
Type: String
Description:
en: The ID of the desktop template.
Required: true
ChargeType:
Type: String
Description:
en: |-
The billing method of the cloud desktops in the desktop group. Enumeration Value:
PostPaid
PrePaid
AllowedValues:
- PostPaid
- PrePaid
Required: true
Resources:
ExtensionResource:
Type: ALIYUN::ECD::DesktopGroup
Properties:
PolicyGroupId:
Ref: PolicyGroupId
OfficeSiteId:
Ref: OfficeSiteId
BundleId:
Ref: BundleId
ChargeType:
Ref: ChargeType
Outputs:
DesktopGroupId:
Description: Id of created DesktopGroup
Value:
Fn::GetAtt:
- ExtensionResource
- DesktopGroupId
JSON
format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"PolicyGroupId": {
"Type": "String",
"Description": {
"en": "The ID of the policy."
},
"Required": true
},
"OfficeSiteId": {
"Type": "String",
"Description": {
"en": "The ID of the workspace."
},
"Required": true
},
"BundleId": {
"Type": "String",
"Description": {
"en": "The ID of the desktop template."
},
"Required": true
},
"ChargeType": {
"Type": "String",
"Description": {
"en": "The billing method of the cloud desktops in the desktop group. Enumeration Value:\nPostPaid\nPrePaid"
},
"AllowedValues": [
"PostPaid",
"PrePaid"
],
"Required": true
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::ECD::DesktopGroup",
"Properties": {
"PolicyGroupId": {
"Ref": "PolicyGroupId"
},
"OfficeSiteId": {
"Ref": "OfficeSiteId"
},
"BundleId": {
"Ref": "BundleId"
},
"ChargeType": {
"Ref": "ChargeType"
}
}
}
},
"Outputs": {
"DesktopGroupId": {
"Description": "Id of created DesktopGroup",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"DesktopGroupId"
]
}
}
}
}