EventBridgeRule

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

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

構文

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

YAML

  DeadLetterConfig: DeadLetterConfig
  EventBusName: String
  Input: String
  InputPath: String
  InputTransformer: InputTransformer
  Pattern: EventPattern
  RetryPolicy: RetryPolicy
  RuleName: String 
  State: String
  Target: Target

プロパティ

DeadLetterConfig

がターゲット呼び出しの失敗後にイベント EventBridge を送信する Amazon Simple Queue Service (Amazon SQS) キューを設定します。呼び出しは、存在しない Lambda 関数にイベントを送信する場合や、Lambda 関数を呼び出すためのアクセス許可 EventBridge が不十分な場合などに失敗する可能性があります。詳細については、「Amazon EventBridge ユーザーガイド」の「イベント再試行ポリシー」および「デッドレターキューの使用」を参照してください。

注記

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

タイプ： DeadLetterConfig

必須: いいえ

AWS CloudFormation 互換性: このプロパティは、 AWS::Events::Rule Target データ型の DeadLetterConfigプロパティに似ています。- AWS SAM このプロパティのバージョンには、必要に応じて追加のサブプロパティが含まれます。 AWS SAM デッドレターキューを作成します。

EventBusName

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

型: 文字列

必須: いいえ

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

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

Input

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

型: 文字列

必須: いいえ

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

InputPath

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

型: 文字列

必須: いいえ

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

InputTransformer

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

タイプ： InputTransformer

必須: いいえ

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

Pattern

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

タイプ： EventPattern

必須: はい

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

RetryPolicy

再試行ポリシーの設定に関する情報が含まれた RetryPolicy オブジェクトです。詳細については、「Amazon EventBridge ユーザーガイド」の「イベント再試行ポリシー」および「デッドレターキューの使用」を参照してください。

タイプ： RetryPolicy

必須: いいえ

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

RuleName

ルールの名前。

型: 文字列

必須: いいえ

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

State

ルールの状態。

使用できる値: DISABLED | ENABLED

型: 文字列

必須: いいえ

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

Target

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

タイプ: Target

必須: いいえ

AWS 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