Disk

• Implements: IDisk

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Disk, which is used to create a cloud disk in Elastic Compute Service (ECS).

Initializers

import ros_cdk_ecs
ros_cdk_ecs.Disk(
  scope: Construct,
  id: str,
  auto_snapshot_policy_id: typing.Union[str, IResolvable] = None,
  bursting_enabled: typing.Union[bool, IResolvable] = None,
  delete_auto_snapshot: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  disk_category: typing.Union[str, IResolvable] = None,
  disk_name: typing.Union[str, IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  multi_attach: typing.Union[str, IResolvable] = None,
  performance_level: typing.Union[str, IResolvable] = None,
  provisioned_iops: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  size: typing.Union[typing.Union[int, float], IResolvable] = None,
  snapshot_id: typing.Union[str, IResolvable] = None,
  storage_set_id: typing.Union[str, IResolvable] = None,
  storage_set_partition_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

auto_snapshot_policy_id^Optional

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

Property autoSnapshotPolicyId: Auto snapshot policy ID.

bursting_enabled^Optional

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

Property burstingEnabled: Whether enable bursting.

delete_auto_snapshot^Optional

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

Property deleteAutoSnapshot: Whether the auto snapshot is released with the disk.

Default to false.

description^Optional

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

Property description: Description of the disk, [2, 256] characters.

Do not fill or empty, the default is empty.

disk_category^Optional

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

Property diskCategory: The disk category, now support cloud\/cloud_ssd\/cloud_essd\/cloud_efficiency\/san_ssd\/san_efficiency\/cloud_auto\/cloud_essd_entry\/cloud_regional_disk_auto\/elastic_ephemeral_disk_standard\/elastic_ephemeral_disk_premium, depends the region.

disk_name^Optional

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

Property diskName: Display name of the disk, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, '_' or '.', '-'.

encrypted^Optional

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

Property encrypted: Whether disk is encrypted, default to false.

instance_id^Optional

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

Property instanceId: Create a cloud disk and automatically mount it to the specified InstanceId.

• Once the instance ID is set, the ResourceGroupId, Tags, and KMSKeyId parameters you set are ignored.
• You cannot specify both ZoneId and InstanceId. Default value: null, meaning that a pay-as-you-go cloud drive is created, and the region of the drive is defined by the RegionId and ZoneId.

kms_key_id^Optional

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

Property kmsKeyId: KMS key ID used by the cloud disk.

multi_attach^Optional

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

Property multiAttach: Specifies whether to enable the multi-attach feature for the disk.

Valid values: Disabled: disables the multi-attach feature. Enabled: enables the multi-attach feature. Set the value to Enabled only for ESSDs. Default value: Disabled.

performance_level^Optional

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

Property performanceLevel: The performance level you select for an ESSD.Default value: PL1. Valid values:PL0: A single enhanced SSD delivers up to 10,000 random read\/write IOPS.PL1: A single enhanced SSD delivers up to 50,000 random read\/write IOPS.PL2: A single enhanced SSD delivers up to 100,000 random read\/write IOPS.PL3: A single enhanced SSD delivers up to 1,000,000 random read\/write IOPS.

provisioned_iops^Optional

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

Property provisionedIops: Provisioning IOPS.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

size^Optional

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

Property size: The size of the disk unit in GB.

snapshot_id^Optional

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

Property snapshotId: If specified, the backup used as the source to create disk.

storage_set_id^Optional

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

Property storageSetId: Storage set ID.

storage_set_partition_number^Optional

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

Property storageSetPartitionNumber: The number of storage set partitions.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to disk.

Max support 20 tags to add during create disk. Each tag with two properties Key and Value, and Key is required.

zone_id^Optional

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

Property zoneId: Create a pay-as-you-go cloud drive within the specified availability area.

• If you do not set InstanceId, ZoneId is required.
• You cannot specify both ZoneId and InstanceId.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_ecs
ros_cdk_ecs.Disk.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_disk_id^Required

attr_disk_id: typing.Union[str, IResolvable]

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

Attribute DiskId: Id of created disk.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

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

Attribute Status: Created disk status.

props^Required

props: DiskProps

• Type: DiskProps