DesktopGroupProps

Properties for defining a DesktopGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecd-desktopgroup

Initializer

import { DesktopGroupProps } from '@alicloud/ros-cdk-ecd'
const desktopGroupProps: DesktopGroupProps = { ... }

Properties

Name	Type	Description
bundleId	string | @alicloud/ros-cdk-core.IResolvable	Property bundleId: The ID of the desktop template.
chargeType	string | @alicloud/ros-cdk-core.IResolvable	Property chargeType: The billing method of the cloud desktops in the desktop group.
officeSiteId	string | @alicloud/ros-cdk-core.IResolvable	Property officeSiteId: The ID of the workspace.
policyGroupId	string | @alicloud/ros-cdk-core.IResolvable	Property policyGroupId: The ID of the policy.
allowAutoSetup	number | @alicloud/ros-cdk-core.IResolvable	Property allowAutoSetup: Specifies whether to automatically create cloud desktops in the desktop group if you set the billing method to subscription.
allowBufferCount	number | @alicloud/ros-cdk-core.IResolvable	Property allowBufferCount: Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.
autoPay	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoPay: Specifies whether to enable automatic payment.
autoRenew	boolean | @alicloud/ros-cdk-core.IResolvable	Property autoRenew: Specifies whether to enable auto-renewal.
buyDesktopsCount	number | @alicloud/ros-cdk-core.IResolvable	Property buyDesktopsCount: The number of cloud desktops that you want to purchase.
comments	string | @alicloud/ros-cdk-core.IResolvable	Property comments: The remarks on the desktop group.
connectDuration	number | @alicloud/ros-cdk-core.IResolvable	Property connectDuration: The maximum period of time during which the session is connected.
defaultInitDesktopCount	number | @alicloud/ros-cdk-core.IResolvable	Property defaultInitDesktopCount: The default number of cloud desktops to create when you create the desktop group.
desktopGroupName	string | @alicloud/ros-cdk-core.IResolvable	Property desktopGroupName: The name of the desktop group.
endUserIds	@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]	Property endUserIds: The end users that can use the desktop group.
groupVersion	number | @alicloud/ros-cdk-core.IResolvable	Property groupVersion: The desktop group version.
idleDisconnectDuration	number | @alicloud/ros-cdk-core.IResolvable	Property idleDisconnectDuration: The maximum period of time for which a session remains idle.
keepDuration	number | @alicloud/ros-cdk-core.IResolvable	Property keepDuration: The retention period of the cloud desktop after the end user disconnects from the cloud desktop.
maxDesktopsCount	number | @alicloud/ros-cdk-core.IResolvable	Property maxDesktopsCount: The maximum number of cloud desktops that the desktop group can contain.
minDesktopsCount	number | @alicloud/ros-cdk-core.IResolvable	Property minDesktopsCount: The minimum number of cloud desktops that must be contained in the desktop group if you set the billing method to subscription.
period	number | @alicloud/ros-cdk-core.IResolvable	Property period: The subscription period of the cloud desktops in the desktop group.
periodUnit	string | @alicloud/ros-cdk-core.IResolvable	Property periodUnit: Whether to open CA.
resetType	number | @alicloud/ros-cdk-core.IResolvable	Property resetType: Specifies which type of the disk to reset for cloud desktops in the desktop group.
stopDuration	number | @alicloud/ros-cdk-core.IResolvable	Property stopDuration: The period of time before the idle cloud desktop is stopped.
volumeEncryptionEnabled	boolean | @alicloud/ros-cdk-core.IResolvable	Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.
volumeEncryptionKey	string | @alicloud/ros-cdk-core.IResolvable	Property volumeEncryptionKey: The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled.

---

bundleId^Required

public readonly bundleId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property bundleId: The ID of the desktop template.

---

chargeType^Required

public readonly chargeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: The billing method of the cloud desktops in the desktop group.

Enumeration Value: PostPaid PrePaid

---

officeSiteId^Required

public readonly officeSiteId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property officeSiteId: The ID of the workspace.

---

policyGroupId^Required

public readonly policyGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property policyGroupId: The ID of the policy.

---

allowAutoSetup^Optional

public readonly allowAutoSetup: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property allowAutoSetup: Specifies whether to automatically create cloud desktops in the desktop group if you set the billing method to subscription.

If you set the ChargeType parameter to PrePaid, this parameter is required.

---

allowBufferCount^Optional

public readonly allowBufferCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property allowBufferCount: Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.

If you set the ChargeType parameter to PostPaid, this parameter is required. Valid values: 0: does not allow the system to reserve cloud desktops. N: allows the system to reserve N cloud desktops. The variable N must be an integer that ranges from 1 to 100.

---

autoPay^Optional

public readonly autoPay: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Specifies whether to enable automatic payment.

---

autoRenew^Optional

public readonly autoRenew: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoRenew: Specifies whether to enable auto-renewal.

---

buyDesktopsCount^Optional

public readonly buyDesktopsCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property buyDesktopsCount: The number of cloud desktops that you want to purchase.

Valid values: 0 to 200.

---

comments^Optional

public readonly comments: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property comments: The remarks on the desktop group.

---

connectDuration^Optional

public readonly connectDuration: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property connectDuration: The maximum period of time during which the session is connected.

When the specified maximum period of time is reached, the session automatically disconnects. Unit: milliseconds. This parameter is required only for cloud desktops in the same desktop group.

---

defaultInitDesktopCount^Optional

public readonly defaultInitDesktopCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property defaultInitDesktopCount: The default number of cloud desktops to create when you create the desktop group.

Default value: 1.

---

desktopGroupName^Optional

public readonly desktopGroupName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property desktopGroupName: The name of the desktop group.

---

endUserIds^Optional

public readonly endUserIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property endUserIds: The end users that can use the desktop group.

---

groupVersion^Optional

public readonly groupVersion: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property groupVersion: The desktop group version.

---

idleDisconnectDuration^Optional

public readonly idleDisconnectDuration: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property idleDisconnectDuration: The maximum period of time for which a session remains idle.

If an end user performs no operations on a cloud desktop by using keyboards or mouses during a session, the session becomes idle. When the specified maximum period of time is reached, the session automatically disconnects. Unit: milliseconds. This parameter is required only for cloud desktops in the same desktop group.

---

keepDuration^Optional

public readonly keepDuration: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property keepDuration: The retention period of the cloud desktop after the end user disconnects from the cloud desktop.

Unit: milliseconds.

---

maxDesktopsCount^Optional

public readonly maxDesktopsCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property maxDesktopsCount: The maximum number of cloud desktops that the desktop group can contain.

Valid values: 0 to 200.

---

minDesktopsCount^Optional

public readonly minDesktopsCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property minDesktopsCount: The minimum number of cloud desktops that must be contained in the desktop group if you set the billing method to subscription.

If you set the ChargeType parameter to PrePaid, this parameter is required. Valid values: 0 to the value of MaxDesktopsCount. Default value: 1.

---

period^Optional

public readonly period: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The subscription period of the cloud desktops in the desktop group.

The unit is specified by the PeriodUnit parameter. The Period parameter takes effect only if you set the ChargeType parameter to PrePaid. Valid values if you set the PeriodUnit parameter to Month: 1, 2, 3, 6 Valid values if you set the PeriodUnit parameter to Year: 1, 2, 3, 4, 5

---

periodUnit^Optional

public readonly periodUnit: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: Whether to open CA.

---

resetType^Optional

public readonly resetType: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property resetType: Specifies which type of the disk to reset for cloud desktops in the desktop group.

---

stopDuration^Optional

public readonly stopDuration: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property stopDuration: The period of time before the idle cloud desktop is stopped.

When the specified period of time is reached, the idle cloud desktop automatically stops. If an end user connects to a stopped cloud desktop, the cloud desktop automatically starts. Unit: milliseconds.

---

volumeEncryptionEnabled^Optional

public readonly volumeEncryptionEnabled: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.

---

volumeEncryptionKey^Optional

public readonly volumeEncryptionKey: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property volumeEncryptionKey: The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled.

---