AWS Lambda LocalStack をサポートする - AWS Toolkit for VS Code
前提条件 LocalStack のインストール LocalStack のセットアップ VS Code での LocalStack の開始 サンプルサーバーレスアプリケーションのビルドLocalStack を使用した Lambda 関数のテストとデバッグ

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS Lambda LocalStack をサポートする

AWS Toolkit for Visual Studio Codeでの LocalStack のサポートによって、サーバーレスアプリケーションを構築、テスト、デバッグします。LocalStack は、サーバーレスアプリケーションのローカルテストを可能にする AWS クラウドエミュレータです。

詳細については AWS Lambda、「 AWS Lambdaデベロッパーガイド」を参照してください。LocalStack の詳細については、LocalStack のウェブサイトを参照してください。

前提条件

以下は、VS Code で LocalStack を使用するための前提条件です。

注記

LocalStack CLI はセットアッププロセス中にインストールされますが、別のバージョンの LocalStack CLI を使用する場合、最低でもバージョン 4.8.0 が必要です。

  • 無料および有料の LocalStack 階層で使用できるすべての機能にアクセスするには、LocalStack ウェブアプリケーションアカウントが必要です。LocalStack Community エディションは、 アカウントなしで使用できます。

  • VS Code で LocalStack を使用するには Docker が必要です。Docker の LocalStack 要件の詳細については、LocalStack ドキュメントの「LocalStack Docker イメージ」トピックを参照してください。

  • 推奨: AWS Command Line Interface (AWS CLI) は、シミュレートされたクラウド環境でのサービスの使用を支援します。

LocalStack のインストール

LocalStack の無料および有料階層バージョンをインストールするには、次の手順を実行します。

注記

LocalStack Community エディションをセットアアップする方法については、このトピックの「LocalStack のセットアップ」セクションの「LocalStack Community」コンテンツを参照してください。

  1. Toolkit から AWS 、APPLICATION BUILDER エクスプローラーを展開します。

  2. [チュートリアルを選択] ボタンを選択して、VS Code エディタの [Get started building your application] のチュートリアルタブタブを開きます。

  3. チュートリアルから [Install LocalStack] を選択して、VS Code で LocalStack のインストールプロセスを開始します。

LocalStack のセットアップ

VS Code の LocalStack 拡張機能をインストールすると、セットアップが必要な場合に次のいずれかのインジケータが表示されることがあります。

  • デフォルトでは IDE の左下隅にある VS Code ステータスバーで、LocalStack のステータスが赤になります。

  • VS Code に LocalStack を設定するようにプロンプトが表示されます。

LocalStack のセットアップと設定には、使用している LocalStack のバージョンに応じて 2 種類あります。以下のタブ付きセクションでは、各 LocalStack セットアッププロセスについて説明します。

注記

LocalStack の無料および有料階層バージョンには LocalStack 認証トークンが必要です。LocalStack の料金の詳細については、料金ガイドである「プランの選択」を参照してください。

LocalStack をセットアップする方法は 2 つあります。

  • VS Code の [Setup LocalStack to get started] プロンプトで、[Setup] ボタンを選択します。

  • VS Code ステータスバーから、LocalStack ステータスアイコンを選択して [Setup LocalStack to get started] プロンプトを開き、[Setup] ボタンを選択します。

セットアップ中、システムは次のステップを実行します。

  1. LocalStack CLI をインストールします。

  2. LocalStack アカウントがあるかどうかをチェックします。

  3. LocalStack アカウントをお持ちの場合、システムはデフォルトのウェブブラウザで認証プロセスをガイドします。同様に、LocalStack アカウントがない場合、システムは認証プロセスの前にアカウントのセットアップをガイドします。

LocalStack のセットアップが完了すると、VS Code ステータスバーの LocalStack ステータスが更新されます。

注記

LocalStack のプロファイルを作成していない場合は、LocalStack のセットアッププロセスの一環として新しい AWS プロファイルが自動的に作成されます。

LocalStack Community エディションは無料で使用でき、アカウントにサインアップする必要はありません。これは、ライセンスを必要としない Docker イメージから実行されます。LocalStack Community Edition の詳細については、「LocalStack Community イメージ」ドキュメントを参照してください。以下のセクションでは、VS Code で LocalStack Community エディションを使用するために必要な前提条件と基本的なセットアップについて説明します。

新しいインスタンスの起動

LocalStack Community の新しいインスタンスを起動するには、次の手順を実行します。

注記

次の例では、ポート 4566 で LocalStack のコンテナインスタンスを起動します。異なるポート値を指定する場合は、「 AWS CLI と AWS Toolkit の設定」セクションにある手順で指定されたポート値を更新する必要があります。

  1. VS Code から、ctrl + `(backtick) を押して VS Code ターミナルを開きます。

  2. ターミナルウィンドウで、以下を入力します。

    Mac:

    docker run -d --name localstack_main \
>> -p 4566:4566 \
>> -v /var/run/docker.sock:/var/run/docker.sock \
>> localstack/localstack

    Windows:

    docker run -d --name localstack_main `
>> -p 4566:4566 `
>> -v /var/run/docker.sock:/var/run/docker.sock `
>> localstack/localstack

  3. プロセスが完了すると、ターミナルで Docker インスタンスのステータスが更新されます。

LocalStack のこのコンテナ化されたインスタンスでは、ダウンロードプロセス中に指定した AWS サービスにアクセスできます。

LocalStack と Docker 用の CLI の設定。

Docker で LocalStack と連携するように AWS CLI と AWS Toolkit を設定するには、次の手順を実行して新しいプロファイルを設定します。

  1. VS Code から、ctrl + `(backtick) を押して VS Code ターミナルを開きます。

  2. ターミナルウィンドウで、以下を入力します。

    ~/.aws/credentials
[localstack]
aws_access_key_id = test
aws_secret_access_key = test
~/.aws/config
[profile localstack]
region = us-east-1
output = json
endpoint_url = http://localhost:4566 [default localstack endpoint]

  3. AWS Toolkit は LocalStack プロファイルを検出し、接続ステータスメニューを更新します。

セットアップ後、ステータスバーのプロファイルセクションから LocalStack AWS プロファイルを選択すると、LocalStack リソースが AWS エクスプローラーに表示されます。さらに、VS Code ターミナルの [Output] タブで LocalStack ログを表示できます。

VS Code での LocalStack の開始

次のいずれかの方法で LocalStack の使用を開始できます。

VS Code ステータスバーからの LocalStack の開始

  1. VS Code からステータスバーに移動し、[Start LocalStack] ボタンを選択して LocalStack を起動します。

  2. LocalStack が正常に起動すると、VS Code ステータスバーが更新されます。

VS Code コマンドパレット からの LocalStack の開始

  1. VS Code で Cmd + Shift + P (Mac) または Control + Shift + P (Windows) を押して、コマンドパレットを開きます。

  2. コマンドパレットから、検索バーに Start LocalStack と入力し、結果に表示されたら選択します。

  3. LocalStack が正常に起動すると、VS Code ステータスバーが更新されます。

VS Code ターミナルからの LocalStack の開始

  1. VS Code から、ctrl + `(backtick) を押して VS Code ターミナルを開きます。

  2. VS Code ターミナルから、localstack start CLI コマンドを入力します。

  3. LocalStack が正常に起動すると、VS Code ステータスバーが更新されます。

サンプルサーバーレスアプリケーションのビルド

VS Code で LocalStack の使用を開始するには、サンプルサーバーレスアプリケーションが必要です。 AWS アカウントに既存のアプリケーションがある場合は、LocalStack を使用してローカルにデプロイすることも、 AWS Serverless Land を使用して新しいアプリケーションを作成することもできます。

AWS ツールキットで Serverless Land を使用してアプリケーションを作成する方法の詳細については、本ユーザーガイドの「AWS Serverless Land の使用」トピックを参照してください。Serverless Land の詳細については、Serverless Land ウェブアプリケーションのメインランディングページを参照してください。

LocalStack を使用した Lambda 関数のテストとデバッグ

LocalStack VS Code 拡張機能での Lambda 関数のテストとデバッグは、 AWS クラウドにデプロイされた関数の操作に似ています。主な違いは、LocalStack を使用して関数をデプロイおよびデバッグするために、 AWS ツールキットインスタンスを LocalStack アカウントで認証する必要があることです。

注記

このセクションで説明するテストおよびデバッグ機能は、LocalStack Community エディションでは使用できません。

VS Code で LocalStack を使用するには、 AWS ツールキットの LocalStack プロファイルに接続します。LocalStack プロファイルがアクティブな場合、VS Code ステータスバーには AWS: profile:localstack (カスタムエンドポイント) とチェックマークが表示されます。

AWS Toolkit での Lambda 関数の使用の詳細については、このユーザーガイドのAWS Lambda 関数の使用トピックを参照してください。