Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnWaitConditionPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnWaitConditionPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWaitConditionPropsMixin>

Enclosing class:

CfnWaitConditionPropsMixin

@Stability(Stable)
public static final class CfnWaitConditionPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWaitConditionPropsMixin>

A fluent builder for CfnWaitConditionPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnWaitConditionPropsMixin	build()
CfnWaitConditionPropsMixin.Builder	count(Number count)	The number of success signals that CloudFormation must receive before it continues the stack creation process.
static CfnWaitConditionPropsMixin.Builder	create()
static CfnWaitConditionPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnWaitConditionPropsMixin.Builder	handle(String handle)	A reference to the wait condition handle used to signal this wait condition.
CfnWaitConditionPropsMixin.Builder	timeout(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 Details

create

@Stability(Stable)
public static CfnWaitConditionPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnWaitConditionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnWaitConditionPropsMixin.Builder create()

Returns:

a new instance of CfnWaitConditionPropsMixin.Builder.

count

@Stability(Stable)
public CfnWaitConditionPropsMixin.Builder count(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-waitcondition.html#cfn-cloudformation-waitcondition-count

handle

@Stability(Stable)
public CfnWaitConditionPropsMixin.Builder handle(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-waitcondition.html#cfn-cloudformation-waitcondition-handle

timeout

@Stability(Stable)
public CfnWaitConditionPropsMixin.Builder timeout(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-waitcondition.html#cfn-cloudformation-waitcondition-timeout

build

@Stability(Stable)
public CfnWaitConditionPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnWaitConditionPropsMixin>

Returns:

a newly built instance of CfnWaitConditionPropsMixin.