WaitConditionHandle

This class encapsulates and extends the ROS resource type ALIYUN::ROS::WaitConditionHandle, which is used to receive signals.

You can use ALIYUN::ROS::WaitConditionHandle together with ALIYUN::ROS::WaitCondition to manage the execution process of a stack. When you create an Elastic Compute Service (ECS) instance, a signal is sent during the execution of the user data.

Initializers

import com.aliyun.ros.cdk.ros.WaitConditionHandle;
WaitConditionHandle.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .count(java.lang.Number)
//  .count(IResolvable)
//  .mode(java.lang.String)
//  .mode(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.
count	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property count: There are 3 preconditions that make Count taking effect: 1.Mode is set to Full. 2.Count >= 0. 3.The id of signal is not specified. If so, it will be a self-increasing integer started from 1. For example, the id of the first signal is 1, the id of the second signal is 2, and so on.
mode	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property mode: If set to Increment, all old signals will be deleted before update.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

count^Optional

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

Property count: There are 3 preconditions that make Count taking effect: 1.Mode is set to Full. 2.Count >= 0. 3.The id of signal is not specified. If so, it will be a self-increasing integer started from 1. For example, the id of the first signal is 1, the id of the second signal is 2, and so on.

If Count takes effect, signals with id > Count will be deleted before update. The default value is -1, which means no effect. It is recommended to quote the same value with WaitCondition.Count.

---

mode^Optional

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

Property mode: If set to Increment, all old signals will be deleted before update.

In this mode, WaitCondition.Count should reference an incremental value instead of a full value, such as ScalingGroupEnable.ScalingRuleArisExecuteResultNumberOfAddedInstances.

If set to Full, no old signal will be deleted unless Count is set. In this mode, WaitCondition.Count should reference a full value, such as the same value with InstanceGroup.MaxAmount. It is recommended to use this mode with Count.

Default to Full.

---

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.ros.WaitConditionHandle;
WaitConditionHandle.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.
attrCurlCli	com.aliyun.ros.cdk.core.IResolvable	Attribute CurlCli: Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure.
attrHeaders	com.aliyun.ros.cdk.core.IResolvable	Attribute Headers: HTTP POST Headers used for signalling handle completion or failure.
attrPowerShellCurlCli	com.aliyun.ros.cdk.core.IResolvable	Attribute PowerShellCurlCli: Convenience attribute, provides curl CLI command prefix for PowerShell, which can be used for signalling handle completion or failure.
attrUrl	com.aliyun.ros.cdk.core.IResolvable	Attribute URL: HTTP POST URL used for signalling handle completion or failure.
attrWindowsCurlCli	com.aliyun.ros.cdk.core.IResolvable	Attribute WindowsCurlCli: Convenience attribute, provides curl CLI command prefix for Windows, which can be used for signalling handle completion or failure.

---

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

---

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 for signalling handle completion or failure.

You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}'

---

attrHeaders^Required

public IResolvable getAttrHeaders();

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

Attribute Headers: HTTP POST Headers used for signalling handle completion or failure.

---

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 for signalling handle completion or failure.

As this cmdlet was introduced in PowerShell 3.0, ensure the version of PowerShell satisfies the constraint. (Show the version via $PSVersionTable.PSVersion.) You can signal success by adding -Body '{"status": "SUCCESS"}' , or signal failure by adding -Body '{"status": "FAILURE"}'

---

attrUrl^Required

public IResolvable getAttrUrl();

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

Attribute URL: HTTP POST URL used for signalling handle completion or failure.

---

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 for signalling handle completion or failure.

As Windows does not support curl command, you need to install curl.exe and add it to PATH first. You can signal success by adding --data-binary "{"status": "SUCCESS"}" , or signal failure by adding --data-binary "{"status": "FAILURE"}"

---

Structs