WaiterStateMachineProps

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

Bases: WaiterStateMachineOptions

(experimental) Props 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:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.integ_tests_alpha as integ_tests_alpha
import aws_cdk as cdk

waiter_state_machine_props = integ_tests_alpha.WaiterStateMachineProps(
    backoff_rate=123,
    interval=cdk.Duration.minutes(30),
    total_timeout=cdk.Duration.minutes(30)
)

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