Package software.amazon.awscdk.services.lambda.eventsources

Class S3OnFailureDestination

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.lambda.eventsources.S3OnFailureDestination

All Implemented Interfaces:

IEventSourceDlq, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:24.455Z")
@Stability(Stable)
public class S3OnFailureDestination
extends software.amazon.jsii.JsiiObject
implements IEventSourceDlq

An S3 dead letter bucket destination configuration for a Lambda event source.

Example:

 import software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource;
 import software.amazon.awscdk.services.lambda.eventsources.S3OnFailureDestination;
 import software.amazon.awscdk.services.s3.IBucket;
 IBucket bucket;
 Function myFunction;
 // Your MSK cluster arn
 String clusterArn = "arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4";
 // The Kafka topic you want to subscribe to
 String topic = "some-cool-topic";
 S3OnFailureDestination s3OnFailureDestination = new S3OnFailureDestination(bucket);
 myFunction.addEventSource(ManagedKafkaEventSource.Builder.create()
         .clusterArn(clusterArn)
         .topic(topic)
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .onFailure(s3OnFailureDestination)
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.lambda.IEventSourceDlq

IEventSourceDlq.Jsii$Default, IEventSourceDlq.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	S3OnFailureDestination(IBucket bucket)
protected	S3OnFailureDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	S3OnFailureDestination(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
DlqDestinationConfig	bind(IEventSourceMapping _target, IFunction targetHandler)	Returns a destination configuration for the DLQ.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

S3OnFailureDestination

protected S3OnFailureDestination(software.amazon.jsii.JsiiObjectRef objRef)

S3OnFailureDestination

protected S3OnFailureDestination(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

S3OnFailureDestination

@Stability(Stable)
public S3OnFailureDestination(@NotNull
 IBucket bucket)

Parameters:

bucket - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public DlqDestinationConfig bind(@NotNull
 IEventSourceMapping _target,
 @NotNull
 IFunction targetHandler)

Returns a destination configuration for the DLQ.

Specified by:

bind in interface IEventSourceDlq

Parameters:

_target - This parameter is required.

targetHandler - This parameter is required.