Skip to content

DiskProps

Properties for defining a Disk.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-disk

Initializer 

import ros_cdk_ecs
ros_cdk_ecs.DiskProps(
  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
)

Properties

Name Type 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.

auto_snapshot_policy_idOptional 

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

Property autoSnapshotPolicyId: Auto snapshot policy ID.

bursting_enabledOptional 

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

Property burstingEnabled: Whether enable bursting.

delete_auto_snapshotOptional 

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

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

Default to false.

descriptionOptional 

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

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

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

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

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

instance_idOptional 

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

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

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

multi_attachOptional 

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

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

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

Property provisionedIops: Provisioning IOPS.

resource_group_idOptional 

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

Property resourceGroupId: Resource group id.

sizeOptional 

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

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

snapshot_idOptional 

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

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

storage_set_idOptional 

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

Property storageSetId: Storage set ID.

storage_set_partition_numberOptional 

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

Property storageSetPartitionNumber: The number of storage set partitions.

tagsOptional 

tags: 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_idOptional 

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