Skip to content

Command

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,
  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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

typeRequired

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

Property type: The type of command.

command_contentOptional

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

Property commandContent: The content of command.

Content requires base64 encoding. Maximum size support 16KB.

content_encodingOptional

  • 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.

descriptionOptional

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

Property description: The description of command.

enable_parameterOptional

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

Property enableParameter: Specifies whether the script contains custom parameters.

Default value: false

nameOptional

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

Property name: The name of command.

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

tagsOptional

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

  • 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_dirOptional

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

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

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_command_id ros_cdk_core.IResolvable Attribute CommandId: The id of command created.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_command_idRequired 

attr_command_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CommandId: The id of command created.