software.amazon.awscdk.services.cloudformation

Class CfnWaitCondition.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnWaitCondition.Builder

Enclosing class:

CfnWaitCondition

public static final class CfnWaitCondition.Builder
extends java.lang.Object

A fluent builder for CfnWaitCondition.

Method Summary

Modifier and Type	Method and Description
CfnWaitCondition	build()
CfnWaitCondition.Builder	count(java.lang.Number count) The number of success signals that CloudFormation must receive before it continues the stack creation process.
static CfnWaitCondition.Builder	create(Construct scope, java.lang.String id)
CfnWaitCondition.Builder	handle(java.lang.String handle) A reference to the wait condition handle used to signal this wait condition.
CfnWaitCondition.Builder	timeout(java.lang.String timeout) The length of time (in seconds) to wait for the number of signals that the `Count` property specifies.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnWaitCondition.Builder create(Construct scope,
                                              java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnWaitCondition.Builder.

count

public CfnWaitCondition.Builder count(java.lang.Number count)

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.

Parameters:

count - The number of success signals that CloudFormation must receive before it continues the stack creation process. This parameter is required.

Returns:

this

handle

public CfnWaitCondition.Builder handle(java.lang.String handle)

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.

Parameters:

handle - A reference to the wait condition handle used to signal this wait condition. This parameter is required.

Returns:

this

timeout

public CfnWaitCondition.Builder timeout(java.lang.String timeout)

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.

Parameters:

timeout - The length of time (in seconds) to wait for the number of signals that the `Count` property specifies. This parameter is required.

Returns:

this

build

public CfnWaitCondition build()