Disk

• Implements: com.aliyun.ros.cdk.ecs.datasource.IDisk

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Disk.

Initializers

import com.aliyun.ros.cdk.ecs.datasource.Disk;
Disk.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .diskId(java.lang.String)
    .diskId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

diskId^Required

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

Property diskId: The disk id.

refreshOptions^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.ecs.datasource.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

attrAttachedTime^Required

public java.lang.Object getAttrAttachedTime();

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

Attribute AttachedTime: The attached time.

attrAutoSnapshotPolicyId^Required

public java.lang.Object getAttrAutoSnapshotPolicyId();

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

Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.

attrBurstingEnabled^Required

public java.lang.Object getAttrBurstingEnabled();

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

Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst).

attrCategory^Required

public java.lang.Object getAttrCategory();

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

Attribute Category: Disk type.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The creation time.

attrDeleteAutoSnapshot^Required

public java.lang.Object getAttrDeleteAutoSnapshot();

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

Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time.

attrDeleteWithInstance^Required

public java.lang.Object getAttrDeleteWithInstance();

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

Attribute DeleteWithInstance: Whether to release with the instance.

attrDescription^Required

public java.lang.Object getAttrDescription();

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

Attribute Description: The description.

attrDetachedTime^Required

public java.lang.Object getAttrDetachedTime();

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

Attribute DetachedTime: Unloading time.

attrDevice^Required

public java.lang.Object getAttrDevice();

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

Attribute Device: Cloud disk or the device name of the mounted instance on the site.

attrDiskId^Required

public java.lang.Object getAttrDiskId();

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

Attribute DiskId: The disk id.

attrDiskName^Required

public java.lang.Object getAttrDiskName();

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

Attribute DiskName: The disk name.

attrEnableAutomatedSnapshotPolicy^Required

public java.lang.Object getAttrEnableAutomatedSnapshotPolicy();

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

Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy.

attrEnableAutoSnapshot^Required

public java.lang.Object getAttrEnableAutoSnapshot();

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

Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy.

attrEncrypted^Required

public java.lang.Object getAttrEncrypted();

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

Attribute Encrypted: Whether the disk is encrypted.

attrExpiredTime^Required

public java.lang.Object getAttrExpiredTime();

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

Attribute ExpiredTime: The expiration time of a monthly disk.

attrImageId^Required

public java.lang.Object getAttrImageId();

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

Attribute ImageId: The image id.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: The instance id.

attrIops^Required

public java.lang.Object getAttrIops();

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

Attribute Iops: Number of read/write (I/O) operations per second.

attrIopsRead^Required

public java.lang.Object getAttrIopsRead();

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

Attribute IopsRead: Number of reads per second.

attrIopsWrite^Required

public java.lang.Object getAttrIopsWrite();

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

Attribute IopsWrite: Number of writes per second.

attrKmsKeyId^Required

public java.lang.Object getAttrKmsKeyId();

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

Attribute KmsKeyId: The KMS keyId.

attrMountInstanceNum^Required

public java.lang.Object getAttrMountInstanceNum();

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

Attribute MountInstanceNum: Number of instances mounted on shared storage.

attrMountInstances^Required

public java.lang.Object getAttrMountInstances();

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

Attribute MountInstances: Disk mount instances.

attrMultiAttach^Required

public java.lang.Object getAttrMultiAttach();

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

Attribute MultiAttach: Whether to enable the multi-Mount feature.

attrOperationLocks^Required

public java.lang.Object getAttrOperationLocks();

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

Attribute OperationLocks: Resource locking information.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: Payment method for disk.

attrPerformanceLevel^Required

public java.lang.Object getAttrPerformanceLevel();

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

Attribute PerformanceLevel: Performance levels of ESSD cloud disk.

attrPortable^Required

public java.lang.Object getAttrPortable();

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

Attribute Portable: Whether the disk is unmountable.

attrProductCode^Required

public java.lang.Object getAttrProductCode();

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

Attribute ProductCode: The product logo of the cloud market.

attrProvisionedIops^Required

public java.lang.Object getAttrProvisionedIops();

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

Attribute ProvisionedIops: The preconfigured read and write IOPS of the ESSD AutoPL cloud disk.

Possible values: 0 ~ min{50,000, 1000 * capacity-baseline performance}.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

Attribute ResourceGroupId: The resource group id.

attrSize^Required

public java.lang.Object getAttrSize();

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

Attribute Size: Disk size.

attrSnapshotId^Required

public java.lang.Object getAttrSnapshotId();

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

Attribute SnapshotId: The source snapshot id.

attrStorageClusterId^Required

public java.lang.Object getAttrStorageClusterId();

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

Attribute StorageClusterId: The ID of the dedicated block storage cluster.

If you need to create a cloud disk in the specified dedicated block storage cluster, specify this parameter.

attrStorageSetId^Required

public java.lang.Object getAttrStorageSetId();

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

Attribute StorageSetId: The ID of the Save set.

attrStorageSetPartitionNumber^Required

public java.lang.Object getAttrStorageSetPartitionNumber();

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

Attribute StorageSetPartitionNumber: Number of Save set partitions.

Value range: greater than or equal to 2. The maximum value cannot exceed the equity quota limit displayed after calling.

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: The tags.

attrZoneId^Required

public java.lang.Object getAttrZoneId();

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

Attribute ZoneId: ID of the free zone to which the disk belongs.

props^Required

public DiskProps getProps();

• Type: DiskProps