ImagePipelineProps
Properties for defining a ImagePipeline
.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-imagepipeline
Initializer
import com.aliyun.ros.cdk.ecs.ImagePipelineProps;
ImagePipelineProps.builder()
.baseImage(java.lang.String)
.baseImage(IResolvable)
.baseImageType(java.lang.String)
.baseImageType(IResolvable)
// .addAccount(IResolvable)
// .addAccount(java.util.List<java.lang.String)
// .addAccount(IResolvable>)
// .buildContent(java.lang.String)
// .buildContent(IResolvable)
// .deleteInstanceOnFailure(java.lang.Boolean)
// .deleteInstanceOnFailure(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .executePipeline(java.lang.Boolean)
// .executePipeline(IResolvable)
// .imageName(java.lang.String)
// .imageName(IResolvable)
// .instanceType(java.lang.String)
// .instanceType(IResolvable)
// .internetMaxBandwidthOut(java.lang.Number)
// .internetMaxBandwidthOut(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .systemDiskSize(java.lang.Number)
// .systemDiskSize(IResolvable)
// .tags(java.util.List<TagsProperty>)
// .toRegionId(IResolvable)
// .toRegionId(java.util.List<java.lang.String)
// .toRegionId(IResolvable>)
// .vSwitchId(java.lang.String)
// .vSwitchId(IResolvable)
.build();
Properties
Name | Type | Description |
---|---|---|
baseImage |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property baseImage: The source image. |
baseImageType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property baseImageType: The type of the source image. |
addAccount |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
Property addAccount: The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template. |
buildContent |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property buildContent: The content of the image template. |
deleteInstanceOnFailure |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property deleteInstanceOnFailure: Specifies whether to release the intermediate instance when the image cannot be created. |
description |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property description: The description of the image template. |
executePipeline |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property executePipeline: Whether execute pipeline. |
imageName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property imageName: The prefix of the image name. |
instanceType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property instanceType: The instance type. |
internetMaxBandwidthOut |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property internetMaxBandwidthOut: The size of the outbound public bandwidth for the intermediate instance. |
name |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property name: The name of the image template. |
resourceGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property resourceGroupId: The ID of the resource group. |
systemDiskSize |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property systemDiskSize: The system disk size of the intermediate instance. |
tags |
java.util.List<TagsProperty> |
Property tags:. |
toRegionId |
com.aliyun.ros.cdk.core.IResolvable OR java.util.List |
Property toRegionId: The IDs of regions to which you want to distribute the image that is created based on the image template. |
vSwitchId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property vSwitchId: The ID of the vSwitch. |
baseImage
Required
public java.lang.Object getBaseImage();
- Type: java.lang.String OR com.aliyun.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.
baseImageType
Required
public java.lang.Object getBaseImageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property baseImageType: The type of the source image.
Valid values: IMAGE: image IMAGE_FAMILY: image family
addAccount
Optional
public java.lang.Object getAddAccount();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
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 java.lang.Object getBuildContent();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getDeleteInstanceOnFailure();
- Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getDescription();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getExecutePipeline();
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property executePipeline: Whether execute pipeline.
Default value is true
imageName
Optional
public java.lang.Object getImageName();
- Type: java.lang.String OR com.aliyun.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}.
instanceType
Optional
public java.lang.Object getInstanceType();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getInternetMaxBandwidthOut();
- Type: java.lang.Number OR com.aliyun.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 java.lang.Object getName();
- Type: java.lang.String OR com.aliyun.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.
resourceGroupId
Optional
public java.lang.Object getResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
systemDiskSize
Optional
public java.lang.Object getSystemDiskSize();
- Type: java.lang.Number OR com.aliyun.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 java.util.List<TagsProperty> getTags();
- Type: java.util.List<TagsProperty>
Property tags:.
toRegionId
Optional
public java.lang.Object getToRegionId();
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
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 java.lang.Object getVSwitchId();
- Type: java.lang.String OR com.aliyun.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.