Skip to content

Execution

This class encapsulates and extends the ROS resource type ALIYUN::OOS::Execution, which is used to start an execution.

Initializers 

import ros_cdk_oos
ros_cdk_oos.Execution(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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: Execution mode.
parameters typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property parameters: Parameters for the execution of template.
parent_execution_id typing.Union[str, ros_cdk_core.IResolvable] Property parentExecutionId: Parent execution ID.
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: Template name.
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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

descriptionOptional

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

Property description: The description of OOS Execution.

loop_modeOptional

  • 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

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

Property mode: Execution mode.

parametersOptional

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

Property parameters: Parameters for the execution of template.

parent_execution_idOptional

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

Property parentExecutionId: Parent execution ID.

resource_group_idOptional

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

Property resourceGroupId: Resource group id.

resource_optionsOptional

Property resourceOptions: Resource options user by ROS.

safety_checkOptional

  • 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

  • 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

  • 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

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

Property templateName: Template name.

Content is limited to letters, numbers, underlined, underline, the length of 200 characters.

template_urlOptional

  • 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

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

Property templateVersion: Version number of template.

Default to the latest version.

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_oos
ros_cdk_oos.Execution.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_counters ros_cdk_core.IResolvable Attribute Counters: Task statistics: FailedTasks, SuccessTasks, TotalTasks.
attr_curl_cli ros_cdk_core.IResolvable Attribute CurlCli: Convenience attribute, provides curl CLI command prefix, which can be used to notify oos execution instead of OOS API NotifyExecution.
attr_execution_id ros_cdk_core.IResolvable Attribute ExecutionId: Execution ID.
attr_outputs ros_cdk_core.IResolvable Attribute Outputs: Execution output.
attr_power_shell_curl_cli ros_cdk_core.IResolvable Attribute PowerShellCurlCli: Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used to notify oos execution instead of OOS API NotifyExecution.
attr_status ros_cdk_core.IResolvable Attribute Status: Execution status.
attr_status_message ros_cdk_core.IResolvable Attribute StatusMessage: Execution status information.
attr_windows_curl_cli ros_cdk_core.IResolvable Attribute WindowsCurlCli: Convenience attribute, provides curl CLI command prefix for Windows, which can be used to notify oos execution instead of OOS API NotifyExecution.

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_countersRequired 

attr_counters: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Counters: Task statistics: FailedTasks, SuccessTasks, TotalTasks.

attr_curl_cliRequired 

attr_curl_cli: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CurlCli: Convenience attribute, provides curl CLI command prefix, which can be used to notify oos execution instead of OOS API NotifyExecution.

You can notify approve to oos execution by adding --data-binary '{"data": {"NotifyType": "Approve"}}' For more parameters in data, refer to https://help.aliyun.com/document_detail/120777.html. You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.

attr_execution_idRequired 

attr_execution_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExecutionId: Execution ID.

attr_outputsRequired 

attr_outputs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Outputs: Execution output.

attr_power_shell_curl_cliRequired 

attr_power_shell_curl_cli: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PowerShellCurlCli: Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used to notify oos execution instead of OOS API NotifyExecution.

You can notify approve to oos execution by adding -Body '{"data": {"NotifyType": "Approve"}}' For more parameters in data, refer to https://help.aliyun.com/document_detail/120777.html.You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.

attr_statusRequired 

attr_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Status: Execution status.

attr_status_messageRequired 

attr_status_message: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StatusMessage: Execution status information.

attr_windows_curl_cliRequired 

attr_windows_curl_cli: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute WindowsCurlCli: Convenience attribute, provides curl CLI command prefix for Windows, which can be used to notify oos execution instead of OOS API NotifyExecution.

You can notify approve to oos execution by adding --data-binary "{"data": {"NotifyType": "Approve"}}" For more parameters in data, refer to https://help.aliyun.com/document_detail/120777.html.You can also notify execution via ROS API SignalResource. API parameters Status and UniqueId are ignored. Use API parameter Data to pass data.