Skip to content

DiskAttachment

This class encapsulates and extends the ROS resource type ALIYUN::ECS::DiskAttachment.

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)
//  .bootable(java.lang.Boolean)
//  .bootable(IResolvable)
//  .deleteAutoSnapshot(java.lang.Boolean)
//  .deleteAutoSnapshot(IResolvable)
//  .deleteWithInstance(java.lang.Boolean)
//  .deleteWithInstance(IResolvable)
//  .device(java.lang.String)
//  .device(IResolvable)
//  .force(java.lang.Boolean)
//  .force(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .keyPairName(java.lang.String)
//  .keyPairName(IResolvable)
//  .password(java.lang.String)
//  .password(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.
bootable java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property bootable: Whether the disk is bootable.
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.
force java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property force: Whether to force the operation.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The instance type.
keyPairName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property keyPairName: The name of the key pair.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The password for the disk.

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.


bootableOptional

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

Property bootable: Whether the disk is bootable.


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.


forceOptional

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

Property force: Whether to force the operation.


instanceTypeOptional

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

Property instanceType: The instance type.

Allowed values are LingJun and ECS, Default is ECS.


keyPairNameOptional

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

Property keyPairName: The name of the key pair.


passwordOptional

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

Property password: The password for the disk.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

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)

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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Device: The device where the volume is exposed on ecs instance.
attrDiskId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DiskId: The disk id of created disk.
attrStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Status: The disk status now.
props DiskAttachmentProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

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.


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 java.lang.Object getAttrDevice();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrDiskIdRequired

public java.lang.Object getAttrDiskId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DiskId: The disk id of created disk.


attrStatusRequired

public java.lang.Object getAttrStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: The disk status now.


propsRequired

public DiskAttachmentProps getProps();