Skip to content

ImagesProps

Properties for defining a Images.

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

Initializer

from ros_cdk_ecs import datasource
datasource.ImagesProps(
  action_type: typing.Union[str, IResolvable] = None,
  architecture: typing.Union[str, IResolvable] = None,
  image_family: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_name: typing.Union[str, IResolvable] = None,
  image_owner_alias: typing.Union[str, IResolvable] = None,
  instance_type: typing.Union[str, IResolvable] = None,
  is_public: typing.Union[bool, IResolvable] = None,
  is_support_cloudinit: typing.Union[bool, IResolvable] = None,
  is_support_io_optimized: typing.Union[bool, IResolvable] = None,
  os_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  snapshot_id: typing.Union[str, IResolvable] = None,
  status: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  usage: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
action_type typing.Union[str, ros_cdk_core.IResolvable] Property actionType: The scenario in which the image is used.
architecture typing.Union[str, ros_cdk_core.IResolvable] Property architecture: The image architecture.
image_family typing.Union[str, ros_cdk_core.IResolvable] Property imageFamily: The name of the image family.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: The ID of the image.
image_name typing.Union[str, ros_cdk_core.IResolvable] Property imageName: The name of the image.
image_owner_alias typing.Union[str, ros_cdk_core.IResolvable] Property imageOwnerAlias: The source of the image.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The instance type for which the image can be used.
is_public typing.Union[bool, ros_cdk_core.IResolvable] Property isPublic: Specifies whether to query published community images.
is_support_cloudinit typing.Union[bool, ros_cdk_core.IResolvable] Property isSupportCloudinit: Specifies whether the image supports cloud-init.
is_support_io_optimized typing.Union[bool, ros_cdk_core.IResolvable] Property isSupportIoOptimized: Specifies whether the image can be used on I\/O optimized instances.
os_type typing.Union[str, ros_cdk_core.IResolvable] Property osType: The operating system type of the image.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the custom image belongs.
snapshot_id typing.Union[str, ros_cdk_core.IResolvable] Property snapshotId: The ID of the snapshot used to create the custom image.
status typing.Union[str, ros_cdk_core.IResolvable] Property status: The state of the image.
tags typing.List[ros_cdk_ecs.datasource.RosImages.TagsProperty] Property tags: Tags of image.
usage typing.Union[str, ros_cdk_core.IResolvable] Property usage: Specifies whether the image is running on an Elastic Compute Service (ECS) instance.

action_typeOptional

action_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

architecture: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property architecture: The image architecture.

Valid values: i38 x86_64 arm64


image_familyOptional

image_family: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


image_idOptional

image_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property imageId: The ID of the image.


image_nameOptional

image_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property imageName: The name of the image.

Support for fuzzy queries using *.


image_owner_aliasOptional

image_owner_alias: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

instance_typeOptional

instance_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


is_publicOptional

is_public: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, 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.


is_support_cloudinitOptional

is_support_cloudinit: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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


is_support_io_optimizedOptional

is_support_io_optimized: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

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


os_typeOptional

os_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property osType: The operating system type of the image.

Valid values: windows linux


refresh_optionsOptional

refresh_options: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

resource_group_idOptional

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


snapshot_idOptional

snapshot_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


statusOptional

status: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

tags: typing.List[TagsProperty]
  • Type: typing.List[ros_cdk_ecs.datasource.RosImages.TagsProperty]

Property tags: Tags of image.


usageOptional

usage: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.