Package software.amazon.awscdk.customresources

Interface WaiterStateMachineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WaiterStateMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-24T10:56:41.572Z")
@Stability(Stable)
public interface WaiterStateMachineProps
extends software.amazon.jsii.JsiiSerializable

Initialization properties for the WaiterStateMachine construct.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.lambda.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.customresources.*;
 Function function_;
 LogGroup logGroup;
 WaiterStateMachineProps waiterStateMachineProps = WaiterStateMachineProps.builder()
         .backoffRate(123)
         .interval(Duration.minutes(30))
         .isCompleteHandler(function_)
         .maxAttempts(123)
         .timeoutHandler(function_)
         // the properties below are optional
         .disableLogging(false)
         .logOptions(LogOptions.builder()
                 .destination(logGroup)
                 .includeExecutionData(false)
                 .level(LogLevel.OFF)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static WaiterStateMachineProps.Builder	builder()
Number	getBackoffRate()	Backoff between attempts.
default Boolean	getDisableLogging()	Whether logging for the state machine is disabled.
Duration	getInterval()	The interval to wait between attempts.
IFunction	getIsCompleteHandler()	The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.
default LogOptions	getLogOptions()	Defines what execution history events are logged and where they are logged.
Number	getMaxAttempts()	Number of attempts.
IFunction	getTimeoutHandler()	The handler to call if the waiter times out and is incomplete.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackoffRate

@Stability(Stable)
@NotNull
Number getBackoffRate()

Backoff between attempts.

getInterval

@Stability(Stable)
@NotNull
Duration getInterval()

The interval to wait between attempts.

getIsCompleteHandler

@Stability(Stable)
@NotNull
IFunction getIsCompleteHandler()

The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.

getMaxAttempts

@Stability(Stable)
@NotNull
Number getMaxAttempts()

Number of attempts.

getTimeoutHandler

@Stability(Stable)
@NotNull
IFunction getTimeoutHandler()

The handler to call if the waiter times out and is incomplete.

getDisableLogging

@Stability(Stable)
@Nullable
default Boolean getDisableLogging()

Whether logging for the state machine is disabled.

Default: - false

getLogOptions

@Stability(Stable)
@Nullable
default LogOptions getLogOptions()

Defines what execution history events are logged and where they are logged.

Default: - A default log group will be created if logging is enabled.

builder

@Stability(Stable)
static WaiterStateMachineProps.Builder builder()

Returns:

a WaiterStateMachineProps.Builder of WaiterStateMachineProps