Disk

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Disk, which is used to query the information about a cloud 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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
diskId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property diskId: The disk id.
refreshOptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

---

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

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

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

---

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

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

---

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

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
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.
attrAttachedTime	com.aliyun.ros.cdk.core.IResolvable	Attribute AttachedTime: The attached time.
attrAutoSnapshotPolicyId	com.aliyun.ros.cdk.core.IResolvable	Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.
attrBurstingEnabled	com.aliyun.ros.cdk.core.IResolvable	Attribute BurstingEnabled: Does the data disk turn on Burst (performance Burst).
attrCategory	com.aliyun.ros.cdk.core.IResolvable	Attribute Category: Disk type.
attrCreateTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreateTime: The creation time.
attrDeleteAutoSnapshot	com.aliyun.ros.cdk.core.IResolvable	Attribute DeleteAutoSnapshot: Whether to delete automatic snapshots at the same time.
attrDeleteWithInstance	com.aliyun.ros.cdk.core.IResolvable	Attribute DeleteWithInstance: Whether to release with the instance.
attrDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute Description: The description.
attrDetachedTime	com.aliyun.ros.cdk.core.IResolvable	Attribute DetachedTime: Unloading time.
attrDevice	com.aliyun.ros.cdk.core.IResolvable	Attribute Device: Cloud disk or the device name of the mounted instance on the site.
attrDiskId	com.aliyun.ros.cdk.core.IResolvable	Attribute DiskId: The disk id.
attrDiskName	com.aliyun.ros.cdk.core.IResolvable	Attribute DiskName: The disk name.
attrEnableAutomatedSnapshotPolicy	com.aliyun.ros.cdk.core.IResolvable	Attribute EnableAutomatedSnapshotPolicy: Whether the disk implements an automatic snapshot policy.
attrEnableAutoSnapshot	com.aliyun.ros.cdk.core.IResolvable	Attribute EnableAutoSnapshot: Whether the disk implements an automatic snapshot policy.
attrEncrypted	com.aliyun.ros.cdk.core.IResolvable	Attribute Encrypted: Whether the disk is encrypted.
attrExpiredTime	com.aliyun.ros.cdk.core.IResolvable	Attribute ExpiredTime: The expiration time of a monthly disk.
attrImageId	com.aliyun.ros.cdk.core.IResolvable	Attribute ImageId: The image id.
attrInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceId: The instance id.
attrIops	com.aliyun.ros.cdk.core.IResolvable	Attribute Iops: Number of read/write (I/O) operations per second.
attrIopsRead	com.aliyun.ros.cdk.core.IResolvable	Attribute IopsRead: Number of reads per second.
attrIopsWrite	com.aliyun.ros.cdk.core.IResolvable	Attribute IopsWrite: Number of writes per second.
attrKmsKeyId	com.aliyun.ros.cdk.core.IResolvable	Attribute KmsKeyId: The KMS keyId.
attrMountInstanceNum	com.aliyun.ros.cdk.core.IResolvable	Attribute MountInstanceNum: Number of instances mounted on shared storage.
attrMountInstances	com.aliyun.ros.cdk.core.IResolvable	Attribute MountInstances: Disk mount instances.
attrMultiAttach	com.aliyun.ros.cdk.core.IResolvable	Attribute MultiAttach: Whether to enable the multi-Mount feature.
attrOperationLocks	com.aliyun.ros.cdk.core.IResolvable	Attribute OperationLocks: Resource locking information.
attrPaymentType	com.aliyun.ros.cdk.core.IResolvable	Attribute PaymentType: Payment method for disk.
attrPerformanceLevel	com.aliyun.ros.cdk.core.IResolvable	Attribute PerformanceLevel: Performance levels of ESSD cloud disk.
attrPortable	com.aliyun.ros.cdk.core.IResolvable	Attribute Portable: Whether the disk is unmountable.
attrProductCode	com.aliyun.ros.cdk.core.IResolvable	Attribute ProductCode: The product logo of the cloud market.
attrProvisionedIops	com.aliyun.ros.cdk.core.IResolvable	Attribute ProvisionedIops: The preconfigured read and write IOPS of the ESSD AutoPL cloud disk.
attrResourceGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute ResourceGroupId: The resource group id.
attrSize	com.aliyun.ros.cdk.core.IResolvable	Attribute Size: Disk size.
attrSnapshotId	com.aliyun.ros.cdk.core.IResolvable	Attribute SnapshotId: The source snapshot id.
attrStorageClusterId	com.aliyun.ros.cdk.core.IResolvable	Attribute StorageClusterId: The ID of the dedicated block storage cluster.
attrStorageSetId	com.aliyun.ros.cdk.core.IResolvable	Attribute StorageSetId: The ID of the Save set.
attrStorageSetPartitionNumber	com.aliyun.ros.cdk.core.IResolvable	Attribute StorageSetPartitionNumber: Number of Save set partitions.
attrTags	com.aliyun.ros.cdk.core.IResolvable	Attribute Tags: The tags.
attrZoneId	com.aliyun.ros.cdk.core.IResolvable	Attribute ZoneId: ID of the free zone to which the disk belongs.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

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 IResolvable getAttrAttachedTime();

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

Attribute AttachedTime: The attached time.

---

attrAutoSnapshotPolicyId^Required

public IResolvable getAttrAutoSnapshotPolicyId();

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

Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.

---

attrBurstingEnabled^Required

public IResolvable getAttrBurstingEnabled();

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

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

---

attrCategory^Required

public IResolvable getAttrCategory();

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

Attribute Category: Disk type.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The creation time.

---

attrDeleteAutoSnapshot^Required

public IResolvable getAttrDeleteAutoSnapshot();

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

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

---

attrDeleteWithInstance^Required

public IResolvable getAttrDeleteWithInstance();

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

Attribute DeleteWithInstance: Whether to release with the instance.

---

attrDescription^Required

public IResolvable getAttrDescription();

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

Attribute Description: The description.

---

attrDetachedTime^Required

public IResolvable getAttrDetachedTime();

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

Attribute DetachedTime: Unloading time.

---

attrDevice^Required

public IResolvable getAttrDevice();

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

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

---

attrDiskId^Required

public IResolvable getAttrDiskId();

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

Attribute DiskId: The disk id.

---

attrDiskName^Required

public IResolvable getAttrDiskName();

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

Attribute DiskName: The disk name.

---

attrEnableAutomatedSnapshotPolicy^Required

public IResolvable getAttrEnableAutomatedSnapshotPolicy();

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

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

---

attrEnableAutoSnapshot^Required

public IResolvable getAttrEnableAutoSnapshot();

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

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

---

attrEncrypted^Required

public IResolvable getAttrEncrypted();

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

Attribute Encrypted: Whether the disk is encrypted.

---

attrExpiredTime^Required

public IResolvable getAttrExpiredTime();

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

Attribute ExpiredTime: The expiration time of a monthly disk.

---

attrImageId^Required

public IResolvable getAttrImageId();

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

Attribute ImageId: The image id.

---

attrInstanceId^Required

public IResolvable getAttrInstanceId();

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

Attribute InstanceId: The instance id.

---

attrIops^Required

public IResolvable getAttrIops();

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

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

---

attrIopsRead^Required

public IResolvable getAttrIopsRead();

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

Attribute IopsRead: Number of reads per second.

---

attrIopsWrite^Required

public IResolvable getAttrIopsWrite();

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

Attribute IopsWrite: Number of writes per second.

---

attrKmsKeyId^Required

public IResolvable getAttrKmsKeyId();

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

Attribute KmsKeyId: The KMS keyId.

---

attrMountInstanceNum^Required

public IResolvable getAttrMountInstanceNum();

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

Attribute MountInstanceNum: Number of instances mounted on shared storage.

---

attrMountInstances^Required

public IResolvable getAttrMountInstances();

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

Attribute MountInstances: Disk mount instances.

---

attrMultiAttach^Required

public IResolvable getAttrMultiAttach();

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

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

---

attrOperationLocks^Required

public IResolvable getAttrOperationLocks();

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

Attribute OperationLocks: Resource locking information.

---

attrPaymentType^Required

public IResolvable getAttrPaymentType();

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

Attribute PaymentType: Payment method for disk.

---

attrPerformanceLevel^Required

public IResolvable getAttrPerformanceLevel();

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

Attribute PerformanceLevel: Performance levels of ESSD cloud disk.

---

attrPortable^Required

public IResolvable getAttrPortable();

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

Attribute Portable: Whether the disk is unmountable.

---

attrProductCode^Required

public IResolvable getAttrProductCode();

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

Attribute ProductCode: The product logo of the cloud market.

---

attrProvisionedIops^Required

public IResolvable getAttrProvisionedIops();

• Type: 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 IResolvable getAttrResourceGroupId();

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

Attribute ResourceGroupId: The resource group id.

---

attrSize^Required

public IResolvable getAttrSize();

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

Attribute Size: Disk size.

---

attrSnapshotId^Required

public IResolvable getAttrSnapshotId();

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

Attribute SnapshotId: The source snapshot id.

---

attrStorageClusterId^Required

public IResolvable getAttrStorageClusterId();

• Type: 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 IResolvable getAttrStorageSetId();

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

Attribute StorageSetId: The ID of the Save set.

---

attrStorageSetPartitionNumber^Required

public IResolvable getAttrStorageSetPartitionNumber();

• Type: 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 IResolvable getAttrTags();

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

Attribute Tags: The tags.

---

attrZoneId^Required

public IResolvable getAttrZoneId();

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

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

---