ALIYUN::ECS::ImagePipeline is used to create an image template.
Syntax
{
"Type": "ALIYUN::ECS::ImagePipeline",
"Properties": {
"BaseImageType": String,
"Description": String,
"ResourceGroupId": String,
"SystemDiskSize": Integer,
"VSwitchId": String,
"AddAccount": List,
"Name": String,
"ExecutePipeline": Boolean,
"DeleteInstanceOnFailure": Boolean,
"ImageName": String,
"ToRegionId": List,
"InternetMaxBandwidthOut": Integer,
"InstanceType": String,
"Tags": List,
"BuildContent": String,
"BaseImage": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
BaseImageType | String | Yes | No | The type of the source image. | Valid values:
|
Description | String | No | No | The description. | The description must be 2 to 256 characters in length. It can contain letters and cannot start with |
ResourceGroupId | String | No | No | The ID of the resource group. | None. |
SystemDiskSize | Integer | No | No | The system disk size of the intermediate instance. | Unit: GiB. Valid values: 20 to 500. Default value: 40. |
VSwitchId | String | No | No | The ID of the vSwitch in the virtual private cloud (VPC). | If you do not specify this property, a new VPC and vSwitch are created by default. Make sure that the quotas of VPC resources within your account are sufficient. For more information, see Limits and quotas. |
AddAccount | List | No | No | The IDs of Alibaba Cloud accounts with which you want to share the image to be created based on the image template. | You can specify up to 20 account IDs. |
Name | String | No | No | 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 Note If you do not specify |
ExecutePipeline | Boolean | No | No | Specifies whether to execute the image build task. | Valid values:
|
DeleteInstanceOnFailure | Boolean | No | No | Specifies whether to release the intermediate instance if the image fails to be created. | Valid values:
Note If the intermediate instance fails to be started, the intermediate instance is released by default. |
ImageName | String | No | No | The name prefix of the image to be created based on the image template. | The prefix must be 2 to 64 characters in length. It must start with a letter and cannot start with The system generates the final image name that consists of the specified prefix and the build task ID ( |
ToRegionId | List | No | No | The IDs of regions to which you want to distribute the image to be created based on the image template. | You can specify up to 20 region IDs. If you do not specify this property, the image is created only in the current region by default. |
InternetMaxBandwidthOut | Integer | No | No | The size of the outbound public bandwidth for the intermediate instance. | Unit: Mbit/s. Valid values: 0 to 100. Default value: 0. |
InstanceType | String | No | No | The instance type. | You can call the DescribeInstanceTypes operation to query instance types. If you do not specify this property, an instance type that provides the fewest vCPUs and memory resources is selected by default. This configuration is subject to the resource availability of instance types. For example, the ecs.g6.large instance type is selected by default. If available ecs.g6.large resources are insufficient, the ecs.g6.xlarge instance type is selected. |
Tags | List | No | No | The tags. | You can add up to 20 tags. For more information, see Tags properties. |
BuildContent | String | No | No | The content of the image template. | The content can be up to 16 KB in size and supports up to 127 commands. |
BaseImage | String | Yes | No | The source image. | If you set If you set |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
Value | String | No | No | The tag value. | The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot start with |
Key | String | No | No | The tag key. | The tag key cannot be an empty string. The tag key can be up to 128 characters in length, and cannot start with |
Return values
Fn::GetAtt
ImagePipelineId: the ID of the image template.