Skip to content

DesktopsProps

Properties for defining a Desktops.

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

Initializer 

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

Properties

Name Type Description
bundleId string | @alicloud/ros-cdk-core.IResolvable Property bundleId: The ID of the cloud desktop template.
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.
amount number | @alicloud/ros-cdk-core.IResolvable Property amount: The number of cloud desktops that you want to create.
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 for the cloud desktop.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method of the cloud desktop.
desktopName string | @alicloud/ros-cdk-core.IResolvable Property desktopName: The name of the cloud desktop.
desktopNameSuffix boolean | @alicloud/ros-cdk-core.IResolvable Property desktopNameSuffix: Specifies whether to automatically add a suffix to the cloud desktop name when you create multiple cloud desktops at a time.
directoryId string | @alicloud/ros-cdk-core.IResolvable Property directoryId: This parameter is not open for use.
endUserId any[] | @alicloud/ros-cdk-core.IResolvable Property endUserId: The user ID that authorizes the use of the cloud desktop, 1~100 can be set.
groupId string | @alicloud/ros-cdk-core.IResolvable Property groupId: desktop group ID。 Note that the desktop group function is currently in the invitation test.
hostname string | @alicloud/ros-cdk-core.IResolvable Property hostname: The custom hostname that you specify for the cloud desktop.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription duration.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: The unit of the subscription duration.
promotionId string | @alicloud/ros-cdk-core.IResolvable Property promotionId: promotion id.
tags TagsProperty[] Property tags: The list of desktops tags in the form of key\/value pairs.
userAssignMode string | @alicloud/ros-cdk-core.IResolvable Property userAssignMode: The assignment mode of the cloud desktop.
userName string | @alicloud/ros-cdk-core.IResolvable Property userName: This parameter is not open for use.
volumeEncryptionEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property volumeEncryptionEnabled: Whether to enable disk encryption.
volumeEncryptionKey string | @alicloud/ros-cdk-core.IResolvable Property volumeEncryptionKey: The key ID of the KMS used when disk encryption is enabled.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: This parameter is not open for use.

bundleIdRequired 

public readonly bundleId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property bundleId: The ID of the cloud desktop template.

officeSiteIdRequired 

public readonly officeSiteId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property officeSiteId: The ID of the workspace.

policyGroupIdRequired 

public readonly policyGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property policyGroupId: The ID of the policy.

amountOptional 

public readonly amount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property amount: The number of cloud desktops that you want to create.

Valid values: 1 to 300. Default value: 1.

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoPay: Specifies whether to enable automatic payment.

Valid values: true: enables automatic payment. You must make sure that your Alibaba Cloud account has sufficient balance. If your Alibaba Cloud account does not have sufficient balance, abnormal orders are generated. false: disables automatic payment. In this case, an order is generated, and no payment is automatically made. You can log on to the EDS console and complete the payment based on the order ID on the Orders page. Default value: true.

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property autoRenew: Specifies whether to enable auto-renewal for the cloud desktop.

This parameter takes effect only when the ChargeType parameter is set to PrePaid. Valid values: true: enables auto-renewal. The renewal duration is the same as the subscription duration that you specified for the Period parameter when you purchased the cloud desktop. false: does not enable auto-renewal. Default value: false.

chargeTypeOptional 

public readonly chargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: The billing method of the cloud desktop.

Valid values: PostPaid: pay-as-you-go PrePaid: subscription Default value: PostPaid.

desktopNameOptional 

public readonly desktopName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property desktopName: The name of the cloud desktop.

desktopNameSuffixOptional 

public readonly desktopNameSuffix: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property desktopNameSuffix: Specifies whether to automatically add a suffix to the cloud desktop name when you create multiple cloud desktops at a time.

True: automatically adds a suffix. False: does not add a suffix.

directoryIdOptional 

public readonly directoryId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property directoryId: This parameter is not open for use.

endUserIdOptional 

public readonly endUserId: any[] | IResolvable;
  • Type: any[] | @alicloud/ros-cdk-core.IResolvable

Property endUserId: The user ID that authorizes the use of the cloud desktop, 1~100 can be set.

During the same period, only one user can use the desktop. If EndUserId is not set, the created cloud desktop will not be assigned to any user.

groupIdOptional 

public readonly groupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property groupId: desktop group ID。 Note that the desktop group function is currently in the invitation test.

If you want to experience it, please submit a work order application.

hostnameOptional 

public readonly hostname: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property hostname: The custom hostname that you specify for the cloud desktop.

You can only specify the hostname of a Windows cloud desktop in the workspace of the enterprise AD account type. The hostname must meet the following requirements: The hostname must be 2 to 15 characters in length. The hostname can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits. If you create multiple cloud desktops, you can specify the names of the cloud desktops in the name_prefix[begin_number,bits]name_suffix format. For example, if you set Hostname to ecd--1,4-test, the hostname of the first cloud desktop is ecd-0001-test and the hostname of the second cloud desktop is ecd-0002-test. The rest may be deduced by analogy. name_prefix: the prefix of the hostname. [begin_number,bits]: the ordered numbers in the hostname. begin_number: the start number. Valid values: 0 to 999999. Default value: 0. bits: the digit. Valid values: 1 to 6. Default value: 6. name_suffix: the suffix of the hostname.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property period: The subscription duration.

The unit of the value is specified by the PeriodUnit parameter. This parameter takes effect and is required only when the ChargeType parameter is set to PrePaid. If PeriodUnit is month, the valid range is 1, 2, 3, 6, 12, 24, 36, 48,60 If periodUnit is year, the valid range is 1 to 5

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodUnit: The unit of the subscription duration.

Valid values: Month Year Default value: Month.

promotionIdOptional 

public readonly promotionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property promotionId: promotion id.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: The list of desktops tags in the form of key\/value pairs.

You can define a maximum of 20 tags for each desktops.

userAssignModeOptional 

public readonly userAssignMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property userAssignMode: The assignment mode of the cloud desktop.

Default value: ALL. ALL: If you specify the EndUserId parameter, the cloud desktops that you create are assigned to each regular user that you specify. PER_USER: If you specify the EndUserId parameter, the cloud desktops that you create are evenly assigned to all regular users that you specify. In this case, you must make sure that the value of the Amount parameter can be divided by the N value of the EndUserId.N parameter that you specify. Note If you do not specify the EndUserId parameter, the cloud desktop that you create is not assigned to regular users.

userNameOptional 

public readonly userName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property userName: This parameter is not open for use.

volumeEncryptionEnabledOptional 

public readonly volumeEncryptionEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property volumeEncryptionEnabled: Whether to enable disk encryption.

volumeEncryptionKeyOptional 

public readonly volumeEncryptionKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property volumeEncryptionKey: The key ID of the KMS used when disk encryption is enabled.

It can be obtained through the ListKeys interface.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: This parameter is not open for use.