software.amazon.awscdk.services.events.targets

Class SfnStateMachineProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SfnStateMachineProps>

Enclosing interface:

SfnStateMachineProps

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

A builder for SfnStateMachineProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SfnStateMachineProps	build() Builds the configured instance.
SfnStateMachineProps.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
SfnStateMachineProps.Builder	input(RuleTargetInput input) Sets the value of SfnStateMachineProps.getInput()
SfnStateMachineProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
SfnStateMachineProps.Builder	retryAttempts(Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()
SfnStateMachineProps.Builder	role(IRole role) Sets the value of SfnStateMachineProps.getRole()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

input

@Stability(value=Stable)
public SfnStateMachineProps.Builder input(RuleTargetInput input)

Sets the value of SfnStateMachineProps.getInput()

Parameters:

input - The input to the state machine execution.

Returns:

this

role

@Stability(value=Stable)
public SfnStateMachineProps.Builder role(IRole role)

Sets the value of SfnStateMachineProps.getRole()

Parameters:

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

Returns:

this

deadLetterQueue

@Stability(value=Stable)
public SfnStateMachineProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of TargetBaseProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). 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.

Returns:

this

maxEventAge

@Stability(value=Stable)
public SfnStateMachineProps.Builder maxEventAge(Duration maxEventAge)

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

@Stability(value=Stable)
public SfnStateMachineProps.Builder retryAttempts(Number retryAttempts)

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

@Stability(value=Stable)
public SfnStateMachineProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SfnStateMachineProps

Throws:

NullPointerException - if any required attribute was not provided