API Gateway で WebSocket API のデータマッピングを設定する - Amazon API Gateway
ルートリクエストデータを統合リクエストパラメータにマッピングする例

API Gateway で WebSocket API のデータマッピングを設定する

データマッピングを使用すると、ルートリクエストからバックエンド統合にデータをマッピングできます。

注記

WebSocket API のデータマッピングは、 ではサポートされていませんAWS マネジメントコンソール データマッピングを設定するには、AWS CLI、AWS CloudFormation、または SDK を使用する必要があります。

ルートリクエストデータを統合リクエストパラメータにマッピングする

統合リクエストパラメータは、定義されたルートリクエストパラメータ、リクエストボディ、context または stage 変数、静的値からマッピングできます。

次の表は、統合リクエストのデータマッピング式を示しています。表で、PARAM_NAME は、特定のパラメータ型のルートリクエストパラメータの名前です。正規表現パターン '^[a-zA-Z0-9._$-]+$]' に一致する必要があります。JSONPath_EXPRESSION はリクエストボディの JSON フィールドの JSONPath 式です。

マッピングされたデータソース マッピング式
リクエストクエリ文字列 ($connect ルートでのみサポート) route.request.querystring.PARAM_NAME
リクエストヘッダー ($connect ルートでのみサポート) route.request.header.PARAM_NAME
複数値のリクエストクエリ文字列 ($connect ルートでのみサポート) route.request.multivaluequerystring.PARAM_NAME
複数値のリクエストヘッダー ($connect ルートでのみサポート) route.request.multivalueheader.PARAM_NAME
リクエストボディ route.request.body.JSONPath_EXPRESSION
ステージ変数 stageVariables.VARIABLE_NAME
コンテキスト変数 サポートされるコンテキスト変数の 1 つである必要がある context.VARIABLE_NAME。
静的な値 'STATIC_VALUE'。STATIC_VALUE はリテラル文字列であり、単一引用符で囲む必要があります。

データマッピングを作成するときは、AWS CLI を使用して、AWS CLI の文字列でリテラルを使用するための正しい形式に従ってください。詳細については、「AWS Command Line Interface ユーザーガイド」の「AWS CLI で文字列に引用符とリテラルを使用する」を参照してください。

例

以下の AWS CLI の例では、データマッピングを設定しています。CloudFormation テンプレートの例については、「websocket-data-mapping.yaml」を参照してください。

クライアントの connectionId を統合リクエストのヘッダーにマッピングする

次の update-integration コマンドは、クライアントの connectionId をバックエンド統合へのリクエストの connectionId ヘッダーにマッピングします。

aws apigatewayv2 update-integration \
    --integration-id abc123 \
    --api-id a1b2c3d4 \ 
    --request-parameters 'integration.request.header.connectionId'='context.connectionId'

クエリ文字列パラメータを統合リクエストのヘッダーにマッピングする

次の例では、authToken クエリ文字列パラメータを統合リクエストの authToken ヘッダーにマッピングします。

  1. 次の update-route コマンドを使用して、authToken クエリ文字列パラメータをルートのリクエストパラメータに追加します。

    aws apigatewayv2 update-route --route-id 0abcdef \
    --api-id a1b2c3d4 \
    --request-parameters '{"route.request.querystring.authToken": {"Required": false}}'

  2. 次の update-integration コマンドを使用して、クエリ文字列パラメータをバックエンド統合へのリクエストの authToken ヘッダーにマッピングします。

    aws apigatewayv2 update-integration \
    --integration-id abc123 \
    --api-id a1b2c3d4 \
    --request-parameters 'integration.request.header.authToken'='route.request.querystring.authToken'

  3. (オプション) 必要に応じて、次の delete-route-request-parameter を使用して、ルートのリクエストパラメータから authToken クエリ文字列パラメータを削除します。

    aws apigatewayv2 delete-route-request-parameter \
    --route-id 0abcdef \
    --api-id a1b2c3d4 \
    --request-parameter-key 'route.request.querystring.authToken'