Skip to content

CloneDisks

This class encapsulates and extends the ROS resource type ALIYUN::ECS::CloneDisks.

Initializers

import com.aliyun.ros.cdk.ecs.CloneDisks;
CloneDisks.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .diskCategory(java.lang.String)
    .diskCategory(IResolvable)
    .multiAttach(java.lang.String)
    .multiAttach(IResolvable)
    .size(java.lang.Number)
    .size(IResolvable)
    .sourceDiskId(java.lang.String)
    .sourceDiskId(IResolvable)
//  .burstingEnabled(java.lang.Boolean)
//  .burstingEnabled(IResolvable)
//  .diskName(java.lang.String)
//  .diskName(IResolvable)
//  .encrypted(java.lang.Boolean)
//  .encrypted(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .performanceLevel(java.lang.String)
//  .performanceLevel(IResolvable)
//  .provisionedIops(java.lang.Number)
//  .provisionedIops(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
diskCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property diskCategory: The type of the new disk.
multiAttach java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property multiAttach: Specifies whether to enable the multi-attach feature for the new disk.
size java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property size: The size of the new disk, in GiB.
sourceDiskId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceDiskId: The ID of the source disk.
burstingEnabled java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property burstingEnabled: Specifies whether to enable performance bursting for the new disk.
diskName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property diskName: The name of the new disk.
encrypted java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property encrypted: Specifies whether to encrypt the new disk.
kmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property kmsKeyId: The ID of the KMS key used to encrypt the disk.
performanceLevel java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property performanceLevel: The performance level of the new ESSD cloud disk.
provisionedIops java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to disk.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

diskCategoryRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property diskCategory: The type of the new disk.

Valid values:

  • cloud_essd: ESSD cloud disk.
  • cloud_auto: ESSD AutoPL cloud disk.
  • cloud_essd_entry: ESSD Entry cloud disk.
  • cloud_regional_disk_auto: regional disk.

Disk type limits for cloning

  • A non-regional disk can be cloned only as a non-regional disk.
  • A regional disk can be cloned only as a regional disk.

multiAttachRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

  • Disabled: Disables the multi-attach feature.
  • Enabled: Enables the multi-attach feature. You can set this parameter to Enabled only for ESSD cloud disks.

sizeRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property size: The size of the new disk, in GiB.

The value must be greater than or equal to the size of the source disk. The value range varies based on the DiskCategory value:

  • cloud_essd: The value range depends on the PerformanceLevel value.
  • PL0: 1 to 65,536
  • PL1: 20 to 65,536
  • PL2: 461 to 65,536
  • PL3: 1,261 to 65,536
  • cloud_auto: 1 to 65,536
  • cloud_essd_entry: 10 to 32,768
  • cloud_regional_disk_auto: 10 to 65,536

sourceDiskIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceDiskId: The ID of the source disk.


burstingEnabledOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property burstingEnabled: Specifies whether to enable performance bursting for the new disk.

Valid values:

  • true: Enables performance bursting.
  • false: Disables performance bursting.

This parameter is valid only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL cloud disks.


diskNameOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property diskName: The name of the new disk.

The name must be 2 to 128 characters in length. It must start with a letter and can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). Default value: none.


encryptedOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property encrypted: Specifies whether to encrypt the new disk.

Valid values:

  • true: The disk is encrypted.
  • false: The disk is not encrypted. Default value: false.

kmsKeyIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property kmsKeyId: The ID of the KMS key used to encrypt the disk.


performanceLevelOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property performanceLevel: The performance level of the new ESSD cloud disk.

Valid values:

  • PL0: A single disk can deliver up to 10,000 random read/write IOPS.
  • PL1: A single disk can deliver up to 50,000 random read/write IOPS.
  • PL2: A single disk can deliver up to 100,000 random read/write IOPS.
  • PL3: A single disk can deliver up to 1,000,000 random read/write IOPS.

This parameter is required when DiskCategory is set to cloud_essd.


provisionedIopsOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property provisionedIops: The provisioned read\/write IOPS of the ESSD AutoPL cloud disk.

Valid values:

  • You cannot set this parameter for disks that are 3 GiB or smaller in size.
  • For disks that are 4 GiB or larger in size, the value must be in the range of [0, min(1000 * Size - baseline performance, 50000)]. baseline performance = max(min(1800 + 50 * Size, 50000), 3000).

This parameter is valid only when DiskCategory is set to cloud_auto. For more information, see ESSD AutoPL cloud disks.


resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.


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.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.ecs.CloneDisks;
CloneDisks.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrDiskIds java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DiskIds: The IDS of the disk.
props CloneDisksProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrDiskIdsRequired

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

Attribute DiskIds: The IDS of the disk.


propsRequired

public CloneDisksProps getProps();