software.amazon.awscdk.services.events.targets

Class LambdaFunction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<LambdaFunction>

Enclosing class:

LambdaFunction

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

(experimental) A fluent builder for LambdaFunction.

Method Summary

Modifier and Type	Method and Description
LambdaFunction	build()
static LambdaFunction.Builder	create(IFunction handler)
LambdaFunction.Builder	deadLetterQueue(IQueue deadLetterQueue) (experimental) The SQS queue to be used as deadLetterQueue.
LambdaFunction.Builder	event(RuleTargetInput event) (experimental) The event to send to the Lambda.
LambdaFunction.Builder	maxEventAge(Duration maxEventAge) (experimental) The maximum age of a request that Lambda sends to a function for processing.
LambdaFunction.Builder	retryAttempts(Number retryAttempts) (experimental) The maximum number of times to retry when the function returns an error.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static LambdaFunction.Builder create(IFunction handler)

Parameters:

handler - This parameter is required.

Returns:

a new instance of LambdaFunction.Builder.

deadLetterQueue

@Stability(value=Experimental)
public LambdaFunction.Builder deadLetterQueue(IQueue deadLetterQueue)

(experimental) 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.

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](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). This parameter is required.

Returns:

this

maxEventAge

@Stability(value=Experimental)
public LambdaFunction.Builder maxEventAge(Duration maxEventAge)

(experimental) 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(value=Experimental)
public LambdaFunction.Builder retryAttempts(Number retryAttempts)

(experimental) 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

event

@Stability(value=Experimental)
public LambdaFunction.Builder event(RuleTargetInput event)

(experimental) The event to send to the Lambda.

This will be the payload sent to the Lambda Function.

Default: the entire EventBridge event

Parameters:

event - The event to send to the Lambda. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public LambdaFunction build()

Specified by:

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