Skip to content

ExecutionProps

Properties for defining a Execution.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-oos-execution

Initializer

import ros_cdk_oos
ros_cdk_oos.ExecutionProps(
  description: typing.Union[str, IResolvable] = None,
  loop_mode: typing.Union[str, IResolvable] = None,
  mode: typing.Union[str, IResolvable] = None,
  parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  parent_execution_id: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  resource_options: typing.Union[IResolvable, ResourceOptionsProperty] = None,
  safety_check: typing.Union[str, IResolvable] = None,
  tags: typing.Mapping[typing.Any] = None,
  template_content: typing.Union[str, IResolvable] = None,
  template_name: typing.Union[str, IResolvable] = None,
  template_url: typing.Union[str, IResolvable] = None,
  template_version: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of OOS Execution.
loop_mode typing.Union[str, ros_cdk_core.IResolvable] Property loopMode: The loop mode of OOS Execution.
mode typing.Union[str, ros_cdk_core.IResolvable] Property mode: The execution mode.
parameters typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property parameters: The JSON string that consists of a collection of parameters.
parent_execution_id typing.Union[str, ros_cdk_core.IResolvable] Property parentExecutionId: The ID of the parent execution.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
resource_options typing.Union[ros_cdk_core.IResolvable, ResourceOptionsProperty] Property resourceOptions: Resource options user by ROS.
safety_check typing.Union[str, ros_cdk_core.IResolvable] Property safetyCheck: Security check mode.
tags typing.Mapping[typing.Any] Property tags: Tag value and the key mapping, the label of the key number can be up to 20.
template_content typing.Union[str, ros_cdk_core.IResolvable] Property templateContent: The content of the template in the JSON or YAML format.
template_name typing.Union[str, ros_cdk_core.IResolvable] Property templateName: The name of the template.
template_url typing.Union[str, ros_cdk_core.IResolvable] Property templateUrl: The Object Storage Service (OSS) URL of the object that stores the content of the Operation Orchestration Service (OOS) template.
template_version typing.Union[str, ros_cdk_core.IResolvable] Property templateVersion: Version number of template.

descriptionOptional

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

Property description: The description of OOS Execution.


loop_modeOptional

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

Property loopMode: The loop mode of OOS Execution.

Valid values:

  • Automatic(Default): does not pause.
  • FirstBatchPause: The first batch of pauses.
  • EveryBatchPause: pause each batch.

modeOptional

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

Property mode: The execution mode.

Valid values:

  • Automatic (default): The execution is automatically run.
  • FailurePause: The execution is paused if a task fails.
  • Debug: The execution is run in single-step mode.

parametersOptional

parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property parameters: The JSON string that consists of a collection of parameters.

The default value is {}.


parent_execution_idOptional

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

Property parentExecutionId: The ID of the parent execution.


resource_group_idOptional

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

Property resourceGroupId: Resource group id.


resource_optionsOptional

resource_options: typing.Union[IResolvable, ResourceOptionsProperty]

Property resourceOptions: Resource options user by ROS.


safety_checkOptional

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

Property safetyCheck: Security check mode.

Allowed values:

  • Skip (default): This option means that customers understand the risks, you can do anything without confirmation Action, no matter what the level of risk. It takes effect only if Mode is Automatic.
  • ConfirmEveryHighRiskAction: This option would require customers to confirm each Action a high risk. NotifyExecution by calling customer interface to confirm or cancel.

tagsOptional

tags: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

Property tags: Tag value and the key mapping, the label of the key number can be up to 20.


template_contentOptional

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

Property templateContent: The content of the template in the JSON or YAML format.

This parameter is the same as the Content parameter that you can specify when you call the CreateTemplate operation. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.


template_nameOptional

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

Property templateName: The name of the template.

The name can contain letters, digits, hyphens (-), and underscores (_). The name can be up to 200 characters in length.


template_urlOptional

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

Property templateUrl: The Object Storage Service (OSS) URL of the object that stores the content of the Operation Orchestration Service (OOS) template.

The access control list (ACL) of the object must be public-read. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.


template_versionOptional

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

Property templateVersion: Version number of template.

Default to the latest version.