Command

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::Command, which is used to query an available command that is manually created.

Initializers

from ros_cdk_ecs import datasource
datasource.Command(
  scope: Construct,
  id: str,
  command_id: typing.Union[str, IResolvable],
  refresh_options: 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.
command_id	typing.Union[str, ros_cdk_core.IResolvable]	Property commandId: Command ID.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

command_id^Required

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

Property commandId: Command ID.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

enable_resource_property_constraint^Optional

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

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

---

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

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

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• 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_content	ros_cdk_core.IResolvable	Attribute CommandContent: Command content, encoded in Base64 and transmitted.
attr_command_id	ros_cdk_core.IResolvable	Attribute CommandId: Command ID.
attr_command_name	ros_cdk_core.IResolvable	Attribute CommandName: Command name.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: Command creation time.
attr_description	ros_cdk_core.IResolvable	Attribute Description: Command description.
attr_enable_parameter	ros_cdk_core.IResolvable	Attribute EnableParameter: Whether to use parameters.
attr_parameter_names	ros_cdk_core.IResolvable	Attribute ParameterNames: Parameter name.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The label information of the command.
attr_timeout	ros_cdk_core.IResolvable	Attribute Timeout: Timeout.
attr_type	ros_cdk_core.IResolvable	Attribute Type: Command type.
attr_working_dir	ros_cdk_core.IResolvable	Attribute WorkingDir: Execution path.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_content^Required

attr_command_content: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CommandContent: Command content, encoded in Base64 and transmitted.

---

attr_command_id^Required

attr_command_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CommandId: Command ID.

---

attr_command_name^Required

attr_command_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CommandName: Command name.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: Command creation time.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: Command description.

---

attr_enable_parameter^Required

attr_enable_parameter: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EnableParameter: Whether to use parameters.

---

attr_parameter_names^Required

attr_parameter_names: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ParameterNames: Parameter name.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The label information of the command.

---

attr_timeout^Required

attr_timeout: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Timeout: Timeout.

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: Command type.

---

attr_working_dir^Required

attr_working_dir: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute WorkingDir: Execution path.

---