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

baseImage^Required

public readonly baseImage: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property baseImage: The base image.

The value of this parameter varies based on the value of BaseImageType: - If BaseImageType is IMAGE, specify the ID of the base image. - If BaseImageType is IMAGE_FAMILY, specify the name of the base image family. - If BaseImageType is OSS, this parameter is not required.

baseImageType^Required

public readonly baseImageType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property baseImageType: The type of the base image.

Valid values: - IMAGE: An ECS image. - IMAGE_FAMILY: An image family. - OSS: An OSS object.

addAccount^Optional

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.

buildContent^Optional

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.

deleteInstanceOnFailure^Optional

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.

description^Optional

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:\/\/.

executePipeline^Optional

public readonly executePipeline: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property executePipeline: Whether execute pipeline.

Default value is true

imageName^Optional

public readonly imageName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property imageName: The prefix of the destination image name.

This parameter is deprecated. Use ImageOptions.ImageName instead.><\/notice>

instanceType^Optional

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.

internetMaxBandwidthOut^Optional

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.

name^Optional

public readonly name: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: The name of the image pipeline.

It must be 2 to 128 characters long, start with a letter or a Chinese character, and cannot start with http:\/\/ or https:\/\/. Allowed characters include letters, digits, Chinese characters, colons (:), underscores (_), periods (.), and hyphens (-).

If you do not specify this parameter, the value of ImagePipelineId is used as the name.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

systemDiskSize^Optional

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.

tags^Optional

public readonly tags: TagsProperty[];

• Type: TagsProperty[]

Property tags:.

toRegionId^Optional

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.

vSwitchId^Optional

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.