Skip to content

CommandProps

Properties for defining a Command.

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

Initializer 

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

Properties

Name Type Description
type string | @alicloud/ros-cdk-core.IResolvable Property type: The type of command.
commandContent string | @alicloud/ros-cdk-core.IResolvable Property commandContent: The content of command.
contentEncoding string | @alicloud/ros-cdk-core.IResolvable Property contentEncoding: The encoding mode of script content (CommandContent).
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of command.
enableParameter boolean | @alicloud/ros-cdk-core.IResolvable Property enableParameter: Specifies whether the script contains custom parameters.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of command.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
tags TagsProperty[] Property tags: Tags to attach to command.
timeout number | @alicloud/ros-cdk-core.IResolvable Property timeout: Total timeout when the command is executed in the instance.
workingDir string | @alicloud/ros-cdk-core.IResolvable Property workingDir: The path where command will be executed in the instance.

typeRequired 

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

Property type: The type of command.

commandContentOptional 

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

Property commandContent: The content of command.

Content requires base64 encoding. Maximum size support 16KB.

contentEncodingOptional 

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

Property contentEncoding: The encoding mode of script content (CommandContent).

Valid values (case insensitive): PlainText: The script content is not encoded, and transmitted in plaintext. Base64: base64-encoded. Default value: Base64. If the specified value of this parameter is invalid, Base64 is used by default.

descriptionOptional 

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

Property description: The description of command.

enableParameterOptional 

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

Property enableParameter: Specifies whether the script contains custom parameters.

Default value: false

nameOptional 

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

Property name: The name of command.

resourceGroupIdOptional 

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

Property resourceGroupId: Resource group id.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to command.

Max support 20 tags to add during create command. Each tag with two properties Key and Value, and Key is required.

timeoutOptional 

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

Property timeout: Total timeout when the command is executed in the instance.

Input the time unit as second. Default is 60s.

workingDirOptional 

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

Property workingDir: The path where command will be executed in the instance.