すべてのプロダクト
Search
ドキュメントセンター

EventBridge:SinkApiDestinationParameters

最終更新日:May 08, 2026

パラメーター

タイプ

説明

object

API 宛先のパラメーターを指定します。

Name

string

API 宛先の名前です。

HeaderParameters

object

リクエストに追加するカスタム HTTP ヘッダーのパラメーターを、キーと値のペアで指定します。

Form

string

パラメーターの値の生成方法を定義します。value フィールドに静的文字列を指定する場合は CONSTANT を使用します。イベントペイロードから JSONPath 式でデータを抽出する場合は JSONPATH を使用します。template フィールドから値を構築する場合は TEMPLATE を使用します。

Value

string

パラメーターの静的値または JSONPath 式です。このフィールドは、formCONSTANT または JSONPATH に設定されている場合にのみ適用されます。

Template

string

パラメーター値を構築する際に使用するテンプレートです。このフィールドは、formTEMPLATE に設定されている場合にのみ使用されます。テンプレート内では、${event.id} のような変数を使用してイベントデータを参照できます。

BodyParameters

object

HTTP リクエストボディのパラメーターを、キーと値のペアで指定します。

Form

string

パラメーターの値の生成方法を定義します。value フィールドに静的文字列を指定する場合は CONSTANT を使用します。イベントペイロードから JSONPath 式でデータを抽出する場合は JSONPATH を使用します。template フィールドから値を構築する場合は TEMPLATE を使用します。

Value

string

パラメーターの静的値または JSONPath 式です。このフィールドは、formCONSTANT または JSONPATH に設定されている場合にのみ適用されます。

Template

string

パラメーター値を構築する際に使用するテンプレートです。このフィールドは、formTEMPLATE に設定されている場合にのみ使用されます。テンプレート内では、${event.id} のような変数を使用してイベントデータを参照できます。

QueryStringParameters

object

エンドポイント URL に追加するクエリ文字列パラメーターを、キーと値のペアで指定します。

Form

string

パラメーターの値の生成方法を定義します。value フィールドに静的文字列を指定する場合は CONSTANT を使用します。イベントペイロードから JSONPath 式でデータを抽出する場合は JSONPATH を使用します。template フィールドから値を構築する場合は TEMPLATE を使用します。

Value

string

パラメーターの静的値または JSONPath 式です。このフィールドは、formCONSTANT または JSONPATH に設定されている場合にのみ適用されます。

Template

string

パラメーター値を構築する際に使用するテンプレートです。このフィールドは、formTEMPLATE に設定されている場合にのみ使用されます。テンプレート内では、${event.id} のような変数を使用してイベントデータを参照できます。

Timeout

integer

API 呼び出しのタイムアウト時間(秒単位)です。この期間内にエンドポイントが応答しない場合、呼び出しは失敗します。有効値の範囲は 1 ~ 60 です。