Skip to content

CustomImage

This class encapsulates and extends the ROS resource type ALIYUN::ECS::CustomImage, which is used to create a custom image.

Initializers 

import ros_cdk_ecs
ros_cdk_ecs.CustomImage(
  scope: Construct,
  id: str,
  architecture: typing.Union[str, IResolvable] = None,
  boot_mode: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  detection_strategy: typing.Union[str, IResolvable] = None,
  disk_device_mapping: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskDeviceMappingProperty]]] = None,
  image_family: typing.Union[str, IResolvable] = None,
  image_name: typing.Union[str, IResolvable] = None,
  image_version: typing.Union[str, IResolvable] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  platform: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  snapshot_id: typing.Union[str, IResolvable] = None,
  source_region_id: typing.Union[str, IResolvable] = None,
  tag: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RosTag]]] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
architecture typing.Union[str, ros_cdk_core.IResolvable] Property architecture: After specifying the data disk snapshot as the mirrored system disk, you need to determine the system architecture of the system disk through Architecture.
boot_mode typing.Union[str, ros_cdk_core.IResolvable] Property bootMode: Modify the startup mode of the image.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the image.
detection_strategy typing.Union[str, ros_cdk_core.IResolvable] Property detectionStrategy: Image detection policy.
disk_device_mapping typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskDeviceMappingProperty]]] Property diskDeviceMapping:.
image_family typing.Union[str, ros_cdk_core.IResolvable] Property imageFamily: The name of the image family of the image.
image_name typing.Union[str, ros_cdk_core.IResolvable] Property imageName: Image name.
image_version typing.Union[str, ros_cdk_core.IResolvable] Property imageVersion: Image version.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: Instance ID.
platform typing.Union[str, ros_cdk_core.IResolvable] Property platform: After specifying the data disk snapshot as the mirrored system disk, you need to determine the operating system release of the system disk through Platform.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which to assign the custom image.
snapshot_id typing.Union[str, ros_cdk_core.IResolvable] Property snapshotId: The snapshot ID.
source_region_id typing.Union[str, ros_cdk_core.IResolvable] Property sourceRegionId: ID of the region to where the instance\/snapshot belongs.
tag typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]] Property tag:.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

architectureOptional

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

Property architecture: After specifying the data disk snapshot as the mirrored system disk, you need to determine the system architecture of the system disk through Architecture.

Ranges: I386 X86_64 (default)

boot_modeOptional

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

Property bootMode: Modify the startup mode of the image.

Ranges: BIOS: BIOS boot mode. UEFI: UEFI boot mode. You need to know the startup mode supported by the specified image. After modifying the startup mode through this parameter, it must match the startup mode supported by the image itself so that the instance can start normally.

descriptionOptional

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

Property description: The description of the image.

It can be [0, 256] letters in length. It cannot begin with http:// or https://. Default value: null.

detection_strategyOptional

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

Property detectionStrategy: Image detection policy.

If this parameter is not configured, detection will not be triggered. Only Standard detection mode is supported.Currently, most Linux/Windows versions are supported.

disk_device_mappingOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskDeviceMappingProperty]]]

Property diskDeviceMapping:.

image_familyOptional

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

Property imageFamily: The name of the image family of the image.

The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-). It cannot contain http:// or https://. It must start with a letter and cannot start with acs: or aliyun.This parameter is empty by default.

image_nameOptional

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

Property imageName: Image name.

Can contain [2, 128] characters in length. Must begin with an English letter or Chinese character. Can contain digits, colons (:), underscores (_), or hyphens (-). Cannot begin with http:// or https://.

image_versionOptional

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

Property imageVersion: Image version.

When you specify an instance ID (InstanceId) and the image of the instance is a cloud market image or a custom image created from a cloud market image. This parameter must be the same as the ImageVersion of the current instance image or set to empty.

instance_idOptional

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

Property instanceId: Instance ID.

platformOptional

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

Property platform: After specifying the data disk snapshot as the mirrored system disk, you need to determine the operating system release of the system disk through Platform.

resource_group_idOptional

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

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

snapshot_idOptional

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

Property snapshotId: The snapshot ID.

A custom image is created from the specified snapshot.

source_region_idOptional

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

Property sourceRegionId: ID of the region to where the instance\/snapshot belongs.

Default is current region ID.

tagOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]]

Property tag:.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

import ros_cdk_ecs
ros_cdk_ecs.CustomImage.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_image_id ros_cdk_core.IResolvable Attribute ImageId: Image ID.
attr_source_region_id ros_cdk_core.IResolvable Attribute SourceRegionId: ID of the region to where the instance/snapshot belongs.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_image_idRequired 

attr_image_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageId: Image ID.

attr_source_region_idRequired 

attr_source_region_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceRegionId: ID of the region to where the instance/snapshot belongs.