DiskAttachment

• Implements: IDiskAttachment

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

Initializers

import ros_cdk_ecs
ros_cdk_ecs.DiskAttachment(
  scope: Construct,
  id: str,
  disk_id: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  bootable: typing.Union[bool, IResolvable] = None,
  delete_auto_snapshot: typing.Union[bool, IResolvable] = None,
  delete_with_instance: typing.Union[bool, IResolvable] = None,
  device: typing.Union[str, IResolvable] = None,
  force: typing.Union[bool, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

disk_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property diskId: The disk id to attached.

instance_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The instanceId to attach the disk.

bootable^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property bootable: Whether the disk is bootable.

delete_auto_snapshot^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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

Default to true.

delete_with_instance^Optional

• Type: typing.Union[bool, 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^Optional

• Type: typing.Union[str, 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.

force^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property force: Whether to force the operation.

instance_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceType: The instance type.

Allowed values are LingJun and ECS, Default is ECS.

key_pair_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property keyPairName: The name of the key pair.

password^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property password: The password for the disk.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_ecs
ros_cdk_ecs.DiskAttachment.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_device^Required

attr_device: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_disk_id^Required

attr_disk_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DiskId: The disk id of created disk.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Status: The disk status now.

props^Required

props: DiskAttachmentProps

• Type: DiskAttachmentProps