Skip to content

CustomImageProps

Properties for defining a CustomImage.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-customimage

Initializer 

import { CustomImageProps } from '@alicloud/ros-cdk-ecs'
const customImageProps: CustomImageProps = { ... }

Properties

Name Type Description
architecture string | @alicloud/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.
bootMode string | @alicloud/ros-cdk-core.IResolvable Property bootMode: Modify the startup mode of the image.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the image.
detectionStrategy string | @alicloud/ros-cdk-core.IResolvable Property detectionStrategy: Image detection policy.
diskDeviceMapping @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DiskDeviceMappingProperty[] Property diskDeviceMapping:.
imageFamily string | @alicloud/ros-cdk-core.IResolvable Property imageFamily: The name of the image family of the image.
imageName string | @alicloud/ros-cdk-core.IResolvable Property imageName: Image name.
imageVersion string | @alicloud/ros-cdk-core.IResolvable Property imageVersion: Image version.
instanceId string | @alicloud/ros-cdk-core.IResolvable Property instanceId: Instance ID.
platform string | @alicloud/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.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which to assign the custom image.
snapshotId string | @alicloud/ros-cdk-core.IResolvable Property snapshotId: The snapshot ID.
sourceRegionId string | @alicloud/ros-cdk-core.IResolvable Property sourceRegionId: ID of the region to where the instance\/snapshot belongs.
tag @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.RosTag[] Property tag:.

architectureOptional 

public readonly architecture: string | IResolvable;
  • Type: string | @alicloud/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)

bootModeOptional 

public readonly bootMode: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/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.

detectionStrategyOptional 

public readonly detectionStrategy: string | IResolvable;
  • Type: string | @alicloud/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.

diskDeviceMappingOptional 

public readonly diskDeviceMapping: IResolvable | IResolvable | DiskDeviceMappingProperty[];

Property diskDeviceMapping:.

imageFamilyOptional 

public readonly imageFamily: string | IResolvable;
  • Type: string | @alicloud/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.

imageNameOptional 

public readonly imageName: string | IResolvable;
  • Type: string | @alicloud/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:\/\/.

imageVersionOptional 

public readonly imageVersion: string | IResolvable;
  • Type: string | @alicloud/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.

instanceIdOptional 

public readonly instanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceId: Instance ID.

platformOptional 

public readonly platform: string | IResolvable;
  • Type: string | @alicloud/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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

snapshotIdOptional 

public readonly snapshotId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property snapshotId: The snapshot ID.

A custom image is created from the specified snapshot.

sourceRegionIdOptional 

public readonly sourceRegionId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Default is current region ID.

tagOptional 

public readonly tag: IResolvable | IResolvable | RosTag[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.RosTag[]

Property tag:.