Skip to content

ImagePipelineProps

Properties for defining a ImagePipeline.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-imagepipeline

Initializer 

import ros_cdk_ecs
ros_cdk_ecs.ImagePipelineProps(
  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
)

Properties

Name Type 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.

base_imageRequired 

base_image: typing.Union[str, IResolvable]
  • 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_typeRequired 

base_image_type: typing.Union[str, IResolvable]
  • 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_accountOptional 

add_account: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • 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_contentOptional 

build_content: typing.Union[str, IResolvable]
  • 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_failureOptional 

delete_instance_on_failure: typing.Union[bool, IResolvable]
  • 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.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • 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_pipelineOptional 

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

Property executePipeline: Whether execute pipeline.

Default value is true

image_nameOptional 

image_name: typing.Union[str, IResolvable]
  • 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_typeOptional 

instance_type: typing.Union[str, IResolvable]
  • 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_outOptional 

internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable]
  • 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.

nameOptional 

name: typing.Union[str, IResolvable]
  • 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_idOptional 

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

Property resourceGroupId: The ID of the resource group.

system_disk_sizeOptional 

system_disk_size: typing.Union[typing.Union[int, float], IResolvable]
  • 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.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags:.

to_region_idOptional 

to_region_id: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • 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_idOptional 

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