サーバーレスのローカル開発環境を整備する ~前編

• 本記事では、シンプル化のために、Lambda の zip 形式でのパッケージの場合で説明しています。コンテナ形式でのパッケージングを用いる場合は、SAM CLI のコマンドオプションに追加・変更が必要です。
  
• 本記事は、次のバージョンでの内容に基づいています。
  • SAM CLI 1.95.0
    
  • Visual Studio Code 1.80.1、AWS Toolkit for Visual Studio Code 1.85.1
    
    • 開発・デバッグ可能な言語 : Python、Node.js、Java、C#、Go
  • Eclipse 2022-09 (4.25.0) / Eclipse 2021-12 (4.22.0)、AWS Toolkit for Eclipse 2.3.1
    • 開発・デバッグ可能な言語 : Java
  • IntelliJ IDEA 2023.2、AWS Toolkit for IntelliJ 1.76-232
    • 開発・デバッグ可能な言語 : Java、Python - 有償版にて Node.js、.NET にも対応

クラウドだから、サーバーレスだから、という特殊性はなく、通常と変わらない開発とデバッグの様子に見えたはずです。以降では、この環境の整備と、そこでの開発手順をご紹介します。

Step 1 で紹介したデモの環境では、ローカル PC にある開発ツールに加えて、以下の設定を事前に行なっています。

• SAM CLI の設定 : ローカル環境でサーバーレスアプリケーションの初期構成や実行・デバッグを可能にするエミュレータ機能を含む、サーバーレスアプリケーション開発の支援機能のセットです。
• AWS Toolkit : ご利用の開発ツールに追加するプラグインで、デプロイ先となる AWS アカウントとの連携や SAM CLI での操作を円滑に行うことができます。

コード開発には開発ツール環境 (IDE) を使わずにテキストエディタで軽量に行いたい、という場合は、AWS Toolkit は不要です。SAM CLI / AWS Toolkit の役割を図式化すると次のようになります。

以下、ローカル環境で行う設定作業について説明します。

SAM CLI のドキュメントはこちら »

1. SAM CLI のために必要になる以下のソフトウェアをインストール (すでに対象のソフトウェアをインストール済ならその手順はスキップできます)
   • Docker : ローカルデバッグのために必要になります。こちら (Windows / Mac) に従い、インストールしてください。
   • Git : SAM による初期ファイルの設定時および次の Homebrew のために使われます。こちら に従い、インストールしてください。
   • Mac/Linux の場合のみ : Homebrew のインストール - SAM はこの機能を利用してインストールします。このため、こちらもインストールしてください (Mac / Linux)。
2. この前提が整えば、SAM CLI をインストールできます。
   • Windows : こちら を Windows インストーラからインストールします。
     
   • Mac/Linux : Homebrew が利用可能になっていれば、以下のコマンドでインストール可能です。
     

ご利用中の開発ツールごとにツールキットが異なります。以下、Visual Studio Code、IntelliJ IDEA、 Eclipse の場合を取り上げていますが、他の開発環境用のもの も選択可能です。

SAM CLI、AWS Toolkit ともに、ローカルマシンから AWS アカウント環境に接続するために AWS 認証情報を利用します。設定にはいくつかの方法がありますが、その中の一つの方法をご紹介します。

3 ローカル環境に AWS 認証情報を設定します。

• 開発ツール環境に AWS Toolkit が設定されていると、ツール上から AWS 認証情報を設定することができます。
  

この内容は .aws/credentials ファイルに格納されます。上記のように開発ツールから設定する以外の方法として、AWS CLI を使って aws configure コマンドで名前付きプロファイルを作成する方法もあります（詳しくはこちら »)。