CopyImage

This class encapsulates and extends the ROS resource type ALIYUN::ECS::CopyImage, which is used to copy a custom image from one region to another region.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.CopyImage(
  scope: Construct,
  id: str,
  destination_region_id: typing.Union[str, IResolvable],
  image_id: typing.Union[str, IResolvable],
  allow_copy_in_same_region: typing.Union[bool, IResolvable] = None,
  destination_description: typing.Union[str, IResolvable] = None,
  destination_image_name: typing.Union[str, IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  source_region_id: typing.Union[str, IResolvable] = None,
  tag: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RosTag]]] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
destination_region_id	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationRegionId: ID of the region to where the destination custom image belongs.
image_id	typing.Union[str, ros_cdk_core.IResolvable]	Property imageId: ID of the source custom image.
allow_copy_in_same_region	typing.Union[bool, ros_cdk_core.IResolvable]	Property allowCopyInSameRegion: Whether to allow copying images in the same region.
destination_description	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationDescription: The description of the destination custom image.It cannot begin with http:\/\/ or https:\/\/. Default value: null.
destination_image_name	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationImageName: Name of the destination custom image.The name is a string of 2 to 128 characters. It must begin with an English or a Chinese character. It can contain A-Z, a-z, Chinese characters, numbers, periods (.), colons (:), underscores (_), and hyphens (-). Default value: null.
encrypted	typing.Union[bool, ros_cdk_core.IResolvable]	Property encrypted: Whether to encrypt the image.
kms_key_id	typing.Union[str, ros_cdk_core.IResolvable]	Property kmsKeyId: The ID of the key used to encrypt the image.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: The ID of the resource group to which the image copy belongs.
source_region_id	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceRegionId: ID of the region to where the source image belongs.
tag	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]]	Property tag:.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

destination_region_id^Required

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

Property destinationRegionId: ID of the region to where the destination custom image belongs.

---

image_id^Required

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

Property imageId: ID of the source custom image.

---

allow_copy_in_same_region^Optional

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

Property allowCopyInSameRegion: Whether to allow copying images in the same region.

If set to true, the image will not be copied, the source image id will be returned, and the original image will not be deleted.

---

destination_description^Optional

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

Property destinationDescription: The description of the destination custom image.It cannot begin with http:\/\/ or https:\/\/. Default value: null.

---

destination_image_name^Optional

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

Property destinationImageName: Name of the destination custom image.The name is a string of 2 to 128 characters. It must begin with an English or a Chinese character. It can contain A-Z, a-z, Chinese characters, numbers, periods (.), colons (:), underscores (_), and hyphens (-). Default value: null.

---

encrypted^Optional

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

Property encrypted: Whether to encrypt the image.

---

kms_key_id^Optional

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

Property kmsKeyId: The ID of the key used to encrypt the image.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group to which the image copy belongs.

If not provided, the image copy belongs to the default resource group.

---

source_region_id^Optional

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

Property sourceRegionId: ID of the region to where the source image belongs.

Default is current region ID.

---

tag^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]]

Property tag:.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

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

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_destination_region_id	ros_cdk_core.IResolvable	Attribute DestinationRegionId: ID of the region to where the destination custom image belongs.
attr_image_id	ros_cdk_core.IResolvable	Attribute ImageId: ID of the source custom image.
attr_source_region_id	ros_cdk_core.IResolvable	Attribute SourceRegionId: ID of the region to where the source image belongs.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_destination_region_id^Required

attr_destination_region_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute DestinationRegionId: ID of the region to where the destination custom image belongs.

---

attr_image_id^Required

attr_image_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ImageId: ID of the source custom image.

---

attr_source_region_id^Required

attr_source_region_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceRegionId: ID of the region to where the source image belongs.

---