Skip to content

Disk

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

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
auto_snapshot_policy_id typing.Union[str, ros_cdk_core.IResolvable] Property autoSnapshotPolicyId: Auto snapshot policy ID.
bursting_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property burstingEnabled: Whether enable bursting.
delete_auto_snapshot typing.Union[bool, ros_cdk_core.IResolvable] Property deleteAutoSnapshot: Whether the auto snapshot is released with the disk.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of the disk, [2, 256] characters.
disk_category 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, depends the region.
disk_name 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 typing.Union[bool, ros_cdk_core.IResolvable] Property encrypted: Whether disk is encrypted, default to false.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: Create a cloud disk and automatically mount it to the specified InstanceId.
kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property kmsKeyId: KMS key ID used by the cloud disk.
multi_attach typing.Union[str, ros_cdk_core.IResolvable] Property multiAttach: Specifies whether to enable the multi-attach feature for the disk.
performance_level 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 typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property provisionedIops: Provisioning IOPS.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property size: The size of the disk unit in GB.
snapshot_id typing.Union[str, ros_cdk_core.IResolvable] Property snapshotId: If specified, the backup used as the source to create disk.
storage_set_id typing.Union[str, ros_cdk_core.IResolvable] Property storageSetId: Storage set ID.
storage_set_partition_number typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property storageSetPartitionNumber: The number of storage set partitions.
tags typing.List[TagsProperty] Property tags: Tags to attach to disk.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: Create a pay-as-you-go cloud drive within the specified availability area.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

auto_snapshot_policy_idOptional

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

Property autoSnapshotPolicyId: Auto snapshot policy ID.

bursting_enabledOptional

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

Property burstingEnabled: Whether enable bursting.

delete_auto_snapshotOptional

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

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

Default to false.

descriptionOptional

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

  • 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, depends the region.

disk_nameOptional

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

encryptedOptional

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

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

instance_idOptional

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

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

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

multi_attachOptional

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

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

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

Property provisionedIops: Provisioning IOPS.

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

sizeOptional

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

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

snapshot_idOptional

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

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

storage_set_idOptional

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

Property storageSetId: Storage set ID.

storage_set_partition_numberOptional

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

Property storageSetPartitionNumber: The number of storage set partitions.

tagsOptional

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_idOptional

  • 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_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_ecs
ros_cdk_ecs.Disk.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_disk_id ros_cdk_core.IResolvable Attribute DiskId: Id of created disk.
attr_status ros_cdk_core.IResolvable Attribute Status: Created disk status.

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_disk_idRequired 

attr_disk_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DiskId: Id of created disk.

attr_statusRequired 

attr_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Status: Created disk status.