Execution

• Implements: IExecution

This class encapsulates and extends the ROS resource type ALIYUN::OOS::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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

description^Optional

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

Property description: The description of OOS Execution.

loop_mode^Optional

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

mode^Optional

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

Property mode: Execution mode.

parameters^Optional

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

Property parameters: Parameters for the execution of template.

parent_execution_id^Optional

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

Property parentExecutionId: Parent execution ID.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

resource_options^Optional

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

Property resourceOptions: Resource options user by ROS.

safety_check^Optional

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

tags^Optional

• 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_content^Optional

• 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_name^Optional

• 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_url^Optional

• 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_version^Optional

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

Property templateVersion: Version number of template.

Default to the latest version.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

import ros_cdk_oos
ros_cdk_oos.Execution.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attr_counters: typing.Union[str, IResolvable]

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

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

attr_curl_cli^Required

attr_curl_cli: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_id^Required

attr_execution_id: typing.Union[str, IResolvable]

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

Attribute ExecutionId: Execution ID.

attr_outputs^Required

attr_outputs: typing.Union[str, IResolvable]

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

Attribute Outputs: Execution output.

attr_power_shell_curl_cli^Required

attr_power_shell_curl_cli: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_status^Required

attr_status: typing.Union[str, IResolvable]

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

Attribute Status: Execution status.

attr_status_message^Required

attr_status_message: typing.Union[str, IResolvable]

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

Attribute StatusMessage: Execution status information.

attr_windows_curl_cli^Required

attr_windows_curl_cli: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

props^Required

props: ExecutionProps

• Type: ExecutionProps