Disk

• Implements: IDisk

This class encapsulates and extends the ROS resource type ALIYUN::ENS::Disk.

Initializers

import com.aliyun.ros.cdk.ens.Disk;
Disk.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .category(java.lang.String)
    .category(IResolvable)
    .ensRegionId(java.lang.String)
    .ensRegionId(IResolvable)
    .instanceChargeType(java.lang.String)
    .instanceChargeType(IResolvable)
    .size(java.lang.String)
    .size(IResolvable)
//  .diskName(java.lang.String)
//  .diskName(IResolvable)
//  .encrypted(java.lang.Boolean)
//  .encrypted(IResolvable)
//  .instanceBillingCycle(java.lang.String)
//  .instanceBillingCycle(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .snapshotId(java.lang.String)
//  .snapshotId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

category^Required

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

Property category: The category of the disk.

Valid values: cloud_efficiency: ultra disk. cloud_ssd: all-flash disk.

ensRegionId^Required

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

Property ensRegionId: The ID of the edge node.

instanceChargeType^Required

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

Property instanceChargeType: The billing method of the instance.

Set the value to PostPaid.

size^Required

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

Property size: The size of the disk.

Unit: GiB.

diskName^Optional

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

Property diskName: The name of the disk.

encrypted^Optional

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

Property encrypted: Specifies whether to encrypt the disk.

Valid values:

• true
• false (default)

instanceBillingCycle^Optional

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

Property instanceBillingCycle: The billing cycle of the instance.

kmsKeyId^Optional

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

Property kmsKeyId: The ID of the Key Management Service (KMS) key that is used by the cloud disk.

Note If you set the Encrypted parameter to true, the default service key is used when the KMSKeyId parameter is empty.

snapshotId^Optional

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

Property snapshotId: The ID of the snapshot that you want to use to create the disk.

The following limits apply to the SnapshotId and Size parameters: If the size of the snapshot specified by SnapshotId is greater than the specified Size value, the size of the created disk is equal to the specified snapshot size. If the size of the snapshot specified by SnapshotId is smaller than the specified Size value, the size of the created disk is equal to the specified Size value.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ens.Disk;
Disk.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrDiskId^Required

public java.lang.Object getAttrDiskId();

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

Attribute DiskId: The ID of the instance.

props^Required

public DiskProps getProps();

• Type: DiskProps