Skip to content

DiskAttachment

This class encapsulates and extends the ROS resource type ALIYUN::ECS::DiskAttachment, which is used to attach a disk to an ECS instance.

Initializers 

import com.aliyun.ros.cdk.ecs.DiskAttachment;
DiskAttachment.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .diskId(java.lang.String)
    .diskId(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
//  .deleteAutoSnapshot(java.lang.Boolean)
//  .deleteAutoSnapshot(IResolvable)
//  .deleteWithInstance(java.lang.Boolean)
//  .deleteWithInstance(IResolvable)
//  .device(java.lang.String)
//  .device(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 to attached.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The instanceId to attach the disk.
deleteAutoSnapshot java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deleteAutoSnapshot: Whether the auto snapshot is released with the disk.
deleteWithInstance java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property deleteWithInstance: If property is true, the disk will be deleted while instance is deleted, if property is false, the disk will be retain after instance is deleted.
device java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property device: The device where the volume is exposed on the instance.

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

instanceIdRequired

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

Property instanceId: The instanceId to attach the disk.

deleteAutoSnapshotOptional

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

Property deleteAutoSnapshot: Whether the auto snapshot is released with the disk.

Default to true.

deleteWithInstanceOptional

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

Property deleteWithInstance: If property is true, the disk will be deleted while instance is deleted, if property is false, the disk will be retain after instance is deleted.

deviceOptional

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

Property device: The device where the volume is exposed on the instance.

could be /dev/xvd[b-z]. If not specification, will use default value.

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.DiskAttachment;
DiskAttachment.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.
attrDevice com.aliyun.ros.cdk.core.IResolvable Attribute Device: The device where the volume is exposed on ecs instance.
attrDiskId com.aliyun.ros.cdk.core.IResolvable Attribute DiskId: The disk id of created disk.
attrStatus com.aliyun.ros.cdk.core.IResolvable Attribute Status: The disk status now.

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

attrDeviceRequired 

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

Attribute Device: The device where the volume is exposed on ecs instance.

attrDiskIdRequired 

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

Attribute DiskId: The disk id of created disk.

attrStatusRequired 

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

Attribute Status: The disk status now.