DeadLetterConfig

がターゲット呼び出しの失敗後にイベント EventBridge を送信する Amazon Simple Queue Service (Amazon SQS) キューを指定するために使用されるオブジェクト。呼び出しコールは、存在しないステートマシンにイベントを送信した場合、またはステートマシンを呼び出すために十分な許可がない場合などに失敗します。詳細については、「Amazon EventBridge ユーザーガイド」の「イベント再試行ポリシー」および「デッドレターキューの使用」を参照してください。

構文

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