Skip to content

DiskProps

Properties for defining a Disk.

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

Initializer 

import com.aliyun.ros.cdk.ecs.DiskProps;
DiskProps.builder()
//  .autoSnapshotPolicyId(java.lang.String)
//  .autoSnapshotPolicyId(IResolvable)
//  .burstingEnabled(java.lang.Boolean)
//  .burstingEnabled(IResolvable)
//  .deleteAutoSnapshot(java.lang.Boolean)
//  .deleteAutoSnapshot(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskCategory(java.lang.String)
//  .diskCategory(IResolvable)
//  .diskName(java.lang.String)
//  .diskName(IResolvable)
//  .encrypted(java.lang.Boolean)
//  .encrypted(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .multiAttach(java.lang.String)
//  .multiAttach(IResolvable)
//  .performanceLevel(java.lang.String)
//  .performanceLevel(IResolvable)
//  .provisionedIops(java.lang.Number)
//  .provisionedIops(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .size(java.lang.Number)
//  .size(IResolvable)
//  .snapshotId(java.lang.String)
//  .snapshotId(IResolvable)
//  .storageSetId(java.lang.String)
//  .storageSetId(IResolvable)
//  .storageSetPartitionNumber(java.lang.Number)
//  .storageSetPartitionNumber(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

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

autoSnapshotPolicyIdOptional 

public java.lang.Object getAutoSnapshotPolicyId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property autoSnapshotPolicyId: Auto snapshot policy ID.

burstingEnabledOptional 

public java.lang.Object getBurstingEnabled();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property burstingEnabled: Whether enable bursting.

deleteAutoSnapshotOptional 

public java.lang.Object getDeleteAutoSnapshot();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Default to false.

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Do not fill or empty, the default is empty.

diskCategoryOptional 

public java.lang.Object getDiskCategory();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDiskName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getEncrypted();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

instanceIdOptional 

public java.lang.Object getInstanceId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getKmsKeyId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

multiAttachOptional 

public java.lang.Object getMultiAttach();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPerformanceLevel();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getProvisionedIops();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property provisionedIops: Provisioning IOPS.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

sizeOptional 

public java.lang.Object getSize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

snapshotIdOptional 

public java.lang.Object getSnapshotId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

storageSetIdOptional 

public java.lang.Object getStorageSetId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property storageSetId: Storage set ID.

storageSetPartitionNumberOptional 

public java.lang.Object getStorageSetPartitionNumber();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property storageSetPartitionNumber: The number of storage set partitions.

tagsOptional 

public java.util.List<TagsProperty> getTags();

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 java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.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.