Skip to content

ImagePipeline

This class encapsulates and extends the ROS resource type ALIYUN::ECS::ImagePipeline, which is used to create an image template.

Initializers 

import com.aliyun.ros.cdk.ecs.ImagePipeline;
ImagePipeline.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No 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.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

baseImageRequired

  • 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.

baseImageTypeRequired

  • 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

addAccountOptional

  • 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.

buildContentOptional

  • 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.

deleteInstanceOnFailureOptional

  • 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.

descriptionOptional

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

executePipelineOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property executePipeline: Whether execute pipeline.

Default value is true

imageNameOptional

  • 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}.

instanceTypeOptional

  • 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.

internetMaxBandwidthOutOptional

  • 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.

nameOptional

  • 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.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

systemDiskSizeOptional

  • 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.

tagsOptional

Property tags:.

toRegionIdOptional

  • 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.

vSwitchIdOptional

  • 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.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.ecs.ImagePipeline;
ImagePipeline.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrImagePipelineId com.aliyun.ros.cdk.core.IResolvable Attribute ImagePipelineId: The ID of the image template.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrImagePipelineIdRequired 

public IResolvable getAttrImagePipelineId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ImagePipelineId: The ID of the image template.