interface OnFailureProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.CfnEventSourceMapping.OnFailureProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnEventSourceMapping_OnFailureProperty`
Java	`software.amazon.awscdk.services.lambda.CfnEventSourceMapping.OnFailureProperty`
Python	`aws_cdk.aws_lambda.CfnEventSourceMapping.OnFailureProperty`
TypeScript	`aws-cdk-lib` » `aws_lambda` » `CfnEventSourceMapping` » `OnFailureProperty`

A destination for events that failed processing.

For more information, see Adding a destination .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const onFailureProperty: lambda.CfnEventSourceMapping.OnFailureProperty = {
  destination: 'destination',
};

Properties

Name	Type	Description
destination?	`string`	The Amazon Resource Name (ARN) of the destination resource.

destination?

Type: string (optional)

The Amazon Resource Name (ARN) of the destination resource.

To retain records of unsuccessful asynchronous invocations , you can configure an Amazon SNS topic, Amazon SQS queue, Amazon S3 bucket, Lambda function, or Amazon EventBridge event bus as the destination.

Amazon SNS destinations have a message size limit of 256 KB. If the combined size of the function request and response payload exceeds the limit, Lambda will drop the payload when sending OnFailure event to the destination. For details on this behavior, refer to Retaining records of asynchronous invocations .

To retain records of failed invocations from Kinesis , DynamoDB , self-managed Kafka or Amazon MSK , you can configure an Amazon SNS topic, Amazon SQS queue, or Amazon S3 bucket as the destination.