Skip to content

DesktopGroupProps

Properties for defining a DesktopGroup.

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

Initializer 

import ros_cdk_ecd
ros_cdk_ecd.DesktopGroupProps(
  bundle_id: typing.Union[str, IResolvable],
  charge_type: typing.Union[str, IResolvable],
  office_site_id: typing.Union[str, IResolvable],
  policy_group_id: typing.Union[str, IResolvable],
  allow_auto_setup: typing.Union[typing.Union[int, float], IResolvable] = None,
  allow_buffer_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  buy_desktops_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  comments: typing.Union[str, IResolvable] = None,
  connect_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  default_init_desktop_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  desktop_group_name: typing.Union[str, IResolvable] = None,
  end_user_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  group_version: typing.Union[typing.Union[int, float], IResolvable] = None,
  idle_disconnect_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  keep_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_desktops_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_desktops_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  reset_type: typing.Union[typing.Union[int, float], IResolvable] = None,
  stop_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  volume_encryption_enabled: typing.Union[bool, IResolvable] = None,
  volume_encryption_key: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
bundle_id typing.Union[str, ros_cdk_core.IResolvable] Property bundleId: The ID of the desktop template.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the cloud desktops in the desktop group.
office_site_id typing.Union[str, ros_cdk_core.IResolvable] Property officeSiteId: The ID of the workspace.
policy_group_id typing.Union[str, ros_cdk_core.IResolvable] Property policyGroupId: The ID of the policy.
allow_auto_setup typing.Union[typing.Union[int, float], 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.
allow_buffer_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property allowBufferCount: Specifies whether to reserve cloud desktops if you set the billing method to pay-as-you-go.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Specifies whether to enable automatic payment.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Specifies whether to enable auto-renewal.
buy_desktops_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property buyDesktopsCount: The number of cloud desktops that you want to purchase.
comments typing.Union[str, ros_cdk_core.IResolvable] Property comments: The remarks on the desktop group.
connect_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property connectDuration: The maximum period of time during which the session is connected.
default_init_desktop_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property defaultInitDesktopCount: The default number of cloud desktops to create when you create the desktop group.
desktop_group_name typing.Union[str, ros_cdk_core.IResolvable] Property desktopGroupName: The name of the desktop group.
end_user_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property endUserIds: The end users that can use the desktop group.
group_version typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property groupVersion: The desktop group version.
idle_disconnect_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property idleDisconnectDuration: The maximum period of time for which a session remains idle.
keep_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property keepDuration: The retention period of the cloud desktop after the end user disconnects from the cloud desktop.
max_desktops_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxDesktopsCount: The maximum number of cloud desktops that the desktop group can contain.
min_desktops_count typing.Union[typing.Union[int, float], 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 typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The subscription period of the cloud desktops in the desktop group.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: Whether to open CA.
reset_type typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property resetType: Specifies which type of the disk to reset for cloud desktops in the desktop group.
stop_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property stopDuration: The period of time before the idle cloud desktop is stopped.
volume_encryption_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.
volume_encryption_key typing.Union[str, 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.

bundle_idRequired 

bundle_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property bundleId: The ID of the desktop template.

charge_typeRequired 

charge_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Enumeration Value: PostPaid PrePaid

office_site_idRequired 

office_site_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property officeSiteId: The ID of the workspace.

policy_group_idRequired 

policy_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property policyGroupId: The ID of the policy.

allow_auto_setupOptional 

allow_auto_setup: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

allow_buffer_countOptional 

allow_buffer_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

auto_payOptional 

auto_pay: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoPay: Specifies whether to enable automatic payment.

auto_renewOptional 

auto_renew: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property autoRenew: Specifies whether to enable auto-renewal.

buy_desktops_countOptional 

buy_desktops_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Valid values: 0 to 200.

commentsOptional 

comments: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property comments: The remarks on the desktop group.

connect_durationOptional 

connect_duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

default_init_desktop_countOptional 

default_init_desktop_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Default value: 1.

desktop_group_nameOptional 

desktop_group_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property desktopGroupName: The name of the desktop group.

end_user_idsOptional 

end_user_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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

group_versionOptional 

group_version: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property groupVersion: The desktop group version.

idle_disconnect_durationOptional 

idle_disconnect_duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

keep_durationOptional 

keep_duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Unit: milliseconds.

max_desktops_countOptional 

max_desktops_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Valid values: 0 to 200.

min_desktops_countOptional 

min_desktops_count: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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 

period: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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

period_unitOptional 

period_unit: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property periodUnit: Whether to open CA.

reset_typeOptional 

reset_type: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

stop_durationOptional 

stop_duration: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

volume_encryption_enabledOptional 

volume_encryption_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property volumeEncryptionEnabled: Specifies whether to enable disk encryption.

volume_encryption_keyOptional 

volume_encryption_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.