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