WaiterStateMachineOptions

class aws_cdk.integ_tests_alpha.WaiterStateMachineOptions(*, backoff_rate=None, interval=None, total_timeout=None)

Bases: object

(experimental) Options for creating a WaiterStateMachine.

Parameters:

• backoff_rate (Union[int, float, None]) – (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)

• interval (Optional[Duration]) – (experimental) The interval (number of seconds) to wait between attempts. Default: Duration.seconds(5)

• total_timeout (Optional[Duration]) – (experimental) The total time that the state machine will wait for a successful response. Default: Duration.minutes(30)

Stability:

experimental

ExampleMetadata:

infused

Example:

# test_case: IntegTest
# start: IApiCall


describe = test_case.assertions.aws_api_call("StepFunctions", "describeExecution", {
    "execution_arn": start.get_att_string("executionArn")
}).expect(ExpectedResult.object_like({
    "status": "SUCCEEDED"
})).wait_for_assertions(
    total_timeout=Duration.minutes(5),
    interval=Duration.seconds(15),
    backoff_rate=3
)

Attributes

backoff_rate

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

Stability:

experimental

interval

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

Default:

Duration.seconds(5)

Stability:

experimental

total_timeout

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

Default:

Duration.minutes(30)

Stability:

experimental