EventBridge サンドボックスを使用したイベントパターンのテスト - Amazon EventBridge

EventBridge サンドボックスを使用したイベントパターンのテスト

イベントパターンの定義は、通常、新しいルールの作成や既存のルールの編集という、より大きなプロセスの一環として行います。ただし、EventBridge のサンドボックスを使用すると、ルールを作成または編集しなくても、イベントパターンをすばやく定義し、サンプルイベントを使用してパターンが目的のイベントと一致することを確認できます。イベントパターンのテストが完了すると、EventBridge では、サンドボックスからそのイベントパターンを直接使用して新しいルールを作成できるようになります。

イベントパターンの詳細については、「Amazon EventBridge のイベントパターン」を参照してください。

重要

EventBridge では、予想よりも高い料金やスロットリングにつながる可能性のあるルールを作成できます。例えば、ルールが無限に再帰的に実行される無限ループに陥るようなルールを誤って作成してしまうことがあります。Amazon S3 バケットで ACL が変更されたことを検出し、ソフトウェアをトリガーして目的の状態に変更するルールを作成したとします。このルールが慎重に記述されていない場合は、その後 ACL を変更するとルールが再び開始され、無限ループが作成されます。

このような予期しない結果を最小限に抑えるための正確なルールやイベントパターンを記述する方法に関するガイダンスについては、ルールのベストプラクティス および ベストプラクティス を参照してください。

EventBridge サンドボックスを使用してイベントパターンをテストするには

  1. Amazon EventBridge コンソール (https://console.aws.amazon.com/events/) を開きます。

  2. ナビゲーションペインで [デベロッパーリソース]、[サンドボックス] の順に選択し、[サンドボックス] ページで [イベントパターン] タブを選択します。

  3. [Event source] (イベントソース) で、[AWS events or EventBridge partner events] ( イベントまたは EventBridge パートナーイベント) を選択します。

  4. [サンプルイベント] セクションで、イベントパターンをテストする対象の [サンプルイベントタイプ] を選択します。

    次のサンプルイベントタイプを使用できます｡

    • [AWS イベント] — サポートされている AWS のサービスから発行されたイベントを選択します。

    • [EventBridge partner events] (EventBridge パートナーイベント) — Salesforce など、EventBridge をサポートしているサードパーティのサービスから送信されるイベントから選択できます。

    • [自分のイベントを入力] — 自分のイベントを JSON テキストで入力します。

      独自のカスタムイベントを作成するための開始点として AWS イベントまたはパートナーイベントを使用することもできます。

      1. [AWS イベント] または [EventBridge パートナーイベント] を選択します。

      2. [サンプルイベント] ドロップダウンを使用して、カスタムイベントの開始点として使用するイベントを選択します。

        EventBridge にサンプルイベントが表示されます。

      3. [コピー] を選択します。

      4. [イベントタイプ] で [自分のイベントを入力] を選択します。

      5. JSON 編集ペインのサンプルイベント構造を削除し、その場所に AWS イベントまたはパートナーイベントを貼り付けます。

      6. イベント JSON を編集して独自のサンプルイベントを作成します。

  5. [Creation method] (作成方法) を選択します。イベントパターンは、EventBridge のスキーマまたはテンプレートから定義するか、またはカスタムイベントパターンを作成できます。

    Existing schema

    既存の EventBridge スキーマを使用してイベントパターンを作成するには、以下を実行します。

    1. [Creation method] (作成方法) セクションの [Method] (メソッド) で、[Use schema] (スキーマを使用) を選択します。

    2. [Event pattern] (イベントパターン) セクションの [Schema type] (スキーマタイプ) で、[Select schema from Schema registry] (スキーマレジストリからスキーマを選択) を選択します。

    3. [Schema registry] (スキーマレジストリ) では、ドロップダウンボックスを選択して、aws.events などのスキーマレジストリの名前を入力します。表示されるドロップダウンリストからオプションを選択することもできます。

    4. [Schema] (スキーマ) では、ドロップダウンボックスを選択して、使用するスキーマの名前を入力します。例えば、aws.s3@ObjectDeleted と指定します。表示されるドロップダウンリストからオプションを選択することもできます。

    5. [Models] (モデル) セクションでは、任意の属性の横にある [Edit] (編集) ボタンを選択してプロパティを開きます。必要に応じて [Relationship] (関係) フィールドと [Value] (値) フィールドを設定し、次に [Set] (設定) を選択して属性を保存します。

      注記

      属性の定義については、属性名の横にある[Info] (情報) アイコンを選択してください。イベントで属性のプロパティを設定する方法については、属性のプロパティダイアログボックスの [Note] (注意) セクションを開いてください。

      属性のプロパティを削除するには、その属性の [Edit] (編集) ボタンを選択し、[Clear] (クリア) を選択します。

    6. [Generate event pattern in JSON] (JSON でイベントパターンを生成) を選択し、イベントパターンを JSON テキストとして生成して検証します。

    7. テストパターンに対してサンプルイベントをテストするには、[テストパターン] を選択します。

      サンプルイベントがイベントパターンと一致するかどうかを示すメッセージボックスが表示されます。

      次のオプションのいずれかを選択することもできます。

      • [Copy] (コピー) — イベントパターンをデバイスのクリップボードにコピーします。

      • [Prettify] (整文) — 改行、タブ、スペースを追加して JSON テキストを読みやすくします。

    Custom schema

    カスタムスキーマを記述し、それをイベントパターンに変換して、以下の操作を行います。

    1. [Creation method] (作成方法) セクションの [Method] (メソッド) で、[Use schema] (スキーマを使用) を選択します。

    2. [Event pattern] (イベントパターン) セクションで、[Schema type] (スキーマの種類) で、[Enter schema] (スキーマを入力) を選択します。

    3. テキストボックスにスキーマを入力します。スキーマは有効な JSON テキストとしてフォーマットする必要があります。

    4. [Models] (モデル) セクションで、任意の属性の横にある[Edit] (編集) ボタンを選択してプロパティを開きます。必要に応じて [Relationship] (関係) フィールドと [Value] (値) フィールドを設定し、次に [Set] (設定) を選択して属性を保存します。

      注記

      属性の定義については、属性名の横にある[Info] (情報) アイコンを選択してください。イベントで属性のプロパティを設定する方法については、属性のプロパティダイアログボックスの [Note] (注意) セクションを開いてください。

      属性のプロパティを削除するには、その属性の [Edit] (編集) ボタンを選択し、[Clear] (クリア) を選択します。

    5. [Generate event pattern in JSON] (JSON でイベントパターンを生成) を選択し、イベントパターンを JSON テキストとして生成して検証します。

    6. テストパターンに対してサンプルイベントをテストするには、[テストパターン] を選択します。

      サンプルイベントがイベントパターンと一致するかどうかを示すメッセージボックスが表示されます。

      次のオプションのいずれかを選択することもできます。

      • [Copy] (コピー) — イベントパターンをデバイスのクリップボードにコピーします。

      • [Prettify] (整文) — 改行、タブ、スペースを追加して JSON テキストを読みやすくします。

    Event pattern

    カスタムイベントパターンを JSON 形式で記述するには、以下を実行します。

    1. [Creation method] (作成方法) セクションの [Method] (メソッド) で、[Custom pattern (JSON editor)] (カスタムパターン (JSON エディタ)) を選択します。

    2. [Event pattern] (イベントパターン) には、カスタムイベントパターンを JSON 形式のテキストで入力します。

    3. テストパターンに対してサンプルイベントをテストするには、[テストパターン] を選択します。

      サンプルイベントがイベントパターンと一致するかどうかを示すメッセージボックスが表示されます。

      次のオプションのいずれかを選択することもできます。

      • [Copy] (コピー) — イベントパターンをデバイスのクリップボードにコピーします。

      • [Prettify] (整文) — 改行、タブ、スペースを追加して JSON テキストを読みやすくします。

      • [Event pattern form] (イベントパターンフォーム) — パターンビルダーでイベントパターンを開きます。パターンをそのままパターンビルダーでレンダリングできない場合、EventBridge はパターンビルダーを開く前に警告を表示します。

  6. (オプション) このイベントパターンを使用してルールを作成し、そのルールを特定のイベントバスに割り当てるには、[パターンを持つルールを作成] を選択します。

    EventBridge に [ルールを作成] の [ステップ 1] が表示されます。ここでルールを作成し、選択したイベントバスに割り当てることができます。

    [ステップ 2 - イベントパターンを構築] には、既に指定したイベントパターン情報が表示されていることに注意してください。これを受け入れるか、更新することができます。

    ルールを作成する方法の詳細については、「Amazon EventBridge でイベントに応答するルールの作成」を参照してください。