.env ファイルを使って Serverless Framework で Lambda の環境変数を設定する方法

2022.09.22

じゅんじゅん

.env ファイルを使って Serverless Framework で Lambda の環境変数を設定する方法

こんにちは、じゅんじゅんです。

以前、AWS の Lambda と EventBridge を使って毎週水曜日と日曜日に「ゴミを出せ！」というメッセージを送信する Line Bot を作成する記事を書きました。

この記事では zip ファイルを作成してアップロードすることで Lambda をデプロイしていましたが、これが結構手間です。

また、こちらの記事に書いたとおり慣れていないと詰まりやすいエラーも発生します。

そういった理由からコマンドひとつで Lambda のデプロイができる Serverless Framework を使用することにしましたが、初めてだったためこれはこれで調べることがたくさんありました。

その中でも今回は .env ファイルを使って Serverless Framework で Lambda の環境変数を設定する方法について紹介します。

前提

Serverless Framework 3.19.0

サービスの作成

まずはサービス (Serverless Framework の実行環境) を作成します。

以下のコマンドを実行すると sls-test というディレクトリが作成され、その中に serverless.yml や handler.js が作成されます。

serverless create --template aws-nodejs --name sls-test --path sls-test

今回は Lambda の環境変数を設定するだけで Lambda は特に実行しないので、 handler.js の中身はそのままにしておきます。

.env ファイルの作成

環境変数を記述するための .env ファイルを sls-test 下 (serverless.yml と同階層) に作成します。

今回はテストのため、中身は適当に以下のように記述しておきます。

.env

SYSTEM_NAME=mySystem
TABLE_NAME=tableName1

serverless.yml の修正

次に serverless.yml を書き換えます。いったん不要なコメントアウトを削除し、 region を設定しておきます。どこでもいいですがここでは us-west-2 としておきます。

serverless.yml

service: sls-test

frameworkVersion: '3'

provider:
  name: aws
  runtime: nodejs16.x
  region: us-west-2
functions:
  hello:
    handler: handler.hello

環境変数を設定するため、以下のように追記します。

serverless.yml

service: sls-test

frameworkVersion: '3'

useDotenv: true
provider:
  name: aws
  runtime: nodejs16.x
  region: us-west-2

functions:
  hello:
    handler: handler.hello
    environment:      SYSTEM_NAME: ${env:SYSTEM_NAME}      TABLE_NAME: ${env:TABLE_NAME}