Package software.amazon.awscdk.integtests.alpha

Interface WaiterStateMachineOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

WaiterStateMachineProps

All Known Implementing Classes:

WaiterStateMachineOptions.Jsii$Proxy, WaiterStateMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.296Z")
@Stability(Experimental)
public interface WaiterStateMachineOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for creating a WaiterStateMachine.

Example:

 IntegTest testCase;
 IApiCall start;
 IApiCall describe = testCase.assertions.awsApiCall("StepFunctions", "describeExecution", Map.of(
         "executionArn", start.getAttString("executionArn"))).expect(ExpectedResult.objectLike(Map.of(
         "status", "SUCCEEDED"))).waitForAssertions(WaiterStateMachineOptions.builder()
         .totalTimeout(Duration.minutes(5))
         .interval(Duration.seconds(15))
         .backoffRate(3)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WaiterStateMachineOptions.Builder	builder()
default Number	getBackoffRate()	(experimental) Backoff between attempts.
default Duration	getInterval()	(experimental) The interval (number of seconds) to wait between attempts.
default Duration	getTotalTimeout()	(experimental) The total time that the state machine will wait for a successful response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackoffRate

@Stability(Experimental)
@Nullable
default Number getBackoffRate()

(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)

getInterval

@Stability(Experimental)
@Nullable
default Duration getInterval()

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

Default: Duration.seconds(5)

getTotalTimeout

@Stability(Experimental)
@Nullable
default Duration getTotalTimeout()

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

Default: Duration.minutes(30)

builder

@Stability(Experimental)
static WaiterStateMachineOptions.Builder builder()

Returns:

a WaiterStateMachineOptions.Builder of WaiterStateMachineOptions