AWS Toolkit for Visual Studio Code

AWS Toolkit for Visual Studio Code

AWS Toolkit

♦ この拡張サービスは開発者にとってAmazon Web Services (AWS)のサーバレスアプリケーションの開発/デバッグをローカルで行うのに役立てくれます。

AWS Toolkit for Visual Studio Codeは下記に従えば使用することができます。

  • サーバレスアプリケーション開発をローカルで行い、対象のAWSアカウントにデプロイする (参照 Usage).
  • 対象アカウントのAWSリソースの管理 (参照 Usage)
  • これは下記のことを含みます:
    1. 登録されているAWS CloudFormationを検索し削除する。
    2. LAWS Lambdaのコンポーネントを検索し、追加する。

準備

  1. AWSのアカウント
  2. 作業用ローカルPC OS – Windows, Linux, and macOS
  3. VS Code version 1.31.1またはそれ以降

推奨

  1. AWS SAM CLI – サーバレスアプリケーション開発、テスト、分析をローカルで行うのに役立ちします。
    こちらはtoolkitに必須という訳ではありません。ただ、こちらとDockerをインストールすることをお勧めします。なぜなら様々なAWS Serverless Application Model (AWS SAM)で必要であり、サーバレスアプリケーションの色々な機能を使うことができます。AWS SAM CLIのインストールについては こちらを確認してください。
  2. Docker – AWS SAM CLIを使用する場合は必須です。

インストール

  1. VScodeアプリケーションを開き、アクティブバーのExtensionアイコンを選択してください。その後、“AWS Toolkit for Visual Studio Code”を検索してください。
    参考
    Vscode websiteからtoolkitをインストールすることもできます。toolkitリンク
  2. インストールを選択します。
  3. インストール後、リロードが要求されたらアプリケーションをリスタートする必要があります。インストールが成功していれば, AWSアイコンがアクティブバー内に表示されます。

AWS Access Keysの取得

♦ Access keysはアプリケーションからAWSサービスやリソースへのアクセスを許可させるかどうかの判断を行う情報になります。Access keysはAWSアカウントに関連づけられたもの”root user”もしくはAWS Identity and Access Management (IAM)として作成されアクセス許可を得たものになります。

注意

“root user”は全てのサービスやリソースにアクセスできるユーザのためIAMを作成し、必要なタスクを行うために必要な権限を付与するようにすることをお勧めします。その時に、AWSアカウントユーザに関連づけられたアクセスキーをクレデンシャルとして使用します。
詳しくはこちらを参照してください。

クレデンシャルプロファイルの作成

  1. VSCodeを開く
  2. Ctrl + Shift + P (open Command Palette)を押下します。
  3. AWS: Create Credentials Profileを検索し選択します。
  4. プロファイル名を入力します (ex: default).
  5. access key IDを入力します。
  6. secret keyを入力します。

AWS Toolkit for Visual Studio Codeを通してAWSにアクセスします。

  1. VScodeを開きます。
  2. Ctrl + Shift + P (open Command Palette)を押下します。
  3. AWS: Connect to AWS.で検索します。
  4. profileをリストから選択します。

    右下の角に小さいポップアップウィンドウで接続確認が出た場合は、Yesを選択します。
  5. AWSに接続することができました。リージョンを選択することが可能になります。

 

ローカルホスト内でのAWS SAMの環境作成

必須事項:
♦ Administration権限を持ったIAMユーザ
♦ Dockerのインストールおよび起動
♦ AWS CLIとAWS SAMのインストール
♦ AWS S3に使用できるバケット

  1. “Create new SAM Application”を選択します。
  2. SAM applicationで使用するプログラミング言語を選択します。
  3. 新しいプロジェクトを保存するフォルダーを選択します。
  4. 新しいプロジェクトの名前を入力します。
  5. これはSAMのサンプルです。
  6. ローカル環境でmfile app.jsファイルを開き、AWS SAM applicationを動かすために”Run Locally”を選択します。
  7. その時、VSコードのタブの”OUTPUT”にAPIの結果が表示されます。

ローカル環境でのAWS SAM Applicationのデバッグ

“Debug Locally”を選択します。その後debugで止め情報を見たいところのポイントを選択します。

AWS SAM ApplicationをAWS上にデプロイする

  1. “Deploy SAM Application”を選択します。
  2. AWSにデプロイするSAMのtemplateファイルを選択します。
  3. デプロイするAWSのリージョンを選択します。
  4. デプロイ先のS3バケット名を入力します。(このバケットはS3に存在しているものです。)
  5. デプロイ先のstackの名前を入力します。
  6. AWSへアップロードが成功したら、AWSエクスプローラ上で新しいCloudFormationとLambdaが表示されます。