AWS::Lambda::EventSourceMapping OnFailure - Amazon CloudFormation
SyntaxPropertiesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Lambda::EventSourceMapping OnFailure

A destination for events that failed processing. For more information, see Adding a destination.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Destination" : String
}

YAML

  Destination: String

Properties

Destination

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.

Note

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.

Required: No

Type: String

Pattern: arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:((eusc-)?[a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:(.*)

Minimum: 12

Maximum: 1024

Update requires: No interruption

Examples

On-Failure Destination Configuration

Configure a function to send a record of failed batches to an SQS queue.

YAML

          OnFailure:
            Destination: arn:aws-cn:sqs:us-east-2:123456789012:dlq