AWS::Lambda::EventSourceMapping OnFailure - AWS CloudFormation
SyntaxPropertiesExamples

AWS::Lambda::EventSourceMapping OnFailure

A destination for events that failed processing.

Syntax

To declare this entity in your AWS 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.

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\-])+:([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:sqs:us-east-2:123456789012:dlq