Package software.amazon.awscdk.integtests.alpha

Class WaiterStateMachine.Builder

java.lang.Object

software.amazon.awscdk.integtests.alpha.WaiterStateMachine.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WaiterStateMachine>

Enclosing class:

WaiterStateMachine

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

(experimental) A fluent builder for WaiterStateMachine.

Method Summary

Modifier and Type	Method	Description
WaiterStateMachine.Builder	backoffRate(Number backoffRate)	(experimental) Backoff between attempts.
WaiterStateMachine	build()
static WaiterStateMachine.Builder	create(software.constructs.Construct scope, String id)
WaiterStateMachine.Builder	interval(Duration interval)	(experimental) The interval (number of seconds) to wait between attempts.
WaiterStateMachine.Builder	totalTimeout(Duration totalTimeout)	(experimental) The total time that the state machine will wait for a successful response.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static WaiterStateMachine.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of WaiterStateMachine.Builder.

backoffRate

@Stability(Experimental)
public WaiterStateMachine.Builder backoffRate(Number backoffRate)

(experimental) Backoff between attempts.

This is the multiplier by which the retry interval increases after each retry attempt.

By default there is no backoff. Each retry will wait the amount of time specified by interval.

Default: 1 (no backoff)

Parameters:

backoffRate - Backoff between attempts. This parameter is required.

Returns:

this

interval

@Stability(Experimental)
public WaiterStateMachine.Builder interval(Duration interval)

(experimental) The interval (number of seconds) to wait between attempts.

Default: Duration.seconds(5)

Parameters:

interval - The interval (number of seconds) to wait between attempts. This parameter is required.

Returns:

this

totalTimeout

@Stability(Experimental)
public WaiterStateMachine.Builder totalTimeout(Duration totalTimeout)

(experimental) The total time that the state machine will wait for a successful response.

Default: Duration.minutes(30)

Parameters:

totalTimeout - The total time that the state machine will wait for a successful response. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public WaiterStateMachine build()

Specified by:

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

Returns:

a newly built instance of WaiterStateMachine.