WaiterStateMachineProps Struct
Initialization properties for the WaiterStateMachine construct.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { custom_resources } from 'aws-cdk-lib';
import { aws_logs as interfaces_logs } from 'aws-cdk-lib/interfaces';
declare const function_: lambda.Function;
declare const logGroupRef: interfaces_logs.ILogGroupRef;
const waiterStateMachineProps: custom_resources.WaiterStateMachineProps = {
backoffRate: 123,
interval: cdk.Duration.minutes(30),
isCompleteHandler: function_,
maxAttempts: 123,
timeoutHandler: function_,
// the properties below are optional
disableLogging: false,
logOptions: {
destination: logGroupRef,
includeExecutionData: false,
level: stepfunctions.LogLevel.OFF,
},
};
Properties
backoffRatenumberbackoff_rateint | floatbackoffRateNumberBackoffRatedoubleBackoffRate*float64required#Backoff between attempts.
disableLoggingbooleandisable_loggingbooldisableLoggingBooleanDisableLoggingboolDisableLogging*bool= false#Whether logging for the state machine is disabled.
The interval to wait between attempts.
isCompleteHandlerIFunctionis_complete_handlerIFunctionisCompleteHandlerIFunctionIsCompleteHandlerIFunctionIsCompleteHandlerIFunctionrequired#The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.
logOptionsLogOptionslog_optionsLogOptionslogOptionsLogOptionsLogOptionsLogOptionsLogOptionsLogOptions#Defines what execution history events are logged and where they are logged.
Default: A default log group will be created if logging is enabled.
maxAttemptsnumbermax_attemptsint | floatmaxAttemptsNumberMaxAttemptsdoubleMaxAttempts*float64required#Number of attempts.