software.amazon.awscdk.services.events.targets

Interface LambdaFunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

LambdaFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.329Z")
 @Stability(value=Stable)
public interface LambdaFunctionProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customize the Lambda Event Target.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function fn = Function.Builder.create(this, "MyFunc")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromInline("exports.handler = handler.toString()"))
         .build();
 Rule rule = Rule.Builder.create(this, "rule")
         .eventPattern(EventPattern.builder()
                 .source(List.of("aws.ec2"))
                 .build())
         .build();
 Queue queue = new Queue(this, "Queue");
 rule.addTarget(LambdaFunction.Builder.create(fn)
         .deadLetterQueue(queue) // Optional: add a dead letter queue
         .maxEventAge(Duration.hours(2)) // Optional: set the maxEventAge retry policy
         .retryAttempts(2)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LambdaFunctionProps.Builder A builder for LambdaFunctionProps
static class	LambdaFunctionProps.Jsii$Proxy An implementation for LambdaFunctionProps

Method Summary

Modifier and Type	Method and Description
static LambdaFunctionProps.Builder	builder()
default RuleTargetInput	getEvent() The event to send to the Lambda.

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEvent

@Stability(value=Stable)
 @Nullable
default RuleTargetInput getEvent()

The event to send to the Lambda.

This will be the payload sent to the Lambda Function.

Default: the entire EventBridge event

builder

@Stability(value=Stable)
static LambdaFunctionProps.Builder builder()

Specified by:

builder in interface TargetBaseProps

Returns:

a LambdaFunctionProps.Builder of LambdaFunctionProps