AWS::Events::Rule DeadLetterConfig - 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::Events::Rule DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide.

Syntax

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

JSON

{
  "Arn" : String
}

YAML

  Arn: String

Properties

Arn

The ARN of the SQS queue specified as the target for the dead-letter queue.

Required: No

Type: String

Minimum: 1

Maximum: 1600

Update requires: No interruption

Examples

Set the DeadLetterConfig parameter

The following example sets the DeadLetterConfig parameter to set up arn:aws:sqs:us-west-2:081035103721:demoDLQ as a dead-letter queue.

JSON

"DeadLetterConfig": {
  "Arn": "arn:aws:sqs:us-west-2:081035103721:demoDLQ"
}

YAML

DeadLetterConfig:
  Arn: 'arn:aws:sqs:us-west-2:081035103721:demoDLQ'