API 宛先による HTTP エンドポイントへのイベントルーティング - EventBridge

API 宛先は、追加のアーキテクチャを必要とせず、ローコードな方法で EventBridge からサードパーティの SaaS プラットフォームや独自のサービスなどの任意の HTTP エンドポイントにイベントをルーティングします。各 API 宛先は、認証情報を保存する接続とペアになります。接続で一度認証情報を設定すれば、その接続を複数の API 宛先やイベントルールで再利用できます。

API 宛先を更新すると、それを参照するすべてのイベントルールが自動的に変更を反映します。個々のルールを編集する必要はありません。

API 宛先と接続の仕組み

API 宛先は、イベントを送信する *場所* (HTTP エンドポイントの URL とリクエストメソッド) を定義します。接続は、接続と認証の *方法* (ネットワーク構成、認証情報の種類とパラメーター) を定義します。

この分離には、2 つの利点があります。

再利用可能な認証： 同じ認証方式を共有する複数の API 宛先で、1 つの接続を使用できます。API 宛先が異なる認証を必要とする場合は、別々の接続を作成します。
エンドポイントの一元管理： API 宛先への変更は、それを参照するすべてのイベントルールに反映されます。

認証方式

接続は、3 つの認証方式をサポートしています。

方式	仕組み	使用シーン
Basic	EventBridge はユーザー名とパスワードを Base64 でエンコードし、`Basic` プレフィックスを追加して、HTTP の `Authorization` ヘッダーで値を送信します。宛先サービスは、応答する前に認証情報をデコードして検証します。	ターゲット API が HTTP 基本認証を使用する場合。
OAuth クライアント認証情報	EventBridge は、クライアント ID とクライアントシークレットを使用して OAuth エンドポイントから `access_token` をリクエストし、その後続のリクエストにトークンを含めます。OAuth は、認証コード、暗黙的な認証コード、パスワード、クライアント認証情報の 4 つのグラントタイプをサポートしています。イベント駆動型のシナリオでは、一般的にクライアント認証情報が使用されます。トークンリクエストには GET および POST メソッドをサポートしています。	ターゲット API が OAuth 2.0 クライアント認証情報フローを使用する場合。
API キー	EventBridge は、リクエストごとにカスタムのキーと値のペアを HTTP ヘッダーで送信します。	ターゲット API が静的な API キーで認証する場合。

前提条件

開始する前に、以下が完了していることを確認してください。

EventBridge の有効化と RAM ユーザーへの権限付与

接続の作成

接続は、1 つ以上の API 宛先の認証情報を保存します。接続は、API 宛先を作成する前、または作成中に作成します。

EventBridge コンソールにログインします。EventBridge コンソールの左側のナビゲーションウィンドウで、[インテグレーションセンター] > [API デスティネーション] を選択します。
上部のナビゲーションバーで、接続を作成するリージョンを選択します。
[接続設定] タブをクリックし、[作成] をクリックします。
[接続の作成] パネルで、次のパラメーターを設定し、[OK] をクリックします。

パラメーター	説明	例
名前	接続の名前です。	testName
説明	接続の簡単な説明です。	test
認証方式	認証方式です。有効な値： Basic、OAuth Client Credential、API Key。	Basic
ユーザー名	Basic 認証で使用するユーザー名です。認証方式を Basic に設定した場合に必須です。	Admin
パスワード	Basic 認証で使用するパスワードです。認証方式を Basic に設定した場合に必須です。	******
エンドポイント	`access_token` を取得する際に使用する URL です。認証方式を OAuth Client Credential に設定した場合に必須です。	https://postman-echo.com/oauth1
HTTP メソッド	`access_token` を取得するリクエストで使用する HTTP メソッドです。認証方式を OAuth Client Credential に設定した場合に必須です。	POST
クライアント ID	`access_token` を取得する際に使用するクライアント ID です。認証方式を OAuth Client Credential に設定した場合に必須です。	Admin
クライアントシークレット	クライアントシークレットです。認証方式を OAuth Client Credential に設定した場合に必須です。	******
OAuth HTTP パラメーター	`access_token` 取得リクエストに含める追加のヘッダー、本文パラメーター、またはクエリパラメーターです。認証方式を OAuth Client Credential に設定した場合に必須です。	Parameter: Header, key: name, Value: eventbridge
ApiKeyName	API Key 認証で使用するキー名です。認証方式を API Key に設定した場合に必須です。	Admin
ApiKeyValue	API Key 認証で使用するキー値です。認証方式を API Key に設定した場合に必須です。	******
ネットワークタイプ	ネットワークの種類です。デフォルト値：インターネット。	Internet

API 宛先の作成

EventBridge コンソールにログインします。左側のナビゲーションウィンドウで、[インテグレーションセンター] > [API デスティネーション] を選択します。
上部のナビゲーションバーで、API 宛先を作成するリージョンを選択します。
［API 宛先］タブをクリックし、次に［作成］をクリックします。
[API 宛先の作成] パネルで、次のセクションを設定し、[OK] をクリックします。
1. [基本情報]: [メソッド] を [カスタム] に設定し、API 宛先の名前と説明を指定します。
2. [API 設定]：「[URL]」を対象サービスの API エンドポイントに設定し、「[HTTP メソッド]」をリクエストメソッド（例：GET または POST）に設定します。
3. 接続設定: 次のオプションのいずれかを選択します。
  - 接続の作成：接続を作成するのステップに従って、新しい接続を設定します。
  - [既存の接続を選択] -- ドロップダウンリストから既存の接続を選択します。

イベントターゲットとしての API 宛先の使用

API 宛先を作成した後、イベントルールでターゲットとして参照することで、一致するイベントを宛先のエンドポイントにルーティングできます。

EventBridge コンソールにログインします。左側のナビゲーションウィンドウで、[イベントバス] をクリックします。
上部のナビゲーションバーで、リージョンを選択します。管理するイベントバスの名前をクリックします。
左側のナビゲーションウィンドウで、[イベントルール] をクリックし、次に [ルールの作成] をクリックします。
[ルールの作成] パネルで、以下のステップを完了し、[作成] をクリックします:
1. [基本情報の設定] タブおよび [イベントパターンの設定] タブで、イベントルールを設定します。詳細については、「イベントルールを作成する」をご参照ください。
2. 「[ターゲットの設定]」ステップで、「[API 操作によってトリガー]」を「[サービスの種類]」ドロップダウンリストから選択します。
  - 新しい API 宛先をインラインで作成するには、[メソッド] に [カスタム] を選択し、「API 宛先を作成する」の説明に従って設定を構成します。
  - 既存の API 宛先を使用するには、[Use Existing Item] を [Method] として選択し、ドロップダウンリストから API 宛先を選択します。

接続の管理

接続を作成すると、[接続設定] タブからその接続を表示、編集、または削除できます。

操作	手順
詳細の表示	[詳細] を [操作] 列からクリックして、基本情報、認証構成、ネットワーク構成、およびバインド済みの API 宛先を確認します。
編集	[編集] を [操作] 列からクリックして、接続の説明を変更します。
削除	[削除] を [操作] 列からクリックします。確認メッセージを読み、[OK] をクリックします。

API 宛先の管理

API 宛先を作成した後は、[API 宛先] タブから表示、編集、または削除できます。

操作	手順
詳細の表示	[操作] 列の [詳細] をクリックして、基本情報、API 構成、接続構成を表示します。
編集	[操作] 列の [編集] をクリックして、説明と API 構成を変更します。
削除	[操作] 列の [削除] をクリックします。確認メッセージを読み、[OK] をクリックします。