InvocationProps
Properties for defining a Invocation.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-invocation
Initializer
import ros_cdk_ecs
ros_cdk_ecs.InvocationProps(
instance_ids: typing.Union[typing.List[typing.Any], IResolvable],
command_id: typing.Union[str, IResolvable] = None,
command_name: typing.Union[str, IResolvable] = None,
container_id: typing.Union[str, IResolvable] = None,
container_name: typing.Union[str, IResolvable] = None,
frequency: typing.Union[str, IResolvable] = None,
parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
repeat_mode: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
sync: typing.Union[bool, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
username: typing.Union[str, IResolvable] = None,
windows_password_name: typing.Union[str, IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
instance_ids |
typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] |
Property instanceIds: The instance id list. |
command_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property commandId: The id of command. |
command_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property commandName: The name of command. |
container_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property containerId: The ID of the container. |
container_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property containerName: The name of the container. |
frequency |
typing.Union[str, ros_cdk_core.IResolvable] |
Property frequency: The frequency of timing execution (the shortest frequency is performed every 1 minute). |
parameters |
typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] |
Property parameters: The key-value pairs of custom parameters passed in when the script contains custom parameters. |
repeat_mode |
typing.Union[str, ros_cdk_core.IResolvable] |
Property repeatMode: Specifies how to run the command. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: The ID of the resource group to which to assign the command executions. |
sync |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property sync: Whether to invoke synchronously. |
tags |
typing.List[TagsProperty] |
Property tags: Tags to attach to invocation. |
timeout |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property timeout: The timeout period for the command execution. |
username |
typing.Union[str, ros_cdk_core.IResolvable] |
Property username: The username to use to run the command on instances. |
windows_password_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property windowsPasswordName: The name of the password to use to run the command on Windows instances. |
instance_idsRequired
instance_ids: typing.Union[typing.List[typing.Any], IResolvable]
- Type: typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable]
Property instanceIds: The instance id list.
Instances status must be running.
command_idOptional
command_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property commandId: The id of command.
command_nameOptional
command_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property commandName: The name of command.
Only system commands whose provide is AlibabaCloud are supported
container_idOptional
container_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property containerId: The ID of the container.
Only 64-bit hexadecimal strings are supported. You can use container IDs that are prefixed with docker://, containerd://, or cri-o:// to specify container runtimes. Take note of the following items:
- If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
- If you specify this parameter, make sure that the version of Cloud Assistant Agent installed on Linux instances is 2.2.3.344 or later.- If you specify this parameter, Username that is specified in a request to call this operation and WorkingDir that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container.
- If you specify this parameter, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter.
container_nameOptional
container_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property containerName: The name of the container.
Take note of the following items:
- If you specify this parameter, Cloud Assistant runs scripts in the specified container of the instance.
- If you specify this parameter, make sure that the version of Cloud Assistant Agent installed on Linux instances is 2.2.3.344 or later.
- If you specify this parameter, Username that is specified in a request to call this operation and WorkingDir that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container.
- If you specify this parameter, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter.
frequencyOptional
frequency: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property frequency: The frequency of timing execution (the shortest frequency is performed every 1 minute).
It iss mandatory when Timing is True.The value rule follows the rules of the cron expression.
parametersOptional
parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]]
- Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]
Property parameters: The key-value pairs of custom parameters passed in when the script contains custom parameters.
Number of custom parameters: 0 to 10. The key cannot be an empty string. It can be up to 64 characters in length. The value can be an empty string. After the custom parameters and the original script content are Base64 encoded, the total size cannot exceed 16 KB. The set of custom parameter names must be a subset of the parameter set that is defined when you created the script. You can use an empty string to represent the parameters that are not passed in. Default value: null, indicating that this parameter is canceled and customer parameters are disabled.
repeat_modeOptional
repeat_mode: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property repeatMode: Specifies how to run the command.
Valid values:
- Once: immediately runs the command.
- Period: runs the command on a schedule. If you set this parameter to Period, you must specify Frequency.
- NextRebootOnly: runs the command the next time the instance is started.
- *EveryReboot: runs the command every time the instance is started. Default value:
- If you do not specify Frequency, the default value is Once.
- If you specify Frequency, Period is used as the value of RepeatMode regardless of whether RepeatMode is set to Period.
resource_group_idOptional
resource_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group to which to assign the command executions.
The instances specified by InstanceIds must belong to the specified resource group.
syncOptional
sync: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property sync: Whether to invoke synchronously.
tagsOptional
tags: typing.List[TagsProperty]
- Type: typing.List[TagsProperty]
Property tags: Tags to attach to invocation.
Max support 20 tags to add during create invocation. Each tag with two properties Key and Value, and Key is required.
timeoutOptional
timeout: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property timeout: The timeout period for the command execution.
Unit: seconds.
- The timeout period cannot be less than 10 seconds.
- A timeout error occurs if the command cannot be run because the process slows down or because a specific module or Cloud Assistant Agent does not exist. When the specified timeout period ends, the command process is forcefully terminated.
- If you do not specify this parameter, the timeout period that is specified when the command is created is used.
- This timeout period is applicable only to this execution. The timeout period of the command is not modified.
usernameOptional
username: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property username: The username to use to run the command on instances.
The username can be up to 255 characters in length.
- For Linux instances, the root username is used by default.
- For Windows instances, the System username is used by default. You can also specify other usernames that already exist in the instances to run the command. For security purposes, we recommend that you run Cloud Assistant commands as a regular user.
windows_password_nameOptional
windows_password_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property windowsPasswordName: The name of the password to use to run the command on Windows instances.
The name can be up to 255 characters in length. If you do not want to use the default System user to run the command on Windows instances, specify both WindowsPasswordName and Username. To mitigate the risk of password leaks, the password is stored in plaintext in Operation Orchestration Service (OOS) Parameter Store, and only the name of the password is passed in by using WindowsPasswordName.