ImagePipeline

This class encapsulates and extends the ROS resource type ALIYUN::ECS::ImagePipeline, which is used to create an image template.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.ImagePipeline(
  scope: Construct,
  id: str,
  base_image: typing.Union[str, IResolvable],
  base_image_type: typing.Union[str, IResolvable],
  add_account: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  build_content: typing.Union[str, IResolvable] = None,
  delete_instance_on_failure: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  execute_pipeline: typing.Union[bool, IResolvable] = None,
  image_name: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  to_region_id: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No description.
`base_image`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property baseImage: The source image.
`base_image_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property baseImageType: The type of the source image.
`add_account`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property addAccount: The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template.
`build_content`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property buildContent: The content of the image template.
`delete_instance_on_failure`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property deleteInstanceOnFailure: Specifies whether to release the intermediate instance when the image cannot be created.
`description`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property description: The description of the image template.
`execute_pipeline`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property executePipeline: Whether execute pipeline.
`image_name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property imageName: The prefix of the image name.
`instance_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property instanceType: The instance type.
`internet_max_bandwidth_out`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property internetMaxBandwidthOut: The size of the outbound public bandwidth for the intermediate instance.
`name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property name: The name of the image template.
`resource_group_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property resourceGroupId: The ID of the resource group.
`system_disk_size`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property systemDiskSize: The system disk size of the intermediate instance.
`tags`	`typing.List[TagsProperty]`	Property tags:.
`to_region_id`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property toRegionId: The IDs of regions to which you want to distribute the image that is created based on the image template.
`v_switch_id`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property vSwitchId: The ID of the vSwitch.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`base_image`^Required

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

Property baseImage: The source image.

If you set BaseImageType to IMAGE, set the BaseImage parameter to the ID of a custom image. If you set BaseImageType to IMAGE_FAMILY, set the BaseImage parameter to the name of an image family.

`base_image_type`^Required

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

Property baseImageType: The type of the source image.

Valid values: IMAGE: image IMAGE_FAMILY: image family

`add_account`^Optional

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

Property addAccount: The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template.

You can specify up to 20 account IDs.

`build_content`^Optional

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

Property buildContent: The content of the image template.

The content cannot exceed 16 KB in size and can contain up to 127 commands. For more information about the commands that are supported, see the "Usage notes" section of this topic.

`delete_instance_on_failure`^Optional

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

Property deleteInstanceOnFailure: Specifies whether to release the intermediate instance when the image cannot be created.

Valid values: true false Default value: true. Note If the intermediate instance cannot be started, the instance is released by default.

`description`^Optional

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

Property description: The description of the image template.

The description must be 2 to 256 characters in length. It cannot start with http:// or https://.

`execute_pipeline`^Optional

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

Property executePipeline: Whether execute pipeline.

Default value is true

`image_name`^Optional

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

Property imageName: The prefix of the image name.

The prefix must be 2 to 64 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (), periods (.), and hyphens (-). The system generates the final complete image name that consists of the specified prefix and the ID of the build task (ExecutionId) in the format of {ImageName}{ExecutionId}.

`instance_type`^Optional

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

Property instanceType: The instance type.

You can call the DescribeInstanceTypes to query instance types. If you do not configure this parameter, an instance type that provides the fewest vCPUs and memory resources is automatically selected. This configuration is subject to resource availability of instance types. For example, the ecs.g6.large instance type is automatically selected. If available ecs.g6.large resources are insufficient, the ecs.g6.xlarge instance type is selected.

`internet_max_bandwidth_out`^Optional

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

Property internetMaxBandwidthOut: The size of the outbound public bandwidth for the intermediate instance.

Unit: Mbit/s. Valid values: 0 to 100. Default value: 0.

`name`^Optional

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

Property name: The name of the image template.

The name must be 2 to 128 characters in length. It must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). Note If you do not specify the Name parameter, the return value of ImagePipelineId is used.

`resource_group_id`^Optional

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

Property resourceGroupId: The ID of the resource group.

`system_disk_size`^Optional

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

Property systemDiskSize: The system disk size of the intermediate instance.

Unit: GiB. Valid values: 20 to 500. Default value: 40.

`tags`^Optional

Type: typing.List[TagsProperty]

Property tags:.

`to_region_id`^Optional

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

Property toRegionId: The IDs of regions to which you want to distribute the image that is created based on the image template.

You can specify up to 20 region IDs. If you do not specify this parameter, the image is created only in the current region.

`v_switch_id`^Optional

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

Property vSwitchId: The ID of the vSwitch.

If you do not specify this parameter, a new VPC and vSwitch are created. Make sure that the VPC quota in your account is sufficient. For more information, see Limits and quotas.

`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.ImagePipeline.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_image_pipeline_id`	`ros_cdk_core.IResolvable`	Attribute ImagePipelineId: The ID of the image template.

`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_image_pipeline_id`^Required

attr_image_pipeline_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute ImagePipelineId: The ID of the image template.

ImagePipeline

Initializers

scopeRequired

idRequired

base_imageRequired

base_image_typeRequired

add_accountOptional

build_contentOptional

delete_instance_on_failureOptional

descriptionOptional

execute_pipelineOptional

image_nameOptional

instance_typeOptional

internet_max_bandwidth_outOptional

nameOptional

resource_group_idOptional

system_disk_sizeOptional

tagsOptional

to_region_idOptional

v_switch_idOptional

enable_resource_property_constraintOptional