Command

• Implements: ICommand

This class encapsulates and extends the ROS resource type ALIYUN::ECS::Command, which is used to create a Cloud Assistant command.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.Command(
  scope: Construct,
  id: str,
  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,
  launcher: typing.Union[str, 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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

type^Required

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

Property type: The type of command.

command_content^Optional

• 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

• 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

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

Property description: The description of command.

enable_parameter^Optional

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

Property enableParameter: Specifies whether the script contains custom parameters.

Default value: false

launcher^Optional

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

Property launcher: A bootloader for script execution.

The length cannot exceed 1 KB.

name^Optional

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

Property name: The name of command.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

tags^Optional

• 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

• 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

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

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_command_id^Required

attr_command_id: typing.Union[str, IResolvable]

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

Attribute CommandId: The id of command created.

props^Required

props: CommandProps

• Type: CommandProps