Skip to content

Bundle

This class encapsulates and extends the ROS resource type ALIYUN::ECD::Bundle, which is used to create a custom desktop template.

Initializers

import ros_cdk_ecd
ros_cdk_ecd.Bundle(
  scope: Construct,
  id: str,
  desktop_type: typing.Union[str, IResolvable],
  image_id: typing.Union[str, IResolvable],
  root_disk_size_gib: typing.Union[typing.Union[int, float], IResolvable],
  user_disk_size_gib: typing.Union[IResolvable, typing.List[typing.Union[typing.Union[int, float], IResolvable]]],
  bundle_name: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  language: typing.Union[str, IResolvable] = None,
  root_disk_performance_level: typing.Union[str, IResolvable] = None,
  user_disk_performance_level: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
desktop_type typing.Union[str, ros_cdk_core.IResolvable] Property desktopType: Desktop specifications.You can call Describundles to query the desktop bundle and get the currently supported desktop specification from the returned desktopType. Explain that ordinary mirrors cannot choose the GPU specifications, and the GPU type mirror can only choose the GPU specification.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: The ID of the image.
root_disk_size_gib typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property rootDiskSizeGib: The root disk size gib.
user_disk_size_gib typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]]] Property userDiskSizeGib: The size of the data disk.
bundle_name typing.Union[str, ros_cdk_core.IResolvable] Property bundleName: The name of the bundle.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the bundle.
language typing.Union[str, ros_cdk_core.IResolvable] Property language: The language.
root_disk_performance_level typing.Union[str, ros_cdk_core.IResolvable] Property rootDiskPerformanceLevel: The root disk performance level.
user_disk_performance_level typing.Union[str, ros_cdk_core.IResolvable] Property userDiskPerformanceLevel: The user disk performance level.Valid values: PL0 PL1 PL2 PL3.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

desktop_typeRequired

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

Property desktopType: Desktop specifications.You can call Describundles to query the desktop bundle and get the currently supported desktop specification from the returned desktopType. Explain that ordinary mirrors cannot choose the GPU specifications, and the GPU type mirror can only choose the GPU specification.


image_idRequired

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

Property imageId: The ID of the image.


root_disk_size_gibRequired

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

Property rootDiskSizeGib: The root disk size gib.


user_disk_size_gibRequired

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

Property userDiskSizeGib: The size of the data disk.

Currently, only one data disk can be set. Unit: GiB.

  • The size of the data disk that supports the setting corresponds to the specification.
  • The data disk size (user_disk_size_gib) set in the template must be greater than the data disk size (data_disk_size) in the mirror.

bundle_nameOptional

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

Property bundleName: The name of the bundle.


descriptionOptional

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

Property description: The description of the bundle.


languageOptional

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

Property language: The language.

Valid values: zh-CN: Simplified Chinese zh-HK: Traditional Chinese (Hong Kong) en-US: English ja-JP: Japanese


root_disk_performance_levelOptional

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

Property rootDiskPerformanceLevel: The root disk performance level.

Valid values: PL0 PL1 PL2 PL3


user_disk_performance_levelOptional

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

Property userDiskPerformanceLevel: The user disk performance level.Valid values: PL0 PL1 PL2 PL3.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct

import ros_cdk_ecd
ros_cdk_ecd.Bundle.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_bundle_id ros_cdk_core.IResolvable Attribute BundleId: Desktop bundle ID.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_bundle_idRequired

attr_bundle_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BundleId: Desktop bundle ID.