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

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

EventBridgeRule

EventBridgeRule イベントソースタイプを説明するオブジェクトです。これは、サーバーレス関数を Amazon EventBridge ルールのターゲットとして設定します。詳細については、Amazon EventBridge ユーザーガイドの「Amazon EventBridge とは」を参照してください。

このイベントタイプが設定された場合、AWS::Events::Rule リソースが AWS SAM により生成されます。また AWS SAM は、EventBridgeRule が Lambda を呼び出せるようにするために必要な AWS::Lambda::Permissionリソースも作成します。

構文

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

プロパティ

DeadLetterConfig

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

注記

AWS::Serverless::Function リソースタイプには DeadLetterQueue という同じようなデータ型があります。これは、ターゲット Lambda 関数の呼び出しが成功した後で発生する失敗を処理します。これらのタイプの失敗の例には、Lambda のスロットリングや、Lambda ターゲット関数によって返されるエラーなどがあります。関数の DeadLetterQueue プロパティの詳細については、「AWS Lambda デベロッパーガイド」の「デッドレターキュー」を参照してください。

タイプ: DeadLetterConfig

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::Events::Rule Target データ型の DeadLetterConfig プロパティに似ています。このプロパティの AWS SAM バージョンには、AWS SAM にデッドレターキューを作成させる場合のために、追加のサブプロパティが含まれています。

EventBusName

このルールに関連付けるイベントバスです。このプロパティを省略する場合、AWS SAM はデフォルトのイベントバスを使用します。

タイプ: 文字列

必須: いいえ

デフォルト値: デフォルトのイベントバス

CloudFormation との互換性: このプロパティは、AWS::Events::Rule リソースの EventBusName プロパティに直接渡されます。

Input

ターゲットに渡された有効な JSON テキストです。このプロパティを使用する場合、イベントテキスト自体からはターゲットに何も渡されません。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::Events::Rule Target リソースの Input プロパティに直接渡されます。

InputPath

一致するイベント全体をターゲットに渡したくない場合は、InputPath プロパティを使用して、イベントのどの部分を渡すかを説明します。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::Events::Rule Target リソースの InputPath プロパティに直接渡されます。

InputTransformer

特定のイベントデータに基づいてターゲットにカスタム入力を提供できるための設定。イベントから 1 つ以上のキーと値のペアを抽出し、そのデータを使用して、カスタマイズされた入力をターゲットに送信できます。詳細については、「Amazon EventBridge ユーザーガイド」の「Amazon EventBridge の入力変換」を参照してください。

Type: InputTransformer

必須: いいえ

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

Pattern

どのイベントが指定されたターゲットにルーティングされるかを説明します。詳細については、「Amazon EventBridge User Guide」の「Amazon EventBridge events」と「EventBridge event patterns」を参照してください。

タイプ: EventPattern

必須: はい

CloudFormation との互換性: このプロパティは、AWS::Events::Rule リソースの EventPattern プロパティに直接渡されます。

RetryPolicy

再試行ポリシーの設定に関する情報が含まれた RetryPolicy オブジェクトです。詳細については、Amazon EventBridge ユーザーガイドの「Event retry policy and using dead-letter queues」を参照してください。

Type: RetryPolicy

必須: いいえ

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

RuleName

ルールの名前です。

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::Events::Rule リソースの Name プロパティに直接渡されます。

State

ルールの状態。

使用できる値: DISABLED | ENABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

タイプ: 文字列

必須: いいえ

CloudFormation との互換性: このプロパティは、AWS::Events::Rule リソースの State プロパティに直接渡されます。

Target

ルールがトリガーされるときに EventBridge が呼び出す AWS リソースです。このプロパティを使用して、ターゲットの論理 ID を指定できます。このプロパティが指定されていない場合は、AWS SAM がターゲットの論理 ID を生成します。

タイプ: Target

必須: いいえ

CloudFormation 互換性: このプロパティは、AWS::Events::Rule リソースの Targets プロパティに類似しています。Amazon EC2 RebootInstances API call はターゲットプロパティの一例です。このプロパティの AWS SAM バージョンでは、単一のターゲットの論理 ID しか指定できません。

例

EventBridgeRule

以下は、EventBridgeRule イベントソースタイプの例です。

YAML

EBRule:
  Type: EventBridgeRule
  Properties:
    Input: '{"Key": "Value"}'
    Pattern:
      detail:
        state:
          - terminated
    RetryPolicy:
      MaximumRetryAttempts: 5
      MaximumEventAgeInSeconds: 900
    DeadLetterConfig:
      Type: SQS
      QueueLogicalId: EBRuleDLQ
    Target:
      Id: MyTarget