Skip to content

Images

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Images, which is used to query available images.

Initializers 

import com.aliyun.ros.cdk.ecs.datasource.Images;
Images.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .actionType(java.lang.String)
//  .actionType(IResolvable)
//  .architecture(java.lang.String)
//  .architecture(IResolvable)
//  .imageFamily(java.lang.String)
//  .imageFamily(IResolvable)
//  .imageId(java.lang.String)
//  .imageId(IResolvable)
//  .imageName(java.lang.String)
//  .imageName(IResolvable)
//  .imageOwnerAlias(java.lang.String)
//  .imageOwnerAlias(IResolvable)
//  .instanceType(java.lang.String)
//  .instanceType(IResolvable)
//  .isPublic(java.lang.Boolean)
//  .isPublic(IResolvable)
//  .isSupportCloudinit(java.lang.Boolean)
//  .isSupportCloudinit(IResolvable)
//  .isSupportIoOptimized(java.lang.Boolean)
//  .isSupportIoOptimized(IResolvable)
//  .osType(java.lang.String)
//  .osType(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .snapshotId(java.lang.String)
//  .snapshotId(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .usage(java.lang.String)
//  .usage(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.
actionType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property actionType: The scenario in which the image is used.
architecture java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property architecture: The image architecture.
imageFamily java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageFamily: The name of the image family.
imageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageId: The ID of the image.
imageName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageName: The name of the image.
imageOwnerAlias java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property imageOwnerAlias: The source of the image.
instanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceType: The instance type for which the image can be used.
isPublic java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isPublic: Specifies whether to query published community images.
isSupportCloudinit java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isSupportCloudinit: Specifies whether the image supports cloud-init.
isSupportIoOptimized java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isSupportIoOptimized: Specifies whether the image can be used on I\/O optimized instances.
osType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property osType: The operating system type of the image.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group to which the custom image belongs.
snapshotId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property snapshotId: The ID of the snapshot used to create the custom image.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The state of the image.
tags java.util.List Property tags: Tags of image.
usage java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property usage: Specifies whether the image is running on an Elastic Compute Service (ECS) instance.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

actionTypeOptional

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

Property actionType: The scenario in which the image is used.

Default value: CreateEcs. Valid values: CreateEcs: instance creation ChangeOS: replacement of the system disk or operating system

architectureOptional

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

Property architecture: The image architecture.

Valid values: i38 x86_64 arm64

imageFamilyOptional

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

Property imageFamily: The name of the image family.

You can set this parameter to query images of the specified image family. This parameter is empty by default.

imageIdOptional

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

Property imageId: The ID of the image.

imageNameOptional

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

Property imageName: The name of the image.

Support for fuzzy queries using *.

imageOwnerAliasOptional

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

Property imageOwnerAlias: The source of the image.

Valid values: system: public images provided by Alibaba Cloud. self: your custom images. others: shared images from other Alibaba Cloud accounts, or community images published by other Alibaba Cloud accounts. Take note of the following items:

  • To query community images, you must set IsPublic to true. To query shared images, you must set IsPublic to false or leave the IsPublic parameter empty. marketplace: Alibaba Cloud Marketplace images. If Alibaba Cloud Marketplace images are returned in the response, you can use the images without subscription. You must pay attention to the billing details of Alibaba Cloud Marketplace images. This parameter is empty by default, which indicates that the results that match system, self, and others are returned.

instanceTypeOptional

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

Property instanceType: The instance type for which the image can be used.

isPublicOptional

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

Property isPublic: Specifies whether to query published community images.

Valid values: true: queries published community images. When you set this parameter to true, you must set ImageOwnerAlias to others. false: queries other image types than community images. The specific image types to be queried are determined by the ImageOwnerAlias value. Default value: false.

isSupportCloudinitOptional

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

Property isSupportCloudinit: Specifies whether the image supports cloud-init.

isSupportIoOptimizedOptional

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

Property isSupportIoOptimized: Specifies whether the image can be used on I\/O optimized instances.

osTypeOptional

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

Property osType: The operating system type of the image.

Valid values: windows linux

refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group to which the custom image belongs.

If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

snapshotIdOptional

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

Property snapshotId: The ID of the snapshot used to create the custom image.

statusOptional

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

Property status: The state of the image.

Default value: Available. Valid values: Creating: The image is being created. Waiting: The image is waiting to be processed. Available: The image is available. UnAvailable: The image is unavailable. CreateFailed: The image failed to be created. Deprecated: The image is discontinued. You can specify multiple values. Separate multiple values with commas (,).

tagsOptional

  • Type: java.util.List

Property tags: Tags of image.

usageOptional

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

Property usage: Specifies whether the image is running on an Elastic Compute Service (ECS) instance.

Valid values: instance: The image is already in use and running on an ECS instance. none: The image is not in use.

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.datasource.Images;
Images.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.
attrImageIds com.aliyun.ros.cdk.core.IResolvable Attribute ImageIds: The list of image IDs.
attrImages com.aliyun.ros.cdk.core.IResolvable Attribute Images: The list of images.

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

attrImageIdsRequired 

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

Attribute ImageIds: The list of image IDs.

attrImagesRequired 

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

Attribute Images: The list of images.