software.amazon.awscdk.services.cloudformation

Interface CfnWaitConditionProps

All Known Implementing Classes:

CfnWaitConditionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:55.243Z")
public interface CfnWaitConditionProps

Properties for defining a `CfnWaitCondition`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnWaitConditionProps cfnWaitConditionProps = CfnWaitConditionProps.builder()
         .count(123)
         .handle("handle")
         .timeout("timeout")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnWaitConditionProps.Builder A builder for CfnWaitConditionProps
static class	CfnWaitConditionProps.Jsii$Proxy An implementation for CfnWaitConditionProps

Method Summary

Modifier and Type	Method and Description
static CfnWaitConditionProps.Builder	builder()
default java.lang.Number	getCount() The number of success signals that CloudFormation must receive before it continues the stack creation process.
default java.lang.String	getHandle() A reference to the wait condition handle used to signal this wait condition.
default java.lang.String	getTimeout() The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.

Method Detail

getCount

default java.lang.Number getCount()

The number of success signals that CloudFormation must receive before it continues the stack creation process.

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.

getHandle

default java.lang.String getHandle()

A reference to the wait condition handle used to signal this wait condition.

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.

getTimeout

default java.lang.String getTimeout()

The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.

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.

builder

static CfnWaitConditionProps.Builder builder()

Returns:

a CfnWaitConditionProps.Builder of CfnWaitConditionProps