Skip to content

ImagesProps

Properties for defining a Images.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-ecs-images

Initializer 

import com.aliyun.ros.cdk.ecs.datasource.ImagesProps;
ImagesProps.builder()
//  .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();

Properties

Name Type 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.

actionTypeOptional 

public java.lang.Object getActionType();
  • 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 

public java.lang.Object getArchitecture();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property architecture: The image architecture.

Valid values: i38 x86_64 arm64

imageFamilyOptional 

public java.lang.Object getImageFamily();
  • 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 

public java.lang.Object getImageId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageId: The ID of the image.

imageNameOptional 

public java.lang.Object getImageName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property imageName: The name of the image.

Support for fuzzy queries using *.

imageOwnerAliasOptional 

public java.lang.Object getImageOwnerAlias();
  • 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 

public java.lang.Object getInstanceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

isPublicOptional 

public java.lang.Object getIsPublic();
  • 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 

public java.lang.Object getIsSupportCloudinit();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

isSupportIoOptimizedOptional 

public java.lang.Object getIsSupportIoOptimized();
  • 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 

public java.lang.Object getOsType();
  • 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 

public java.lang.Object getRefreshOptions();
  • 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 

public java.lang.Object getResourceGroupId();
  • 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 

public java.lang.Object getSnapshotId();
  • 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 

public java.lang.Object getStatus();
  • 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 

public java.util.List<TagsProperty> getTags();
  • Type: java.util.List

Property tags: Tags of image.

usageOptional 

public java.lang.Object getUsage();
  • 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.