WaitCondition
- Implements: IWaitCondition
This class encapsulates and extends the ROS resource type ALIYUN::ROS::WaitCondition, which is used to wait for signals.
You can use ALIYUN::ROS::WaitCondition together with ALIYUN::ROS::WaitConditionHandle 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.WaitCondition;
WaitCondition.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.handle(java.lang.String)
.handle(IResolvable)
.timeout(java.lang.Number)
.timeout(IResolvable)
// .count(java.lang.Number)
// .count(IResolvable)
// .showProgressEvent(java.lang.String)
// .showProgressEvent(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. |
handle | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property handle: A reference to the wait condition handle used to signal this wait condition. |
timeout | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property timeout: The number of seconds to wait for the correct number of signals to arrive. |
count | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property count: The number of success signals that must be received before the stack creation process continues. |
showProgressEvent | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property showProgressEvent: Whether to generate progress changed event. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
handleRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property handle: A reference to the wait condition handle used to signal this wait condition.
timeoutRequired
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property timeout: The number of seconds to wait for the correct number of signals to arrive.
countOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property count: The number of success signals that must be received before the stack creation process continues.
showProgressEventOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property showProgressEvent: Whether to generate progress changed event.
Default to Disabled.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.ros.WaitCondition;
WaitCondition.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrData | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Data: JSON serialized dict containing data associated with wait condition signals sent to the handle. |
attrErrorData | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ErrorData: JSON serialized dict containing data associated with wait condition error signals sent to the handle. |
attrJoinedErrorData | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute JoinedErrorData: String containing data associated with wait condition error signals sent to the handle. |
props | WaitConditionProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrDataRequired
public java.lang.Object getAttrData();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Data: JSON serialized dict containing data associated with wait condition signals sent to the handle.
attrErrorDataRequired
public java.lang.Object getAttrErrorData();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ErrorData: JSON serialized dict containing data associated with wait condition error signals sent to the handle.
attrJoinedErrorDataRequired
public java.lang.Object getAttrJoinedErrorData();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute JoinedErrorData: String containing data associated with wait condition error signals sent to the handle.
propsRequired
public WaitConditionProps getProps();
- Type: WaitConditionProps