Skip to content

ImageComponentProps

Properties for defining a ImageComponent.

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

Initializer 

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

Properties

Name Type Description
content string | @alicloud/ros-cdk-core.IResolvable Property content: The content of the image component.
componentType string | @alicloud/ros-cdk-core.IResolvable Property componentType: The type of the image component.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The component name.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
systemType string | @alicloud/ros-cdk-core.IResolvable Property systemType: The type of the operating system supported by the image component.
tags TagsProperty[] Property tags:.

contentRequired 

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

Property content: The content of the image component.

The image component consists of multiple commands. The command content cannot exceed 16 KB in size. For information about the commands supported by Image Builder and the formats of the commands, see Commands supported by Image Builder.

componentTypeOptional 

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

Property componentType: The type of the image component.

Only image building components and image test components are supported. Valid values: - Build - Test Default value: Build.

Image building components can be used only in image building templates. Image test components can be used only in image test templates.

descriptionOptional 

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

Property description: The description.

The description must be 2 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.

nameOptional 

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

Property name: The component name.

The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with http:\/\/ or https:\/\/.The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-). Note If you do not configure Name, the return value of ImageComponentId is used.

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of the resource group.

systemTypeOptional 

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

Property systemType: The type of the operating system supported by the image component.

Valid values: - Linux - Windows Default value: Linux.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags:.