Skip to content

DiskProps

Properties for defining a Disk.

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

Initializer 

import { DiskProps } from '@alicloud/ros-cdk-ecs'
const diskProps: DiskProps = { ... }

Properties

Name Type Description
autoSnapshotPolicyId string | @alicloud/ros-cdk-core.IResolvable Property autoSnapshotPolicyId: Auto snapshot policy ID.
burstingEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property burstingEnabled: Whether enable bursting.
deleteAutoSnapshot boolean | @alicloud/ros-cdk-core.IResolvable Property deleteAutoSnapshot: Whether the auto snapshot is released with the disk.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the disk, [2, 256] characters.
diskCategory string | @alicloud/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.
diskName string | @alicloud/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 boolean | @alicloud/ros-cdk-core.IResolvable Property encrypted: Whether disk is encrypted, default to false.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: Create a cloud disk and automatically mount it to the specified InstanceId.
kmsKeyId string | @alicloud/ros-cdk-core.IResolvable Property kmsKeyId: KMS key ID used by the cloud disk.
multiAttach string | @alicloud/ros-cdk-core.IResolvable Property multiAttach: Specifies whether to enable the multi-attach feature for the disk.
performanceLevel string | @alicloud/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.
provisionedIops number | @alicloud/ros-cdk-core.IResolvable Property provisionedIops: Provisioning IOPS.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
size number | @alicloud/ros-cdk-core.IResolvable Property size: The size of the disk unit in GB.
snapshotId string | @alicloud/ros-cdk-core.IResolvable Property snapshotId: If specified, the backup used as the source to create disk.
storageSetId string | @alicloud/ros-cdk-core.IResolvable Property storageSetId: Storage set ID.
storageSetPartitionNumber number | @alicloud/ros-cdk-core.IResolvable Property storageSetPartitionNumber: The number of storage set partitions.
tags TagsProperty[] Property tags: Tags to attach to disk.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: Create a pay-as-you-go cloud drive within the specified availability area.

autoSnapshotPolicyIdOptional 

public readonly autoSnapshotPolicyId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property autoSnapshotPolicyId: Auto snapshot policy ID.

burstingEnabledOptional 

public readonly burstingEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property burstingEnabled: Whether enable bursting.

deleteAutoSnapshotOptional 

public readonly deleteAutoSnapshot: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

Default to false.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Do not fill or empty, the default is empty.

diskCategoryOptional 

public readonly diskCategory: string | IResolvable;
  • Type: string | @alicloud/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.

diskNameOptional 

public readonly diskName: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly encrypted: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

instanceIdOptional 

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/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.

kmsKeyIdOptional 

public readonly kmsKeyId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

multiAttachOptional 

public readonly multiAttach: string | IResolvable;
  • Type: string | @alicloud/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.

performanceLevelOptional 

public readonly performanceLevel: string | IResolvable;
  • Type: string | @alicloud/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.

provisionedIopsOptional 

public readonly provisionedIops: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property provisionedIops: Provisioning IOPS.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

sizeOptional 

public readonly size: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

snapshotIdOptional 

public readonly snapshotId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

storageSetIdOptional 

public readonly storageSetId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property storageSetId: Storage set ID.

storageSetPartitionNumberOptional 

public readonly storageSetPartitionNumber: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property storageSetPartitionNumber: The number of storage set partitions.

tagsOptional 

public readonly tags: 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.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/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.