interface WaiterStateMachineProps

Language	Type name
.NET	Amazon.CDK.CustomResources.WaiterStateMachineProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/customresources#WaiterStateMachineProps
Java	software.amazon.awscdk.customresources.WaiterStateMachineProps
Python	aws_cdk.custom_resources.WaiterStateMachineProps
TypeScript (source)	aws-cdk-lib » custom_resources » WaiterStateMachineProps

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 * as cdk from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { custom_resources } from 'aws-cdk-lib';

declare const function_: lambda.Function;
declare const logGroup: logs.LogGroup;
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: logGroup,
    includeExecutionData: false,
    level: stepfunctions.LogLevel.OFF,
  },
};

Properties

Name	Type	Description
backoffRate	number	Backoff between attempts.
interval	Duration	The interval to wait between attempts.
isCompleteHandler	IFunction	The main handler that notifies if the waiter to decide 'complete' or 'incomplete'.
maxAttempts	number	Number of attempts.
timeoutHandler	IFunction	The handler to call if the waiter times out and is incomplete.
disableLogging?	boolean	Whether logging for the state machine is disabled.
logOptions?	LogOptions	Defines what execution history events are logged and where they are logged.

---

backoffRate

Type: number

Backoff between attempts.

---

interval

Type: Duration

The interval to wait between attempts.

---

isCompleteHandler

Type: IFunction

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

---

maxAttempts

Type: number

Number of attempts.

---

timeoutHandler

Type: IFunction

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

---

disableLogging?

Type: boolean (optional, default: false)

Whether logging for the state machine is disabled.

---

logOptions?

Type: LogOptions (optional, default: A default log group will be created if logging is enabled.)

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