@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:20.541Z")
public class CfnWaitCondition
extends CfnResource
implements IInspectable
For Amazon EC2 and Auto Scaling resources, we recommend that you use a
CreationPolicyattribute instead of wait conditions. Add a CreationPolicy attribute to those resources, and use the cfn-signal helper script to signal when an instance creation process has completed successfully.
You can use a wait condition for situations like the following:
For these situations, we recommend that you associate a CreationPolicy attribute with the wait condition so that you don't have to use a wait condition handle. For more information and an example, see Creating wait conditions in a template . If you use a CreationPolicy with a wait condition, don't specify any of the wait condition's properties.
If you use the VPC endpoints feature, resources in the VPC that respond to wait conditions must have access to CloudFormation , specific Amazon Simple Storage Service ( Amazon S3 ) buckets. Resources must send wait condition responses to a presigned Amazon S3 URL. If they can't send responses to Amazon S3 , CloudFormation won't receive a response and the stack operation fails. For more information, see Setting up VPC endpoints for AWS CloudFormation .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.core.*;
CfnWaitCondition cfnWaitCondition = CfnWaitCondition.Builder.create(this, "MyCfnWaitCondition")
.count(123)
.handle("handle")
.timeout("timeout")
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnWaitCondition.Builder
A fluent builder for
CfnWaitCondition. |
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnWaitCondition(Construct scope,
java.lang.String id)
Create a new `AWS::CloudFormation::WaitCondition`.
|
|
CfnWaitCondition(Construct scope,
java.lang.String id,
CfnWaitConditionProps props)
Create a new `AWS::CloudFormation::WaitCondition`.
|
protected |
CfnWaitCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnWaitCondition(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
IResolvable |
getAttrData()
A JSON object that contains the `UniqueId` and `Data` values from the wait condition signal(s) for the specified wait condition.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Number |
getCount()
The number of success signals that CloudFormation must receive before it continues the stack creation process.
|
java.lang.String |
getHandle()
A reference to the wait condition handle used to signal this wait condition.
|
java.lang.String |
getTimeout()
The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCount(java.lang.Number value)
The number of success signals that CloudFormation must receive before it continues the stack creation process.
|
void |
setHandle(java.lang.String value)
A reference to the wait condition handle used to signal this wait condition.
|
void |
setTimeout(java.lang.String value)
The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnWaitCondition(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnWaitCondition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnWaitCondition(Construct scope, java.lang.String id, CfnWaitConditionProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties.public CfnWaitCondition(Construct scope, java.lang.String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public IResolvable getAttrData()
For more information about wait condition signals, see Wait condition signal JSON format .
Example return value for a wait condition with 2 signals:
{ "Signal1" : "Step 1 complete." , "Signal2" : "Step 2 complete." }
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic java.lang.Number getCount()
When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.
Updates aren't supported.
public void setCount(java.lang.Number value)
When the wait condition receives the requisite number of success signals, CloudFormation resumes the creation of the stack. If the wait condition doesn't receive the specified number of success signals before the Timeout period expires, CloudFormation assumes that the wait condition has failed and rolls the stack back.
Updates aren't supported.
public java.lang.String getHandle()
Use the Ref intrinsic function to specify an AWS::CloudFormation::WaitConditionHandle resource.
Anytime you add a WaitCondition resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.
Updates aren't supported.
public void setHandle(java.lang.String value)
Use the Ref intrinsic function to specify an AWS::CloudFormation::WaitConditionHandle resource.
Anytime you add a WaitCondition resource during a stack update, you must associate the wait condition with a new WaitConditionHandle resource. Don't reuse an old wait condition handle that has already been defined in the template. If you reuse a wait condition handle, the wait condition might evaluate old signals from a previous create or update stack command.
Updates aren't supported.
public java.lang.String getTimeout()
Timeout is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).
Updates aren't supported.
public void setTimeout(java.lang.String value)
Timeout is a minimum-bound property, meaning the timeout occurs no sooner than the time you specify, but can occur shortly thereafter. The maximum time that can be specified for this property is 12 hours (43200 seconds).
Updates aren't supported.