一般的なヘルパーメソッド

このページでは、CloudFront Functions 内の追加のヘルパーメソッドについて説明します。これらのメソッドを使用するには、JavaScript ランタイム 2.0 を使用して CloudFront 関数を作成します。

import cf from 'cloudfront';

詳細については、「CloudFront Functions の JavaScript ランタイム 2.0 の機能」を参照してください。

edgeLocation メタデータ

このメソッドは、cloudfront モジュールの使用が必要です。

この JavaScript オブジェクトを使用して、エッジロケーションの空港コード、予想されるリージョナルエッジキャッシュリージョン、またはリクエストの処理に使用される CloudFront サーバーの IP アドレスを取得します。このメタデータは、ビューワーリクエストイベントトリガーでのみ使用できます。

cf.edgeLocation = {
    name: SEA
    serverIp: 1.2.3.4
    region: us-west-2
}

cf.edgeLocation オブジェクトには、以下を含めることができます。

rawQueryString() 方法

このメソッドに、cloudFront モジュールは必要ありません。

rawQueryString() メソッドを使用して、解析されていない未変更のクエリ文字列を文字列として取得します。

[リクエスト]

function handler(event) {
    var request = event.request;
    const qs = request.rawQueryString();
}

レスポンス

先頭の ? なしで、受信リクエストの完全なクエリ文字列を文字列値として返します。

logCustomData() 方法

この方法を使用するには、cloudfront モジュールをインポートします。

logCustomData() メソッドを使用して、Amazon CloudFront 関数から CloudFront アクセスログにカスタムデータを送信します。この関数がビューワーリクエストイベントまたはビューワーレスポンスイベントに関連付けられているかどうかに応じて、データは viewer-request-log-data または viewer-response-log-data ログフィールドに書き込まれます。

メソッドは 1 つの文字列引数を受け取ります。オブジェクトをログに記録するには、JSON.stringify() を使用して最初に文字列に変換します。例えば、次のようになります。

const resp_obj = JSON.stringify(some_obj);
cf.logCustomData(resp_obj);

各フィールドは、最大 800 バイトのデータをサポートします。CloudFront は、ログフィールドに書き込む前にデータを自動的に URL エンコードします。CloudFront は、URL エンコード後に 800 バイトを超えるデータを切り捨てます。関数が 1 回の実行で logCustomData() を複数回呼び出す場合、CloudFront は最後の値のみを使用します。

このメソッドは次の構文を使用します。

cf.logCustomData(String);

import cf from 'cloudfront';

function handler(event) {
    var request = event.request;

    // Check if the debug header exists, if so log it
    if (request.headers['x-debug-header']) {
        // Log the debug header value
        cf.logCustomData("debug header found: " + request.headers['x-debug-header'].value);
    }

    return request;
}