Lambda 環境変数を使用したコードの値の設定

環境変数を使用すると、コードを更新せずに関数の動作を調整できます。環境変数は、関数のバージョン固有の設定に保存される文字列のペアです。Lambda ランタイムは、環境変数をコードで使用できるようにし、関数と呼び出しリクエストに関する情報を含む追加の環境変数を設定します。

注記

セキュリティを強化するには、環境変数の代わりに AWS Secrets Manager を使用してデータベースの認証情報や (API キーや認証トークンなど) その他の機密情報を保存することをお勧めします。詳細については、「AWS Secrets Manager を使用したシークレットの作成および管理」を参照してください。

環境変数は、関数を呼び出す前には評価されません。定義した値はリテラル文字列とみなされ、展開されません。関数コードで変数の評価を実行します。

Lambda コンソール、AWS Command Line Interface (AWS CLI)、AWS Serverless Application Model (AWS SAM)、または AWS SDK を使用して、Lambda で環境変数を設定できます。

Console

環境変数は、関数の未公開バージョンで定義します。バージョンを公開するとき、他のバージョン固有の構成設定とともに、そのバージョンの環境変数がロックされます。

関数の環境変数を作成するには、キーと値を定義します。関数は、キーの名前を使用して、環境変数の値を取得します。

Lambda コンソールで環境変数を設定するには

Lambda コンソールの [関数ページ] を開きます。
関数を選択します。
[Configuration] (設定) を選択してから、[Environment variables] (環境変数) を選択します。
[環境変数] で、[編集] を選択します。
[環境変数の追加] を選択します。
キーと値を入力します。
要件
- キーは文字で始まり、少なくとも 2 文字です。
- キーには、文字、数字、およびアンダースコア (_) のみを含める。
- キーは Lambda によって予約されていない。
- すべての環境変数の合計サイズは 4 KB を超えない。
[Save] を選択します。

コンソールコードエディタで環境変数のリストを生成するには

Lambda コードエディタで環境変数のリストを生成することができます。これを使用することで、コーディング中に環境変数を簡単に参照することができます。

[コード] タブを選択します。
[環境変数] タブを選択します。
[ツール]、[環境変数を表示] の順に選択します。

環境変数は、コンソールのコードエディタに一覧表示されても暗号化されたままです。転送中の暗号化の暗号化ヘルパーを有効にした場合、それらの設定は変更されません。詳細については、「Lambda 環境変数の保護」を参照してください。

環境変数リストは読み取り専用で、Lambda コンソールでのみ使用できます。このファイルは、関数の .zip ファイルアーカイブをダウンロードしたときには含まれていません。また、このファイルをアップロードしても環境変数を追加することはできません。

AWS CLI

次の例では、my-function という名前の関数に 2 つの環境変数を設定します。


aws lambda update-function-configuration \
  --function-name my-function \
  --environment "Variables={BUCKET=DOC-EXAMPLE-BUCKET,KEY=file.txt}"

update-function-configuration コマンドを使用して環境変数を適用すると、Variables 構造体の内容全体が置き換えられます。新しい環境変数を追加するときに既存の環境変数を保持するには、リクエストに既存の値をすべて含めます。

現在の設定を取得するには、get-function-configuration コマンドを使用します。


aws lambda get-function-configuration \
  --function-name my-function

以下の出力が表示されます。


{
    "FunctionName": "my-function",
    "FunctionArn": "arn:aws:lambda:us-east-2:111122223333:function:my-function",
    "Runtime": "nodejs20.x",
    "Role": "arn:aws:iam::111122223333:role/lambda-role",
    "Environment": {
        "Variables": {
            "BUCKET": "DOC-EXAMPLE-BUCKET",
            "KEY": "file.txt"
        }
    },
    "RevisionId": "0894d3c1-2a3d-4d48-bf7f-abade99f3c15",
    ...
}

get-function-configuration の出力にあるリビジョン ID をパラメータとして update-function-configuration に渡すことができます。これにより、構成を読み込んだときから更新したときまでの間に、値が変更されることはありません。

関数の暗号化キーを設定するには、KMSKeyARN オプションを設定します。


aws lambda update-function-configuration \
  --function-name my-function \
  --kms-key-arn arn:aws:kms:us-east-2:111122223333:key/055efbb4-xmpl-4336-ba9c-538c7d31f599

AWS SAM

AWS Serverless Application Model を使用して関数の環境変数を設定できます。template.yaml ファイル内の Environment プロパティと Variables プロパティを更新し、sam deploy を実行します。

例 template.yaml


AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: An AWS Serverless Application Model template describing your function.
Resources:
  my-function:
    Type: AWS::Serverless::Function
    Properties:
      CodeUri: .
      Description: ''
      MemorySize: 128
      Timeout: 120
      Handler: index.handler
      Runtime: nodejs18.x
      Architectures:
        - x86_64
      EphemeralStorage:
        Size: 10240
      Environment:
        Variables:
          BUCKET: DOC-EXAMPLE-BUCKET
          KEY: file.txt
      # Other function properties...

AWS SDKs

AWS SDK を使用して環境変数を管理するには、以下の API オペレーションを使用します。

詳細については、目的のプログラミング言語の AWS SDK ドキュメントを参照してください。

定義されたランタイム環境変数

Lambda ランタイムは、初期化中にいくつかの環境変数を設定します。ほとんどの環境変数は、関数またはランタイムに関する情報を提供します。これらの環境変数のキーは予約済みであるため、関数設定では設定できません。

予約済み環境変数

_HANDLER －関数に設定されているハンドラの場所。
_X_AMZN_TRACE_ID － X-Ray トレースヘッダー。この環境変数は呼び出しごとに変化します。
- この環境変数は OS 専用ランタイム (provided ランタイムファミリー) には定義されていません。カスタムランタイムには次の呼び出しからの Lambda-Runtime-Trace-Id レスポンスのヘッダーに _X_AMZN_TRACE_ID を設定できます。
- Java ランタイムバージョン 17 以降では、この環境変数は使用されません。代わりに、Lambda はトレース情報を com.amazonaws.xray.traceHeader システムプロパティに保存します。
AWS_DEFAULT_REGION － Lambda 関数が実行されるデフォルトの AWS リージョン。
AWS_REGION － Lambda 関数が実行される AWS リージョン。定義されている場合、この値は AWS_DEFAULT_REGION を上書きします。
- AWS SDK での AWS リージョン環境変数を使用する方法の詳細については、「AWS SDK とツールリファレンスガイド」の「AWSリージョン」を参照してください。
AWS_EXECUTION_ENV – AWS_Lambda_ (例: AWS_Lambda_java8) のプレフィックスが付いたランタイム識別子。この環境変数は OS 専用ランタイム (provided ランタイムファミリー) には定義されていません。
AWS_LAMBDA_FUNCTION_NAME －関数の名前。
AWS_LAMBDA_FUNCTION_MEMORY_SIZE －関数で使用できるメモリの量 (MB 単位)。
AWS_LAMBDA_FUNCTION_VERSION －実行される関数のバージョン。
AWS_LAMBDA_INITIALIZATION_TYPE －関数の初期化タイプ。これは、on-demand、provisioned-concurrency、または snap-start になります。詳細については、「プロビジョニングされた同時実行の設定」または「Lambda SnapStart による起動パフォーマンスの向上」を参照してください。
AWS_LAMBDA_LOG_GROUP_NAME、AWS_LAMBDA_LOG_STREAM_NAME － Amazon CloudWatch Logs グループの名前と関数のストリーム。AWS_LAMBDA_LOG_GROUP_NAME および AWS_LAMBDA_LOG_STREAM_NAME の環境変数は Lambda SnapStart 関数では使用できません。
AWS_ACCESS_KEY、AWS_ACCESS_KEY_ID、AWS_SECRET_ACCESS_KEY、AWS_SESSION_TOKEN – 関数の実行ロールから取得したアクセスキー。
AWS_LAMBDA_RUNTIME_API － (カスタムランタイム) ランタイム API のホストおよびポート。
LAMBDA_TASK_ROOT － Lambda 関数コードへのパス。
LAMBDA_RUNTIME_DIR －ランタイムライブラリへのパス。

以下の追加の環境変数は予約されていないため、関数設定で拡張できます。

予約されていない環境変数

LANG －ランタイムのロケール (en_US.UTF-8)。
PATH －実行パス (/usr/local/bin:/usr/bin/:/bin:/opt/bin)。
LD_LIBRARY_PATH －システムライブラリのパス (/var/lang/lib:/lib64:/usr/lib64:$LAMBDA_RUNTIME_DIR:$LAMBDA_RUNTIME_DIR/lib:$LAMBDA_TASK_ROOT:$LAMBDA_TASK_ROOT/lib:/opt/lib)。
NODE_PATH － (Node.js) Node.js ライブラリのパス (/opt/nodejs/node12/node_modules/:/opt/nodejs/node_modules:$LAMBDA_RUNTIME_DIR/node_modules)。
PYTHONPATH － (Python 2.7、3.6、3.8) Python ライブラリのパス ($LAMBDA_RUNTIME_DIR)。
GEM_PATH － (Ruby) Ruby ライブラリのパス ($LAMBDA_TASK_ROOT/vendor/bundle/ruby/2.5.0:/opt/ruby/gems/2.5.0)。
AWS_XRAY_CONTEXT_MISSING － X-Rayトレースの場合、Lambda は X-Ray SDK からランタイムエラーがスローされないように、これを LOG_ERROR に設定します。
AWS_XRAY_DAEMON_ADDRESS － X-Ray トレーシングの場合、X-Ray デーモンの IP アドレスとポート。
AWS_LAMBDA_DOTNET_PREJIT － .NET 6 と .NET 7 ランタイムの場合、この変数を設定して、.NET 固有のランタイムの最適化を有効または無効にします。値には always、never、および provisioned-concurrency があります。詳細については、「関数に対するプロビジョニングされた同時実行数の設定」を参照してください。
TZ －環境のタイムゾーン (UTC)。実行環境は、システムクロックを同期するために NTP を使用します。

表示されるサンプル値は、最新のランタイムを反映しています。特定の変数やその値の有無は、以前のランタイムでは異なる場合があります。

環境変数のシナリオ例

環境変数を使用して、テスト環境および本番環境における関数の動作をカスタマイズできます。例えば、同じコードでも設定が異なる 2 つの関数を作成できます。1 つの関数はテストデータベースに接続し、もう 1 つはプロダクションデータベースに接続します。この状況では、環境変数を使用して、データベースのホスト名とその他の接続に関する詳細を関数に渡します。

次の例は、データベースホストとデータベース名を環境変数として定義する方法を示しています。

テスト環境で本番環境よりも多くのデバッグ情報を生成する場合は、環境変数を設定して、より詳細なログ記録またはトレースを使用するようにテスト環境を設定できます。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

タイムアウト

環境変数の保護