Execution

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

Initializers

import { Execution } from '@alicloud/ros-cdk-oos'
new Execution(scope: Construct, id: string, props?: ExecutionProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	ExecutionProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Optional

• Type: ExecutionProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { Execution } from '@alicloud/ros-cdk-oos'
Execution.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

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

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrCounters^Required

public readonly attrCounters: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrCurlCli^Required

public readonly attrCurlCli: IResolvable;

• Type: @alicloud/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 readonly attrExecutionId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExecutionId: Execution ID.

---

attrOutputs^Required

public readonly attrOutputs: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Outputs: Execution output.

---

attrPowerShellCurlCli^Required

public readonly attrPowerShellCurlCli: IResolvable;

• Type: @alicloud/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 readonly attrStatus: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Status: Execution status.

---

attrStatusMessage^Required

public readonly attrStatusMessage: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute StatusMessage: Execution status information.

---

attrWindowsCurlCli^Required

public readonly attrWindowsCurlCli: IResolvable;

• Type: @alicloud/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.

---