DeadLetterConfig - AWS Serverless Application Model
構文プロパティ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DeadLetterConfig

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

構文

AWS Serverless Application Model (AWS SAM) テンプレートでこのエンティティを宣言するには、以下の構文を使用します。

YAML

  Arn: String
  QueueLogicalId: String
  Type: String

プロパティ

Arn

デッドレターキューのターゲットとして指定された Amazon SQS キューの Amazon リソースネーム (ARN) です。

注記

Type プロパティと Arn プロパティは、両方ではなく、どちらか一方を指定してください。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::Events::Rule DeadLetterConfig データ型の Arn プロパティに直接渡されます。

QueueLogicalId

Type が指定されている場合に AWS SAM が作成するデッドレターキューのカスタム名です。

注記

Type プロパティが設定されていない場合、このプロパティは無視されます。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

Type

キューのタイプです。このプロパティが設定されていると、AWS SAM がデッドレターキューを自動的に作成し、そのキューにイベントを送信する許可をルールリソースに付与するために必要なリソースベースのポリシーをアタッチします。

注記

Type プロパティと Arn プロパティは、両方ではなく、どちらか一方を指定してください。

有効な値: SQS

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは AWS SAM に固有であり、CloudFormation に同等のものはありません。

例

DeadLetterConfig

DeadLetterConfig

YAML

DeadLetterConfig:
  Type: SQS
  QueueLogicalId: MyDLQ