Skip to content

ImagePipelineProps

Properties for defining a ImagePipeline.

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

Initializer 

import { ImagePipelineProps } from '@alicloud/ros-cdk-ecs'
const imagePipelineProps: ImagePipelineProps = { ... }

Properties

Name Type Description
baseImage string | @alicloud/ros-cdk-core.IResolvable Property baseImage: The source image.
baseImageType string | @alicloud/ros-cdk-core.IResolvable Property baseImageType: The type of the source image.
addAccount @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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.
buildContent string | @alicloud/ros-cdk-core.IResolvable Property buildContent: The content of the image template.
deleteInstanceOnFailure boolean | @alicloud/ros-cdk-core.IResolvable Property deleteInstanceOnFailure: Specifies whether to release the intermediate instance when the image cannot be created.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the image template.
executePipeline boolean | @alicloud/ros-cdk-core.IResolvable Property executePipeline: Whether execute pipeline.
imageName string | @alicloud/ros-cdk-core.IResolvable Property imageName: The prefix of the image name.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: The instance type.
internetMaxBandwidthOut number | @alicloud/ros-cdk-core.IResolvable Property internetMaxBandwidthOut: The size of the outbound public bandwidth for the intermediate instance.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the image template.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
systemDiskSize number | @alicloud/ros-cdk-core.IResolvable Property systemDiskSize: The system disk size of the intermediate instance.
tags TagsProperty[] Property tags:.
toRegionId @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The ID of the vSwitch.

baseImageRequired 

public readonly baseImage: string | IResolvable;
  • Type: string | @alicloud/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.

baseImageTypeRequired 

public readonly baseImageType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property baseImageType: The type of the source image.

Valid values: IMAGE: image IMAGE_FAMILY: image family

addAccountOptional 

public readonly addAccount: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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.

buildContentOptional 

public readonly buildContent: string | IResolvable;
  • Type: string | @alicloud/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.

deleteInstanceOnFailureOptional 

public readonly deleteInstanceOnFailure: boolean | IResolvable;
  • Type: boolean | @alicloud/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 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/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:\/\/.

executePipelineOptional 

public readonly executePipeline: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property executePipeline: Whether execute pipeline.

Default value is true

imageNameOptional 

public readonly imageName: string | IResolvable;
  • Type: string | @alicloud/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}.

instanceTypeOptional 

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/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.

internetMaxBandwidthOutOptional 

public readonly internetMaxBandwidthOut: number | IResolvable;
  • Type: number | @alicloud/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 

public readonly name: string | IResolvable;
  • Type: string | @alicloud/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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

systemDiskSizeOptional 

public readonly systemDiskSize: number | IResolvable;
  • Type: number | @alicloud/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 

public readonly tags: TagsProperty[];

Property tags:.

toRegionIdOptional 

public readonly toRegionId: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/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.