Skip to content

Disk

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();
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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

diskIdRequired

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

Property diskId: The disk id.

refreshOptionsOptional

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

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

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.datasource.Disk;
Disk.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.
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.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrAttachedTimeRequired 

public IResolvable getAttrAttachedTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AttachedTime: The attached time.

attrAutoSnapshotPolicyIdRequired 

public IResolvable getAttrAutoSnapshotPolicyId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AutoSnapshotPolicyId: Automatic snapshot policy ID.

attrBurstingEnabledRequired 

public IResolvable getAttrBurstingEnabled();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrCategoryRequired 

public IResolvable getAttrCategory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Category: Disk type.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time.

attrDeleteAutoSnapshotRequired 

public IResolvable getAttrDeleteAutoSnapshot();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDeleteWithInstanceRequired 

public IResolvable getAttrDeleteWithInstance();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DeleteWithInstance: Whether to release with the instance.

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description.

attrDetachedTimeRequired 

public IResolvable getAttrDetachedTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DetachedTime: Unloading time.

attrDeviceRequired 

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.

attrDiskIdRequired 

public IResolvable getAttrDiskId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DiskId: The disk id.

attrDiskNameRequired 

public IResolvable getAttrDiskName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DiskName: The disk name.

attrEnableAutomatedSnapshotPolicyRequired 

public IResolvable getAttrEnableAutomatedSnapshotPolicy();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrEnableAutoSnapshotRequired 

public IResolvable getAttrEnableAutoSnapshot();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrEncryptedRequired 

public IResolvable getAttrEncrypted();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Encrypted: Whether the disk is encrypted.

attrExpiredTimeRequired 

public IResolvable getAttrExpiredTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExpiredTime: The expiration time of a monthly disk.

attrImageIdRequired 

public IResolvable getAttrImageId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ImageId: The image id.

attrInstanceIdRequired 

public IResolvable getAttrInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The instance id.

attrIopsRequired 

public IResolvable getAttrIops();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrIopsReadRequired 

public IResolvable getAttrIopsRead();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IopsRead: Number of reads per second.

attrIopsWriteRequired 

public IResolvable getAttrIopsWrite();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IopsWrite: Number of writes per second.

attrKmsKeyIdRequired 

public IResolvable getAttrKmsKeyId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute KmsKeyId: The KMS keyId.

attrMountInstanceNumRequired 

public IResolvable getAttrMountInstanceNum();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MountInstanceNum: Number of instances mounted on shared storage.

attrMountInstancesRequired 

public IResolvable getAttrMountInstances();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MountInstances: Disk mount instances.

attrMultiAttachRequired 

public IResolvable getAttrMultiAttach();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrOperationLocksRequired 

public IResolvable getAttrOperationLocks();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OperationLocks: Resource locking information.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: Payment method for disk.

attrPerformanceLevelRequired 

public IResolvable getAttrPerformanceLevel();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PerformanceLevel: Performance levels of ESSD cloud disk.

attrPortableRequired 

public IResolvable getAttrPortable();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Portable: Whether the disk is unmountable.

attrProductCodeRequired 

public IResolvable getAttrProductCode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProductCode: The product logo of the cloud market.

attrProvisionedIopsRequired 

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

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The resource group id.

attrSizeRequired 

public IResolvable getAttrSize();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Size: Disk size.

attrSnapshotIdRequired 

public IResolvable getAttrSnapshotId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SnapshotId: The source snapshot id.

attrStorageClusterIdRequired 

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.

attrStorageSetIdRequired 

public IResolvable getAttrStorageSetId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StorageSetId: The ID of the Save set.

attrStorageSetPartitionNumberRequired 

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.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags.

attrZoneIdRequired 

public IResolvable getAttrZoneId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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