CommandProps

Properties for defining a Command.

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

Initializer

import ros_cdk_ecs
ros_cdk_ecs.CommandProps(
  type: typing.Union[str, IResolvable],
  command_content: typing.Union[str, IResolvable] = None,
  content_encoding: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enable_parameter: typing.Union[bool, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  working_dir: typing.Union[str, IResolvable] = None
)

Properties

Name	Type	Description
type	typing.Union[str, ros_cdk_core.IResolvable]	Property type: The type of command.
command_content	typing.Union[str, ros_cdk_core.IResolvable]	Property commandContent: The content of command.
content_encoding	typing.Union[str, ros_cdk_core.IResolvable]	Property contentEncoding: The encoding mode of script content (CommandContent).
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of command.
enable_parameter	typing.Union[bool, ros_cdk_core.IResolvable]	Property enableParameter: Specifies whether the script contains custom parameters.
name	typing.Union[str, ros_cdk_core.IResolvable]	Property name: The name of command.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group id.
tags	typing.List[TagsProperty]	Property tags: Tags to attach to command.
timeout	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property timeout: Total timeout when the command is executed in the instance.
working_dir	typing.Union[str, ros_cdk_core.IResolvable]	Property workingDir: The path where command will be executed in the instance.

---

type^Required

type: typing.Union[str, IResolvable]

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

Property type: The type of command.

---

command_content^Optional

command_content: typing.Union[str, IResolvable]

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

Property commandContent: The content of command.

Content requires base64 encoding. Maximum size support 16KB.

---

content_encoding^Optional

content_encoding: typing.Union[str, IResolvable]

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

---

description^Optional

description: typing.Union[str, IResolvable]

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

Property description: The description of command.

---

enable_parameter^Optional

enable_parameter: typing.Union[bool, IResolvable]

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

Property enableParameter: Specifies whether the script contains custom parameters.

Default value: false

---

name^Optional

name: typing.Union[str, IResolvable]

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

Property name: The name of command.

---

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

Property resourceGroupId: Resource group id.

---

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[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.

---

timeout^Optional

timeout: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

---

working_dir^Optional

working_dir: typing.Union[str, IResolvable]

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

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

---