OnFailure

処理が失敗したイベントの送信先です。

構文

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

YAML

  Destination: String
  Type: String

プロパティ

Destination

送信先リソースの Amazon リソースネーム (ARN) です。

タイプ: 文字列

必須: 条件に応じて異なります

AWS CloudFormation との互換性: このプロパティは、AWS::Lambda::EventInvokeConfig リソースの OnFailure プロパティに似ています。SAM は、このプロパティで参照されるリソースにアクセスするために、この関数に関連付けられている自動生成された IAM ロールに必要な許可を追加します。

その他の注意点: タイプが Lambda/ の場合はEventBridge、送信先が必要です。

Type

送信先で参照されるリソースのタイプです。サポートされているタイプは、SQS、SNS、Lambda、EventBridge です。

タイプ: 文字列

必須: いいえ

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

その他の注意点: タイプが SQS/SNS で、Destination プロパティが空白のままになっている場合、SQS/SNS リソースは SAM によって自動生成されます。リソースを参照するには、SQS の場合は <function-logical-id>.DestinationQueue、SNS の場合は <function-logical-id>.DestinationTopic を使用します。タイプが Lambda/ の場合はEventBridge、 Destinationが必要です。

例

EventInvoke SQS および Lambda 送信先を使用した設定例

この例では、SQS OnSuccess 設定に Destination が指定されていないため、SAM は SQS キューを暗黙的に作成し、必要なアクセス許可を追加します。また、この例では、テンプレートファイルで宣言された Lambda リソースの送信先が OnFailure 設定で指定されているため、SAM はこの Lambda 関数に必要なアクセス許可を追加して、送信先の Lambda 関数を呼び出します。

YAML

EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SQS
    OnFailure:
      Type: Lambda
      Destination: !GetAtt DestinationLambda.Arn  # Arn of a Lambda function declared in the template file. 

EventInvoke SNS 送信先を使用した設定例

この例では、 OnSuccess 設定のテンプレートファイルで宣言された SNS トピックの送信先が指定されています。

YAML

EventInvokeConfig:
  DestinationConfig:
    OnSuccess:
      Type: SNS
      Destination:
        Ref: DestinationSNS       # Arn of an SNS topic declared in the tempate file