翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
Amazon EventBridge での Amazon API Gateway ルールターゲット
Amazon API Gateway を使用すると、API の作成、発行、管理、モニタリング、保護が可能です。Amazon EventBridge は、API Gateway エンドポイントへのイベント送信をサポートしています。ターゲットとして API Gateway エンドポイントを指定すると、ターゲットに送信される各イベントは、エンドポイントに送信されたリクエストにマッピングされます。
重要
EventBridge は、ターゲットとして API Gateway のエッジ最適化されたエンドポイントと、リージョンエンドポイントの使用をサポートしています。プライベートエンドポイントは現在サポートされていません。エンドポイントの詳細については、「https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.html」を参照してください。
API Gateway ターゲットは、次のユースケースで使用できます。
-
AWS またはサードパーティーのイベントに基づいて、API Gateway でホストされている顧客指定の API を呼び出す。
-
スケジュールに基づいて定期的にエンドポイントを呼び出す。
EventBridge の JSON イベント情報は、HTTP リクエストのボディとしてエンドポイントに送信されます。ターゲットの HttpParameters フィールドでは、次のように他のリクエスト属性を指定できます。
-
PathParameterValuesは、エンドポイント ARN の任意のパス変数に順次対応する値を一覧で示します。例えば、"arn:aws:execute-api:us-east-1:112233445566:myapi/dev/POST/pets/*/*"などです。 -
QueryStringParametersは、呼び出されたエンドポイントに EventBridge が追加するクエリ文字列パラメータを表します。 -
HeaderParametersは、リクエストに追加する HTTP ヘッダーを定義します。
注記
セキュリティを考慮して、以下の HTTP ヘッダーキーは許可されていません。
-
X-AmzまたはX-Amznのプレフィックスが付いているキー -
Authorization -
Connection -
Content-Encoding -
Content-Length -
Host -
Max-Forwards -
TE -
Transfer-Encoding -
Trailer -
Upgrade -
Via -
WWW-Authenticate -
X-Forwarded-For
動的パラメータ
API Gateway ターゲットを呼び出すとき、ターゲットに送信されるイベントにデータを動的に追加することができます。詳細については、「ターゲットパラメータ」を参照してください。
呼び出しの再試行
すべてのターゲットと同様に、EventBridge は失敗した呼び出しの一部を再試行します。API Gateway の場合、EventBridge は 5xx または 429 の HTTP ステータスコードで送信されたレスポンスを、エクスポネンシャルバックオフとジッターFailedInvocations メトリクスを発行します。EventBridge は、他の 4xx HTTP エラーを再試行しません。
タイムアウト
EventBridge ルールの API Gateway リクエストは、クライアント実行タイムアウト時間を最大 5 秒までにする必要があります。API Gateway の応答に 5 秒以上かかる場合、EventBridge はリクエストをタイムアウトさせてから再試行します。
EventBridge Pipes API Gateway リクエストの最大タイムアウトは 29 秒で、API Gateway の最大値です。
