ImagePipeline

• Implements: IImagePipeline

This class encapsulates and extends the ROS resource type ALIYUN::ECS::ImagePipeline.

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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

baseImage^Required

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• 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

• 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

• 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

• 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

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

Property executePipeline: Whether execute pipeline.

Default value is true

imageName^Optional

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

Property imageName: The prefix of the destination image name.

This parameter is deprecated. Use ImageOptions.ImageName instead.>

instanceType^Optional

• 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

• 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

• Type: java.lang.String OR com.aliyun.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

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

Property resourceGroupId: The ID of the resource group.

systemDiskSize^Optional

• 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

• Type: java.util.List<TagsProperty>

Property tags:.

toRegionId^Optional

• 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

• 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

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrImagePipelineId^Required

public java.lang.Object getAttrImagePipelineId();

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

Attribute ImagePipelineId: The ID of the image template.

props^Required

public ImagePipelineProps getProps();

• Type: ImagePipelineProps