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

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

EventBridgeRule

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

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

構文

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

プロパティ

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::RuleTargetデータ型の 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::RuleTargetデータ型の InputTransformer プロパティに直接渡されます。

Pattern

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

タイプ : EventPattern

必須: はい

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

RetryPolicy

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

タイプ : RetryPolicy

必須: いいえ

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

RuleName

ルールの名前。

型: 文字列

必須: いいえ

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

State

ルールの状態。

使用可能な値： DISABLED | ENABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

型: 文字列

必須: いいえ

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

Target

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

タイプ: 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