Skip to content

DesktopGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECD::DesktopGroup, which is used to create a cloud computer pool.

Initializers 

import com.aliyun.ros.cdk.ecd.DesktopGroup;
DesktopGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No 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.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bundleIdRequired

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

Property bundleId: The ID of the desktop template.

chargeTypeRequired

  • 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

officeSiteIdRequired

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

Property officeSiteId: The ID of the workspace.

policyGroupIdRequired

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

Property policyGroupId: The ID of the policy.

allowAutoSetupOptional

  • 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.

allowBufferCountOptional

  • 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.

autoPayOptional

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

Property autoPay: Specifies whether to enable automatic payment.

autoRenewOptional

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

Property autoRenew: Specifies whether to enable auto-renewal.

buyDesktopsCountOptional

  • 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.

commentsOptional

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

Property comments: The remarks on the desktop group.

connectDurationOptional

  • 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.

defaultInitDesktopCountOptional

  • 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.

desktopGroupNameOptional

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

Property desktopGroupName: The name of the desktop group.

endUserIdsOptional

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

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

groupVersionOptional

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

Property groupVersion: The desktop group version.

idleDisconnectDurationOptional

  • 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.

keepDurationOptional

  • 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.

maxDesktopsCountOptional

  • 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.

minDesktopsCountOptional

  • 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.

periodOptional

  • 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

periodUnitOptional

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

Property periodUnit: Whether to open CA.

resetTypeOptional

  • 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.

stopDurationOptional

  • 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.

volumeEncryptionEnabledOptional

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

Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.

volumeEncryptionKeyOptional

  • 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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ecd.DesktopGroup;
DesktopGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrDesktopGroupId com.aliyun.ros.cdk.core.IResolvable Attribute DesktopGroupId: Id of created DesktopGroup.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrDesktopGroupIdRequired 

public IResolvable getAttrDesktopGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DesktopGroupId: Id of created DesktopGroup.