Execution

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

Initializers

import com.aliyun.ros.cdk.oos.Execution;
Execution.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .loopMode(java.lang.String)
//  .loopMode(IResolvable)
//  .mode(java.lang.String)
//  .mode(IResolvable)
//  .parameters(IResolvable)
//  .parameters(java.util.Map<java.lang.String, java.lang.Object>)
//  .parentExecutionId(java.lang.String)
//  .parentExecutionId(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .resourceOptions(IResolvable)
//  .resourceOptions(ResourceOptionsProperty)
//  .safetyCheck(java.lang.String)
//  .safetyCheck(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .templateContent(java.lang.String)
//  .templateContent(IResolvable)
//  .templateName(java.lang.String)
//  .templateName(IResolvable)
//  .templateUrl(java.lang.String)
//  .templateUrl(IResolvable)
//  .templateVersion(java.lang.String)
//  .templateVersion(IResolvable)
    .build();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: The description of OOS Execution.
`loopMode`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property loopMode: The loop mode of OOS Execution.
`mode`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property mode: Execution mode.
`parameters`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.Map`	Property parameters: Parameters for the execution of template.
`parentExecutionId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property parentExecutionId: Parent execution ID.
`resourceGroupId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property resourceGroupId: Resource group id.
`resourceOptions`	`com.aliyun.ros.cdk.core.IResolvable OR ResourceOptionsProperty`	Property resourceOptions: Resource options user by ROS.
`safetyCheck`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property safetyCheck: Security check mode.
`tags`	`java.util.Map`	Property tags: Tag value and the key mapping, the label of the key number can be up to 20.
`templateContent`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property templateContent: The content of the template in the JSON or YAML format.
`templateName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property templateName: Template name.
`templateUrl`	`java.lang.String OR com.aliyun.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.
`templateVersion`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property templateVersion: Version number of template.

`scope`^Required

Type: com.aliyun.ros.cdk.core.Construct

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`description`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of OOS Execution.

`loopMode`^Optional

Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property mode: Execution mode.

`parameters`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property parameters: Parameters for the execution of template.

`parentExecutionId`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property parentExecutionId: Parent execution ID.

`resourceGroupId`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

`resourceOptions`^Optional

Type: com.aliyun.ros.cdk.core.IResolvable OR ResourceOptionsProperty

Property resourceOptions: Resource options user by ROS.

`safetyCheck`^Optional

Type: java.lang.String OR com.aliyun.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: java.util.Map

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

`templateContent`^Optional

Type: java.lang.String OR com.aliyun.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.

`templateName`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateName: Template name.

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

`templateUrl`^Optional

Type: java.lang.String OR com.aliyun.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.

`templateVersion`^Optional

Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateVersion: Version number of template.

Default to the latest version.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`synthesize`

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

Type: com.aliyun.ros.cdk.core.RosCondition

`addCount`

public void addCount(java.lang.Number OR IResolvable count)

count^Required

Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

Type: com.aliyun.ros.cdk.core.RemovalPolicy

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.oos.Execution;
Execution.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrCounters`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Counters: Task statistics: FailedTasks, SuccessTasks, TotalTasks.
`attrCurlCli`	`com.aliyun.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.
`attrExecutionId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute ExecutionId: Execution ID.
`attrOutputs`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Outputs: Execution output.
`attrPowerShellCurlCli`	`com.aliyun.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.
`attrStatus`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Status: Execution status.
`attrStatusMessage`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute StatusMessage: Execution status information.
`attrWindowsCurlCli`	`com.aliyun.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.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrCounters`^Required

public IResolvable getAttrCounters();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrCurlCli`^Required

public IResolvable getAttrCurlCli();

Type: com.aliyun.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.

`attrExecutionId`^Required

public IResolvable getAttrExecutionId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExecutionId: Execution ID.

`attrOutputs`^Required

public IResolvable getAttrOutputs();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Outputs: Execution output.

`attrPowerShellCurlCli`^Required

public IResolvable getAttrPowerShellCurlCli();

Type: com.aliyun.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.

`attrStatus`^Required

public IResolvable getAttrStatus();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Status: Execution status.

`attrStatusMessage`^Required

public IResolvable getAttrStatusMessage();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StatusMessage: Execution status information.

`attrWindowsCurlCli`^Required

public IResolvable getAttrWindowsCurlCli();

Type: com.aliyun.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.

Execution

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

descriptionOptional

loopModeOptional

modeOptional

parametersOptional

parentExecutionIdOptional

resourceGroupIdOptional

resourceOptionsOptional

safetyCheckOptional

tagsOptional

templateContentOptional

templateNameOptional

templateUrlOptional

templateVersionOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata