DeadLetterConfig - AWS Serverless Application Model

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

DeadLetterConfig

用于指定 Amazon Simple Queue Service (Amazon SQS) 队列的对象,其中 EventBridge 在目标调用失败后向该队列发送事件。例如,在向不存在的 Lambda 函数发送事件或调用 Lambda 函数的权限不足时,调用可能会失败。有关更多信息,请参阅《Amazon EventBridge 用户指南》中的事件重试策略和使用死信队列

注意

AWS::Serverless::Function 资源类型具有类似的数据类型 DeadLetterQueue,用于处理成功调用目标 Lambda 函数后发生的故障。此类故障的示例包括 Lambda 节流或 Lambda 目标函数返回的错误。有关函数 DeadLetterQueue 属性的更多信息,请参阅《AWS Lambda 开发人员指南》中的死信队列

语法

要在您的 AWS Serverless Application Model (AWS SAM) 模板中声明此实体,请使用以下语法。

YAML

Arn: String QueueLogicalId: String Type: String

属性

Arn

指定作为死信队列目标的 Amazon SQS 队列的 Amazon 资源名称(ARN)。

注意

指定 Type 属性或 Arn 属性,但不能同时指定两者。

类型:字符串

必需:否

AWS CloudFormation 兼容性:此属性直接传递给 AWS::Events::Rule DeadLetterConfig 数据类型的 Arn 属性。

QueueLogicalId

指定 Type 时 AWS SAM 创建的死信队列的自定义名称。

注意

如果未设置 Type 属性,则将忽略该属性。

类型:字符串

必需:否

AWS CloudFormation 兼容性:此属性为 AWS SAM 独有,没有 AWS CloudFormation 等效属性。

Type

队列的类型。设置此属性后,AWS SAM 会自动创建死信队列并附加必要的基于资源的策略,以授予规则资源向队列发送事件的权限。

注意

指定 Type 属性或 Arn 属性,但不能同时指定两者。

有效值SQS

类型:字符串

必需:否

AWS CloudFormation 兼容性:此属性为 AWS SAM 独有,没有 AWS CloudFormation 等效属性。

示例

DeadLetterConfig

DeadLetterConfig

YAML

DeadLetterConfig: Type: SQS QueueLogicalId: MyDLQ