Package software.amazon.awscdk.services.events.targets

Class SfnStateMachine.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.SfnStateMachine.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SfnStateMachine>

Enclosing class:

SfnStateMachine

@Stability(Stable)
public static final class SfnStateMachine.Builder
extends Object
implements software.amazon.jsii.Builder<SfnStateMachine>

A fluent builder for SfnStateMachine.

Method Summary

Modifier and Type	Method	Description
SfnStateMachine	build()
static SfnStateMachine.Builder	create(IStateMachine machine)
SfnStateMachine.Builder	deadLetterQueue(IQueue deadLetterQueue)	The SQS queue to be used as deadLetterQueue.
SfnStateMachine.Builder	input(RuleTargetInput input)	The input to the state machine execution.
SfnStateMachine.Builder	maxEventAge(Duration maxEventAge)	The maximum age of a request that Lambda sends to a function for processing.
SfnStateMachine.Builder	retryAttempts(Number retryAttempts)	The maximum number of times to retry when the function returns an error.
SfnStateMachine.Builder	role(IRole role)	The IAM role to be assumed to execute the State Machine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static SfnStateMachine.Builder create(IStateMachine machine)

Parameters:

machine - This parameter is required.

Returns:

a new instance of SfnStateMachine.Builder.

deadLetterQueue

@Stability(Stable)
public SfnStateMachine.Builder deadLetterQueue(IQueue deadLetterQueue)

The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. This parameter is required.

Returns:

this

maxEventAge

@Stability(Stable)
public SfnStateMachine.Builder maxEventAge(Duration maxEventAge)

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

retryAttempts

@Stability(Stable)
public SfnStateMachine.Builder retryAttempts(Number retryAttempts)

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

input

@Stability(Stable)
public SfnStateMachine.Builder input(RuleTargetInput input)

The input to the state machine execution.

Default: the entire EventBridge event

Parameters:

input - The input to the state machine execution. This parameter is required.

Returns:

this

role

@Stability(Stable)
public SfnStateMachine.Builder role(IRole role)

The IAM role to be assumed to execute the State Machine.

Default: - a new role will be created

Parameters:

role - The IAM role to be assumed to execute the State Machine. This parameter is required.

Returns:

this

build

@Stability(Stable)
public SfnStateMachine build()

Specified by:

build in interface software.amazon.jsii.Builder<SfnStateMachine>

Returns:

a newly built instance of SfnStateMachine.