DesktopGroupProps

Properties for defining a DesktopGroup.

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

Initializer

import com.aliyun.ros.cdk.ecd.DesktopGroupProps;
DesktopGroupProps.builder()
    .bundleId(java.lang.String)
    .bundleId(IResolvable)
    .chargeType(java.lang.String)
    .chargeType(IResolvable)
    .officeSiteId(java.lang.String)
    .officeSiteId(IResolvable)
    .policyGroupId(java.lang.String)
    .policyGroupId(IResolvable)
//  .allowAutoSetup(java.lang.Number)
//  .allowAutoSetup(IResolvable)
//  .allowBufferCount(java.lang.Number)
//  .allowBufferCount(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .buyDesktopsCount(java.lang.Number)
//  .buyDesktopsCount(IResolvable)
//  .comments(java.lang.String)
//  .comments(IResolvable)
//  .connectDuration(java.lang.Number)
//  .connectDuration(IResolvable)
//  .defaultInitDesktopCount(java.lang.Number)
//  .defaultInitDesktopCount(IResolvable)
//  .desktopGroupName(java.lang.String)
//  .desktopGroupName(IResolvable)
//  .endUserIds(IResolvable)
//  .endUserIds(java.util.List<java.lang.String)
//  .endUserIds(IResolvable>)
//  .groupVersion(java.lang.Number)
//  .groupVersion(IResolvable)
//  .idleDisconnectDuration(java.lang.Number)
//  .idleDisconnectDuration(IResolvable)
//  .keepDuration(java.lang.Number)
//  .keepDuration(IResolvable)
//  .maxDesktopsCount(java.lang.Number)
//  .maxDesktopsCount(IResolvable)
//  .minDesktopsCount(java.lang.Number)
//  .minDesktopsCount(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .resetType(java.lang.Number)
//  .resetType(IResolvable)
//  .stopDuration(java.lang.Number)
//  .stopDuration(IResolvable)
//  .volumeEncryptionEnabled(java.lang.Boolean)
//  .volumeEncryptionEnabled(IResolvable)
//  .volumeEncryptionKey(java.lang.String)
//  .volumeEncryptionKey(IResolvable)
    .build();

Properties

Name	Type	Description
bundleId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property bundleId: The ID of the desktop template.
chargeType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property chargeType: The billing method of the cloud desktops in the desktop group.
officeSiteId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property officeSiteId: The ID of the workspace.
policyGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property policyGroupId: The ID of the policy.
allowAutoSetup	java.lang.Number OR com.aliyun.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	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property allowBufferCount: Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.
autoPay	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property autoPay: Specifies whether to enable automatic payment.
autoRenew	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property autoRenew: Specifies whether to enable auto-renewal.
buyDesktopsCount	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property buyDesktopsCount: The number of cloud desktops that you want to purchase.
comments	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property comments: The remarks on the desktop group.
connectDuration	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property connectDuration: The maximum period of time during which the session is connected.
defaultInitDesktopCount	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property defaultInitDesktopCount: The default number of cloud desktops to create when you create the desktop group.
desktopGroupName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property desktopGroupName: The name of the desktop group.
endUserIds	com.aliyun.ros.cdk.core.IResolvable OR java.util.List	Property endUserIds: The end users that can use the desktop group.
groupVersion	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property groupVersion: The desktop group version.
idleDisconnectDuration	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property idleDisconnectDuration: The maximum period of time for which a session remains idle.
keepDuration	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property keepDuration: The retention period of the cloud desktop after the end user disconnects from the cloud desktop.
maxDesktopsCount	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property maxDesktopsCount: The maximum number of cloud desktops that the desktop group can contain.
minDesktopsCount	java.lang.Number OR com.aliyun.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	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property period: The subscription period of the cloud desktops in the desktop group.
periodUnit	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property periodUnit: Whether to open CA.
resetType	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property resetType: Specifies which type of the disk to reset for cloud desktops in the desktop group.
stopDuration	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property stopDuration: The period of time before the idle cloud desktop is stopped.
volumeEncryptionEnabled	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.
volumeEncryptionKey	java.lang.String OR com.aliyun.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 java.lang.Object getBundleId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bundleId: The ID of the desktop template.

---

chargeType^Required

public java.lang.Object getChargeType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Enumeration Value: PostPaid PrePaid

---

officeSiteId^Required

public java.lang.Object getOfficeSiteId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property officeSiteId: The ID of the workspace.

---

policyGroupId^Required

public java.lang.Object getPolicyGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property policyGroupId: The ID of the policy.

---

allowAutoSetup^Optional

public java.lang.Object getAllowAutoSetup();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getAllowBufferCount();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getAutoPay();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoPay: Specifies whether to enable automatic payment.

---

autoRenew^Optional

public java.lang.Object getAutoRenew();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Specifies whether to enable auto-renewal.

---

buyDesktopsCount^Optional

public java.lang.Object getBuyDesktopsCount();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: 0 to 200.

---

comments^Optional

public java.lang.Object getComments();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property comments: The remarks on the desktop group.

---

connectDuration^Optional

public java.lang.Object getConnectDuration();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDefaultInitDesktopCount();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDesktopGroupName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property desktopGroupName: The name of the desktop group.

---

endUserIds^Optional

public java.lang.Object getEndUserIds();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

---

groupVersion^Optional

public java.lang.Object getGroupVersion();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property groupVersion: The desktop group version.

---

idleDisconnectDuration^Optional

public java.lang.Object getIdleDisconnectDuration();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getKeepDuration();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getMaxDesktopsCount();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getMinDesktopsCount();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriod();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriodUnit();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodUnit: Whether to open CA.

---

resetType^Optional

public java.lang.Object getResetType();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

---

stopDuration^Optional

public java.lang.Object getStopDuration();

• Type: java.lang.Number OR com.aliyun.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 java.lang.Object getVolumeEncryptionEnabled();

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.

---

volumeEncryptionKey^Optional

public java.lang.Object getVolumeEncryptionKey();

• Type: java.lang.String OR com.aliyun.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.

---