AWS Toolkit for VS Code - ユーザーガイド...• Visual Studio Code AWS Toolkit を介した AWS への接続 (p. 8) • AWS リージョンを変更する (p. 10) • ツールチェーンの設定

AWS Toolkit for VS Codeユーザーガイド

AWS Toolkit for VS Code ユーザーガイド

AWS Toolkit for VS Code: ユーザーガイドCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's,in any manner that is likely to cause confusion among customers, or in any manner that disparages or discreditsAmazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may notbe affiliated with, connected to, or sponsored by Amazon.


Table of ContentsVisual Studio Code AWS Toolkit ........................................................................................................... 1

Visual Studio Code AWS Toolkit とは ............................................................................................ 1関連情報 .................................................................................................................................... 1

セットアップ ..................................................................................................................................... 2Toolkit for VS Code をインストールする ........................................................................................ 2

前提条件 ............................................................................................................................ 2VS Code Toolkit のインストール .......................................................................................... 3

認証情報の設定 .......................................................................................................................... 4AWSでサポートされる認証情報の使用 ................................................................................... 4外部認証情報プロセスの使用 ................................................................................................ 8

AWS に接続する ........................................................................................................................ 8VS Code Toolkit を通じて AWS に接続する ........................................................................... 8ツールキットで複数の AWS アカウントを使用する ............................................................... 10

AWS リージョンを変更する ....................................................................................................... 10AWS Explorer にリージョンを追加する ................................................................................ 11AWS Explorer からリージョンを非表示にする ....................................................................... 12

ツールチェーンの設定 ............................................................................................................... 13.NET Core 用ツールチェーンを設定する .............................................................................. 13Node.js 用のツールチェーンを設定する ................................................................................ 14Python 用のツールチェーンを設定する ................................................................................. 14ツールチェーンの使用 ....................................................................................................... 14

VS Code Toolkit のナビゲーション ...................................................................................................... 15基本的な UI コンポーネント ....................................................................................................... 15

AWS Explorer .................................................................................................................. 15AWS CDK Explorer ........................................................................................................... 16

コマンドの場所 ......................................................................................................................... 16Visual Studio Code コマンドパレット .................................................................................. 16AWS Explorer メニュー ..................................................................................................... 18

AWS サービスでの作業 ..................................................................................................................... 19AWS Explorer .......................................................................................................................... 19

AWS サーバーレスアプリケーション ................................................................................... 20AWS Lambda 関数 ........................................................................................................... 26AWS CloudFormation スタック ........................................................................................... 29Amazon EventBridge ......................................................................................................... 30AWS Step Functions ......................................................................................................... 32

Amazon ECS ........................................................................................................................... 40タスク定義ファイルでの IntelliSense の使用 ......................................................................... 40

AWS CDK Explorer ................................................................................................................... 41AWS CDK アプリケーション .............................................................................................. 41

セキュリティ .................................................................................................................................... 45データ保護 ............................................................................................................................... 45Identity and Access Management ................................................................................................ 46ログ記録とモニタリング ............................................................................................................ 46Compliance Validation ............................................................................................................... 47Resilience ................................................................................................................................ 47Infrastructure Security ................................................................................................................ 48設定と脆弱性の分析 .................................................................................................................. 48

ドキュメント履歴 .............................................................................................................................. 49

iii

AWS Toolkit for VS Code ユーザーガイドVisual Studio Code AWS Toolkit とは

Visual Studio Code AWS Toolkitこれは、AWS VS Code Toolkit のユーザーガイドです。AWS Toolkit for Visual Studio をお探しの場合は、「AWS Toolkit for Visual Studio 用ユーザーガイド」を参照してください。

Visual Studio Code AWS Toolkit とはVS Code Toolkit は、Visual Studio コード (VS Code) エディタのオープンソースの拡張機能です。この拡張機能により、開発者は Amazon Web Services (AWS) を使用するサーバーレスアプリケーションの開発、ローカルでのデバッグ、デプロイが簡単になります。

トピック

• Visual Studio Code AWS Toolkit の設定 (p. 2)• Visual Studio Code AWS Toolkit のナビゲーション (p. 15)• AWS サービスでの作業 (p. 19)

関連情報ツールキットのソースコードにアクセスしたり、現在未解決の問題を表示したりするには、次のリソースを使用します。

• ソースコード• 問題追跡

Visual Studio Code エディタの詳細については、https://code.visualstudio.com/ を参照してください。

1

https://docs.aws.amazon.com/AWSToolkitVS/latest/UserGuide/

https://github.com/aws/aws-toolkit-vscode

https://github.com/aws/aws-toolkit-vscode/issues

https://code.visualstudio.com/

AWS Toolkit for VS Code ユーザーガイドToolkit for VS Code をインストールする

Visual Studio Code AWS Toolkit の設定

このセクションは、Visual Studio Code AWS Toolkit の設定に役立ちます。ツールキットのインストールと設定、認証情報のセットアップ、AWS への接続の方法に関する情報を提供します。

トピック• Visual Studio Code AWS Toolkit をインストールする (p. 2)• Visual Studio Code AWS Toolkit の認証情報の設定 (p. 4)• Visual Studio Code AWS Toolkit を介した AWS への接続 (p. 8)• AWS リージョンを変更する (p. 10)• ツールチェーンの設定 (p. 13)

Visual Studio Code AWS Toolkit をインストールする

このセクションでは、Visual Studio Code AWS Toolkit をインストールする方法について説明します。

前提条件必須VS Code Toolkit をインストールするには、以下が必要です。

• アマゾンウェブサービスのアカウント – AWS アカウントを取得するには、AWS のホームページにアクセスします。[Create an AWS Account (AWS アカウントを作成する)]、または [サインアップを完成する] (以前にサイトにアクセスしたことがある場合) を選択します。サインアップすると、AWS のすべてのサービスを使用できるようになります。

• サポートされているオペレーティングシステム – VS Code Toolkit は Windows、Linux、macOS でサポートされています。

• VS Code バージョン 1.31.1 以降 – VS Code ダウンロードページで利用できるデフォルトバージョンを使用して、VS Code Toolkit を最新の状態に維持します。

オプションVS Code Toolkit の特定の機能を使用する前に、以下のものが必要です。

• コード開発 – 使用する言語の関連する SDK。以下のリンクからダウンロードするか、お好みのパッケージマネージャーを使用できます。• .NET SDK: https://dotnet.microsoft.com/download

2

https://aws.amazon.com/

https://code.visualstudio.com/

https://dotnet.microsoft.com/download

AWS Toolkit for VS Code ユーザーガイドVS Code Toolkit のインストール

• Node.js SDK: https://nodejs.org/en/download• Python SDK: https://www.python.org/downloads

• AWS SAM CLI – この AWS CLI ツールを使用することで、サーバーレスアプリケーションをローカルで開発、テスト、および分析しやすくなります。これは、ツールキットのインストールには必要ありません。ただし、サーバーレスアプリケーションの作成 (p. 21) などの AWS サーバーレスアプリケーションモデル (AWS SAM) 機能に必要なため、次に説明する Docker とともにインストールすることをお勧めします。

詳細については、AWS サーバーレスアプリケーションモデル開発者ガイドの「AWS SAM CLI のインストール」を参照してください。

• Docker – このオープンソースのソフトウェアコンテナプラットフォームは、AWS SAM CLI で必要です。詳細およびダウンロード手順については、「Docker」を参照してください。

VS Code Toolkit のインストール1. VS Code エディタを起動します。2. VS Code エディタの側にある [Activity Bar (アクティビティっバー)] で、[Extensions (拡張機能)] アイ

コンを選択します。これにより、[Extensions (拡張機能)] ビューが開き、VS Code Marketplace にアクセスできます。

3. [Extensions (拡張機能)] の検索ボックスで、[Visual Studio Code AWS Toolkit] を検索します。エントリを選択して、右ペインで詳細を表示します。

4. 右のペインの [Install] を選択します。5. インストール後、エディタを再起動するよう求められたら、[Reload Required (再ロードが必要)] を選

択してインストールを完了します。

VS Code Toolkit のインストールが完了したら、VS Code 内から AWS リソースにアクセスできるように、認証情報 (p. 4)を設定する必要があります。

3

https://nodejs.org/en/download

https://www.python.org/downloads

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html

https://www.docker.com/

AWS Toolkit for VS Code ユーザーガイド認証情報の設定

Visual Studio Code AWS Toolkit の認証情報の設定このセクションでは、AWS VS Code Toolkit で使用できる認証情報のタイプを示します。また、これらの認証情報を取得および設定する方法に関する情報も提供します。

設定ファイルを使用して、AWS から認証情報を取得し、ツールキットに渡すことができます。また、AWS によって直接サポートされない外部認証情報プロセスを介して、認証情報を取得することもできます。

トピック• AWSでサポートされる認証情報の使用 (p. 4)• 外部認証情報プロセスの使用 (p. 8)

AWSでサポートされる認証情報の使用共有 AWS 設定ファイルまたは共有 AWS 認証情報ファイルを使用して、AWS 認証情報を AWS VS CodeToolkit に提供できます。これらのファイルを使用する方法は AWS CLI で使用する方法と同じです。これらのファイルの使用方法に関する一般的な情報については、AWS Command Line Interface ユーザーガイドの「設定ファイルと認証情報ファイル」を参照してください。

トピック• AWS アクセスキーの取得 (p. 4)• AWS 認証情報のセットアップ (p. 5)

AWS アクセスキーの取得Visual Studio Code AWS Toolkit で Amazon Web Services (AWS) にアクセスするには、AWS アカウントの認証情報を使用してツールキットを設定する必要があります。AWS でサポートされる認証情報を使用してこれを行うには、まず適切な AWS アクセスキーを取得する必要があります。

このガイドに記載していないユーザーおよび認証情報に関する詳細については、以下のリソースを参照してください。

• AWS セキュリティ認証情報 (アマゾンウェブサービス全般のリファレンス)• ID 管理の概要: ユーザー (IAM ユーザーガイド)

AWS アクセスキーとはアクセスキーは、AWS で個人を識別する認証情報であり、これを使用することで、AWS サービスおよびリソースにプログラムでアクセスすることができます。アクセスキーは、AWS アカウント (アカウントの「ルートユーザー」)、または AWS Identity and Access Management (IAM) を使用して作成したユーザーと関連付けることができます。

Warning

基本的に、ルートユーザーはサービスやリソースへのフルアクセス権を持つ管理者であるため、必要なタスクを実行するのに必要なアクセス許可のみ付与した IAM ユーザーを作成することをお勧めします。これで、認証情報で、そのユーザーに関連付けられているアクセスキーを使用できます。詳細については、『IAM ユーザーガイド』の「AWS アカウント内での IAM ユーザーの作成」を参照してください。

アクセスキーは、アクセスキー ID (ユーザー名のようなもの) と、シークレットアクセスキー (パスワードのようなもの) から構成されています。このアクセスキーは、AWS へのプログラムによるリクエストの署名に使用されます。アクセスキーがない場合は、AWS マネジメントコンソールを使用して作成すること

4

https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html

https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_identity-management.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html

AWS Toolkit for VS Code ユーザーガイドAWSでサポートされる認証情報の使用

ができます。アカウントのルートユーザーのキーではなく、IAM ユーザーのアクセスキーを使用することをお勧めします。

Note

アクセスキーを作成するには、必要な IAM アクションを実行するアクセス許可が必要です。詳細については、『IAM ユーザーガイド』の「パスワードポリシーと認証情報を管理する IAM ユーザーアクセス許可の付与」を参照してください。

AWS アクセスキーを取得する

1. IAM コンソール (https://console.aws.amazon.com/iam/) を開きます。2. ナビゲーションメニューで [ユーザー] を選択します。3. IAM ユーザー名を選択して (チェックボックスではない)、詳細を表示します。4. [セキュリティ認証情報] タブで、[アクセスキーの作成] を選択します。5. 新しいアクセスキーを表示するには、[表示] を選択します。認証情報は次のようになります。

• アクセスキー ID: AKIAIOSFODNN7EXAMPLE• シークレットアクセスキー: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

6. キーペアをダウンロードするには、[.csv ファイルのダウンロード] を選択します。このキーは安全な場所に保存してください。

Important

• AWS アカウントを保護するためにキーは機密として扱い、メールでは決して送信しないでください。また、所属している組織外にこの情報を公開してはいけません。AWS またはAmazon.com を名乗る人物から問い合わせがあった場合でも、この情報は開示しないでください。Amazon のスタッフまたは関係者がこの情報を尋ねることは決してありません。

• シークレットキーを紛失しても、復元することはできません。セキュリティ上の理由から、紛失した場合は、新しいキーペアを作成し、古いペアは削除する必要があります。

AWS アクセスキーを取得したら、AWS VS Code Toolkit を使用して、それらのファイルを共有 AWS 設定ファイルまたは共有 AWS 認証情報ファイルに保存できます。その方法については、「環境に AWS アクセスキーを追加する (p. 6)」を参照してください。

AWS 認証情報のセットアップVisual Studio Code AWS Toolkit を使用して Amazon Web Services (AWS) にアクセスするには、AWS アカウント認証情報をツールキットで使用できるようにする必要があります。AWSでサポートされる認証情報を使用するには、このトピックの続きを参照してください。外部認証情報プロセスを使用するには、「外部認証情報プロセスの使用 (p. 8)」を参照してください。

Note

サーバーレスアプリケーションの作成など VS Code Toolkit の一部の機能は、AWS 認証情報を必要としません。

AWS アクセスキーを取得する共有 AWS 設定ファイルまたは共有 AWS 認証情報ファイルに保存するための適切な AWS アクセスキーがまだない場合は、ここで取得する必要があります。

これを行うには、「AWS アクセスキーの取得 (p. 4)」を参照してください。

共有 AWS ファイルについて共有 AWS 設定ファイルと共有 AWS 認証情報ファイルは、AWS の設定と認証情報を保存するために使用できるファイルです。デフォルトでは、これらのファイルはホームディレクトリ内の .aws ディレクト

5

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users

https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_delegate-permissions.html

https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_delegate-permissions.html

https://console.aws.amazon.com/iam/


リにあり、それぞれ config と credentials という名前です。詳細については、AWS Command LineInterface ユーザーガイドの「設定の保存場所」を参照してください。

VS Code Toolkit は、共有 AWS 設定ファイルと共有 AWS 認証情報ファイルを通じて AWS アクセスキーを見つけて使用します。これは、AWS CLI および AWS SDK で使用されるメソッドです。VS CodeToolkit に入力したアクセスキーは、これらのファイルのいずれかに保存されています。

これらの共有ファイルには、複数の AWS アカウントの認証情報をプロファイルとして保存できます。複数のアカウントがあると便利なのは、たとえば、開発用とリリース/公開用にリソースを区別して開発者と管理者に提供する場合です。

環境に AWS アクセスキーを追加する

(AWS CLI などを使用して) AWS 認証情報をすでに設定している場合は、VS Code Toolkit は自動的にそれらの認証情報を検出し、ツールキットで使用できるようにします。AWS 認証情報をまだ設定していない場合、環境に追加の AWS 認証情報を含める場合、または既存の認証情報プロファイルを更新する場合は、ここで示すように VS Code Toolkit を通じて行うことができます。

Note

ここでの手順を実行する代わりに、aws configure AWS CLI コマンドを使用して AWS 認証情報を環境に追加できます。aws configure を使用して、サーバーレスアプリケーションの作成などの特定のオペレーションに必要なデフォルトの AWS リージョンを設定することもできます。

AWS 共有認証情報ファイルの作成

• すでに AWS 共有認証情報ファイルがある場合は、次の手順 (p. 7)に進むことができます。• すでに共有 AWS 設定ファイルがあり、そのファイルを使用する場合は、次の手順 (p. 7)に進むこと

ができます。• 共有 AWS 設定ファイルのみがあり、そのファイルを使用しない場合は、オペレーティングシステムで

の通常の手法を使用して、まず共有 AWS 認証情報ファイルを作成する必要があります。その後、次の手順 (p. 7)に進むことができます。

以下のステップに従って、AWS 共有認証情報ファイルを作成します。

1. VS Code を開きます。2. [Command Palette (コマンドパレット)] を開くには、メニューバーで、[表示] 、[Command Palette (コ

マンドパレット)] の順に選択します。または、次のショートカットキーを使用します。

• Windows および Linux – [Ctrl+Shift+P] を押します。• macOS – [Shift+Command+P] を押します。

3. [AWS] を検索し、[AWS: Create Credentials Profile (AWS: 認証情報プロファイルを作成する)]を選択します。

6

https://docs.aws.amazon.com/cli/latest/userguide/


https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-where


https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html


4. 初期プロファイルの名前を入力します。

5. 認証情報のアクセスキー ID を入力します。アクセスキー ID がない場合は、「AWS アクセスキーの取得 (p. 4)」を参照してください。

6. 認証情報のシークレットアクセスキーを入力しますを入力します。シークレットアクセスキーがない場合は、「AWS アクセスキーの取得 (p. 4)」を参照してください。

この手順を完了したら、AWS 共有認証情報ファイルを直接開くか、次の手順の最初の 3 つのステップを実行することで (更新を行わずに)、共有認証情報ファイルを検証できます。

いずれかの共有ファイルを更新する

以下のステップに従って、既存の共有 AWS 設定ファイルまたは共有 AWS 認証情報ファイルに新しいプロファイルを追加します。既存のプロファイルを更新することもできます。

1. VS Code を開きます。2. [Command Palette (コマンドパレット)] を開くには、メニューバーで、[表示] 、[Command Palette (コ



3. [AWS] を検索し、[AWS: Create Credentials Profile (AWS: 認証情報プロファイルを作成する)]を選択します。

4. 共有ファイルの一方または両方が VS Code エディタで開いたら、プロファイルを追加または更新します。

5. ファイルの更新が完了したら、ファイルを保存します。

7

AWS Toolkit for VS Code ユーザーガイド外部認証情報プロセスの使用

外部認証情報プロセスの使用AWS で直接サポートされない認証情報を生成または検索するプロセスがある場合、保存された AWS 認証情報 (p. 4)の代わりにそのプロセスを使用するように、AWS VS Code Toolkit を設定できます。

このような外部認証情報プロセスを指定する方法は、AWS CLI での方法と同じであり、共有 AWS 設定ファイルへの credential_process 定義の追加から成ります。この方法の詳細については、AWSCommand Line Interface ユーザーガイドの「外部プロセスを使用した認証情報の調達」を参照してください。

Visual Studio Code AWS Toolkit を介した AWS への接続

Visual Studio Code AWS Toolkit を通じて Amazon Web Services (AWS) を操作するには、AWS への接続を確立する必要があります。

VS Code Toolkit を通じて AWS に接続する1. VS Code を開きます。2. [Command Palette (コマンドパレット)] を開くには、メニューバーで、[表示] 、[Command Palette (コ



3. [AWS] を検索し、[AWS: Connect to AWS (AWS への接続)] を選択します。

4. リストからプロファイルを選択します。

認証情報プロファイルを設定していない場合は、セットアップするよう求められます。エディタの右下隅にあるポップアップを探します。[はい] を選択し、セットアップウィザードに従ってプロファイル名、アクセスキー ID、シークレットアクセスキーを入力します。詳細については、「AWS 認証情報のセットアップ (p. 5)」を参照してください。

8

https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-sourcing-external.html

AWS Toolkit for VS Code ユーザーガイドVS Code Toolkit を通じて AWS に接続する

Note

AWS でサポートされる認証情報を使用する代わりに外部認証情報プロセスを提供する場合は、[No (いいえ)] を選択し、代わりに「外部認証情報プロセスの使用 (p. 8)」を参照してください。

5. [AWS Explorer] と呼ばれる [AWS: Explorer] サイドバーを開き、接続を確認します。AWS リージョンのリスト ([AWS Explorer] でリージョンを表示している場合 (p. 11)) か、リージョンを [AWSExplorer] に追加するメッセージが表示されます。

[AWS Explorer] にリージョンを追加する (p. 10)前に、以下が表示されます。

9

AWS Toolkit for VS Code ユーザーガイドツールキットで複数の AWS アカウントを使用する

[AWS Explorer] にリージョンを追加すると、次のような内容が表示されます。

ツールキットで複数の AWS アカウントを使用するVS Code Toolkit からアクセスする複数の AWS アカウントがあってもかまいません。複数のアカウントがあると便利なのは、たとえば、開発用とリリース/公開用にリソースを区別して開発者と管理者に提供する場合です。

AWS 認証情報の各セットは、共有 AWS 設定ファイルまたは共有 AWS 認証情報ファイル内にプロファイルとして保存されています。別の認証情報セットを選択するには、前の手順のステップに従って別のプロファイルを選択します。

AWS リージョンを変更する認証情報をセットアップすると、Visual Studio Code AWS Toolkit は、それらの認証情報のデフォルトのAWS リージョンを選択して、[AWS Explorer] に表示します。このトピックでは、[AWS Explorer] に表示されるリージョンのリストを変更する方法について説明します。

10

AWS Toolkit for VS Code ユーザーガイドAWS Explorer にリージョンを追加する

AWS Explorer にリージョンを追加する1. [Command Palette (コマンドパレット)] を開くには、メニューバーで、[表示] 、[Command Palette (コ



2. [AWS] を検索し、[AWS: Show Region in the Explorer (AWS: Explorer のリージョンを表示する)] を選択します。

3. [AWS Explorer] に追加するリージョンを選択します。

Note

[AWS Explorer] に追加できるリージョンのみが含まれています。すでに追加したリージョンはリストに表示されません。

4. リージョンが [AWS Explorer] に表示されることを確認します。

11

AWS Toolkit for VS Code ユーザーガイドAWS Explorer からリージョンを非表示にする

AWS Explorer からリージョンを非表示にする1. [Activity bar (アクティビティバー)] の AWS アイコンを選択して、[AWS Explorer] を開きます。2. リスト内のリージョンの 1 つを選択し、コンテキストメニューを開きます。

12

AWS Toolkit for VS Code ユーザーガイドツールチェーンの設定

3. [Hide Region from the Explorer (Explorer からリージョンを非表示にする)] を選択します。

ツールチェーンの設定Visual Studio Code AWS Toolkit は、AWS とのやり取りに使用できる複数の言語をサポートしています。このトピックでは、これらの言語ごとにツールチェーンをセットアップする方法について説明します。

.NET Core 用ツールチェーンを設定する1. VS Code Toolkit がインストールされていること (p. 3)を確認します。2. C# 拡張機能をインストールします。この拡張機能は、VS Code が .NET Core アプリケーションをデ

バッグできるようにします。3. AWS サーバーレスアプリケーションモデル (AWS SAM) アプリケーションを開くか、アプリケーショ

ンを作成します (p. 21)。4. template.yaml が含まれているフォルダを開きます。

13

https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp

AWS Toolkit for VS Code ユーザーガイドNode.js 用のツールチェーンを設定する

Node.js 用のツールチェーンを設定する1. VS Code Toolkit がインストールされていること (p. 3)を確認します。2. AWS SAM アプリケーションを開くか、アプリケーションを作成します (p. 21)。3. template.yaml が含まれているフォルダを開きます。

Python 用のツールチェーンを設定する1. VS Code Toolkit がインストールされていること (p. 3)を確認します。2. Visual Studio Code の Python 拡張機能をインストールします。この拡張機能により、VS Code は

Python アプリケーションをデバッグできます。3. AWS SAM アプリケーションを開くか、アプリケーションを作成します (p. 21)。4. template.yaml が含まれているフォルダを開きます。5. アプリケーションのルートにあるターミナルを開き、python -m venv ./.venv を実行して

virtualenv を設定します。

Note

システムごとに virtualenv を 1 回のみ設定する必要があります。6. 次のいずれかを実行して virtualenv をアクティブ化します。

• Bash shell: ./.venv/Scripts/activate• PowerShell: ./.venv/Scripts/Activate.ps1

ツールチェーンの使用ツールチェーンを設定したら、それを使用して AWS SAM アプリケーションを実行またはデバッグ (p. 22)できます。

14

https://marketplace.visualstudio.com/items?itemName=ms-python.python

AWS Toolkit for VS Code ユーザーガイド基本的な UI コンポーネント

Visual Studio Code AWS Toolkit のナビゲーション

このトピックでは、Visual Studio Code AWS Toolkit で操作する方法について説明します。このトピックを読む前に、必ずツールキットをインストール (p. 2)してください。

Visual Studio Code ユーザーインターフェイス (UI) に関する一般的な情報については、VS Code の「UI ドキュメント」を参照してください。

基本的な UI コンポーネントAWS VS Code Toolkit の基本的な UI コンポーネントは以下のとおりです。

AWS Explorer• 次の図は、AWS Explorer の基本的な UI コンポーネントを示しています。これを使用して実行できる

ことの詳細については、「AWS Explorer で AWS のサービスを操作する (p. 19)」を参照してください。

[AWS Explorer] は、より正式には [AWS: Explorer Side Bar (Explorer サイドバー)] と呼ばれます。

15

https://code.visualstudio.com/docs/getstarted/userinterface

https://code.visualstudio.com/docs/getstarted/userinterface

AWS Toolkit for VS Code ユーザーガイドAWS CDK Explorer

AWS CDK Explorer• 次の図は、AWS CDK Explorer の基本的な UI コンポーネントを示しています。これを使用して実行でき

ることの詳細については、「AWS CDK Explorer の操作 (p. 41)」を参照してください。

これはプレビューリリースの機能に関するプレリリースドキュメントです。このドキュメントは変更される可能性があります。

コマンドの場所VS Code Toolkit のコマンドは、さまざまな場所にあります。

Visual Studio Code コマンドパレットVS Code コマンドパレットには、AWS のサービスを操作するために使用できるすべてのコマンドが含まれています。これらのコマンドを表示するには、[表示] メニューから VS Code コマンドパレットを開きます。または、次のショートカットを使用します。


16

AWS Toolkit for VS Code ユーザーガイドVisual Studio Code コマンドパレット

次に、AWSをフィルタリングできます。

17

AWS Toolkit for VS Code ユーザーガイドAWS Explorer メニュー

AWS Explorer メニューAWS Explorer には、AWS のサービスを操作するための最も一般的なコマンドを含む [More Actions (その他のアクション)] メニューがあります。

18

AWS Toolkit for VS Code ユーザーガイドAWS Explorer

AWS サービスでの作業Visual Studio Code AWS Toolkit では、さまざまな AWS のサービスを表示して操作することができます。システムに VS Code Toolkit がすでにインストールされ、設定されていること (p. 2)を前提としています。

トピック• AWS Explorer で AWS のサービスを操作する (p. 19)• Amazon Elastic Container Service の使用 (p. 40)• AWS CDK Explorer の操作 (p. 41)

AWS Explorer で AWS のサービスを操作する[AWS Explorer ] には、Visual Studio Code AWS Toolkit を使用するときに操作できるいくつかの AWSサービスのビューが表示されます。「ナビゲーション (p. 15)」トピックで、[AWS Explorer] の概要ビューを参照してください。

このセクションでは、VS Code で [AWS Explorer] にアクセスして使用する方法について説明します。システムに VS Code Toolkit がすでにインストールされ、設定されていること (p. 2)を前提としています。

いくつかの重要なポイント:

• ツールキットがインストールされ、正しく設定されている場合は、[AWS Explorer] に項目が表示されます。[AWS Explorer] を表示するには、[Activity bar (アクティビティバー)] の AWS アイコンを選択します。

次に例を示します。

19

AWS Toolkit for VS Code ユーザーガイドAWS サーバーレスアプリケーション

• 特定の機能には、特定の AWS アクセス許可が必要です。たとえば、AWS アカウントの AWS Lambda関数を表示するには、「認証情報の設定 (p. 4)」で設定した認証情報に、少なくとも読み取り専用Lambda アクセス許可が含まれている必要があります。各機能に必要なアクセス許可の詳細については、以下のトピックを参照してください。

トピック• AWS サーバーレスアプリケーションの使用 (p. 20)• AWS Lambda 関数を操作する (p. 26)• AWS CloudFormation スタックの操作 (p. 29)• Amazon EventBridge の使用 (p. 30)• AWS Step Functions の使用 (p. 32)

AWS サーバーレスアプリケーションの使用Visual Studio Code AWS Toolkit は、サーバーレスアプリケーションをサポートします。VS Code Toolkitを使用して AWS Lambda 関数を含むサーバーレスアプリケーションを作成し、そのアプリケーションをAWS CloudFormation スタックにデプロイできます。

20

https://aws.amazon.com/serverless/

https://aws.amazon.com/lambda/


トピック• Visual Studio Code AWS Toolkit でサーバーレスアプリケーションを作成する (p. 21)• Visual Studio Code AWS Toolkit でサーバーレスアプリケーションをデプロイする (p. 24)

Visual Studio Code AWS Toolkit でサーバーレスアプリケーションを作成するこの例では、Visual Studio Code AWS Toolkit を使用してサーバーレスアプリケーションを作成し、それを実行およびデバッグする方法を示します。

前提条件

• システムが、「VS Code のツールキットをインストールする (p. 2)」で指定されている必要な前提条件を満たしていることを確認してください。

• さらに、AWS SAM CLI とその前提条件をインストールします。セットアップの前提条件 (p. 2)の「AWS SAM CLI」を参照してください。これらのインストールを実行するときに Visual Studio Code が開いている場合は、エディタを閉じて再度開く必要がある場合があります。

• AWS 設定ファイルでデフォルトの AWS リージョンを特定します。詳細については、AWS CLI ユーザーガイドの「設定と認証情報ファイル」を参照してください。設定ファイルを更新するときに VisualStudio Code が開いている場合は、エディタを閉じて再度開く必要がある場合があります。

• 言語 SDK をインストールしたら、ツールチェーンを設定 (p. 13)してください。

VS Code Toolkit でサーバーレスアプリケーションを作成する

この例では、AWS サーバーレスアプリケーションモデル (AWS SAM) を使用して VS Code Toolkit でサーバーレスアプリケーションを作成する方法を示します。

1. [Command Palette (コマンドパレット)] を開くには、[表示]、[Command Palette (コマンドパレット)]の順に選択し、[AWS] と入力します。

2. [AWS: Create new SAM Application (AWS: 新しい SAM アプリケーションの作成)] を選択します。

Note

AWS SAM CLI がインストールされていない場合は、VS Code エディタの右下隅にエラーが表示されます。その場合は、前述の前提条件 (p. 21)を参照してください。

3. SAM アプリケーションのランタイムを選択します。この例では、[nodejs10.x] を選択します。

21




https://docs.aws.amazon.com/serverless-application-model/


4. 新しいプロジェクトの場所を選択します。既存のワークスペースフォルダが開いている場合は、既存の別のフォルダを選択するか、新しいフォルダを作成して選択します。この例では、[There are noworkspace folders open (開いているワークスペースフォルダはありません)] を選択して、MY-SAM-APP という名前のフォルダを作成します。

5. 新しいプロジェクトの名前を入力します。この例では my-sam-app-nodejs を使用します。[Enter]を押した後、VS Code Toolkit でプロジェクトが作成されるまで少し時間がかかります。

プロジェクトが作成されると、アプリケーションは現在のワークスペースに追加されます。[Explorer] ウィンドウに表示されます。

サーバーレスアプリケーションの実行とデバッグAWS SAM アプリケーションが作成されたら、CodeLens インジケータを使用してアプリケーションを実行およびデバッグできます。

1. Project Explorer の hello-world ディレクトリから app.js を開きます (まだ開いていない場合)。

22

https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup


2. [Run Locally (ローカルで実行する)] CodeLens インジケータを選択します。

Note

イベント情報を指定するには、次に示すように、コードの [CodeLens] 行から [Configure (設定)] インジケータを選択します。

CodeLens インジケータが表示されない場合は、アクティビティバーの [AWS Explorer] アイコンを選択して CodeLens をアクティブ化します。

23


3. ローカル実行が完了すると、出力が [OUTPUT (出力)] タブまたは [TERMINAL (ターミナル)] タブに表示されます。

Note

Windows ユーザーの場合、このプロセス中に Docker マウントエラーが発生した場合は、共有ドライブの認証情報を更新する必要があります (Docker 設定)。Docker マウントエラーは次のようになります。

Fetching lambci/lambda:nodejs10.x Docker container image......2019-07-12 13:36:58 Mounting C:\Users\<username>\AppData\Local\Temp\ ... as /var/task:ro,delegated inside runtime containerTraceback (most recent call last):...requests.exceptions.HTTPError: 500 Server Error: Internal Server Error ...

4. [Debug Locally (ローカルでデバッグする)] CodeLens インジケータを選択して、アプリケーションをデバッグします。デバッグモードでは、アプリケーションの場合と同様にブレークポイントの設定、各行のステップ実行、変数の検査、値の変更を行うことができます。

Visual Studio Code AWS Toolkit でサーバーレスアプリケーションをデプロイするこの例では、Visual Studio Code AWS Toolkit を使用して、前のトピック(サーバーレスアプリケーションの作成 (p. 21)) で作成したサーバーレスアプリケーションを AWS にデプロイする方法を示します。

前提条件

• システムが、「VS Code のツールキットをインストールする (p. 2)」で指定されている前提条件を満たしていることを確認してください。

• 必ずグローバルに一意な Amazon S3 バケット名を選択してください。• 「認証情報の設定 (p. 4)」で設定した認証情報に、Amazon S3、AWS CloudFormation、AWS

Lambda、Amazon API Gateway などのサービスに対する適切な読み取り/書き込みアクセス許可が含まれていることを確認します。

24


サーバーレスアプリケーションをデプロイする

1. [Command Palette (コマンドパレット)] を開くには、[表示]、[Command Palette (コマンドパレット)]の順に選択し、[AWS] と入力します。

2. [AWS: Deploy SAM Application (AWS: SAM アプリケーションのデプロイ)] を選択します。

3. デプロイに使用する template.yaml ファイルを選択します。

4. デプロイ先の AWS リージョンを選択します。

5. このデプロイで使用できる Amazon S3 バケットの名前を入力します。バケットは、デプロイ先のリージョンにある必要があります。

Warning

Amazon S3 バケット名は、Amazon S3 のどの既存バケット名とも重複しない一意な名前であることが必要です。したがって、次の例に示す名前に一意の識別子を追加する必要があります (または、別の名前を選択してください)。

6. デプロイされたスタックの名前 (新しいスタック名または既存のスタック名) を入力します。

7. VS Code の [OUTPUT (出力)] タブで、デプロイの成功を確認します。

25

AWS Toolkit for VS Code ユーザーガイドAWS Lambda 関数

エラーが発生すると、右下に以下のようなメッセージが表示されます。

この場合は、[OUTPUT (出力)] タブのテキストで詳細を確認します。以下に示しているのは、エラーの詳細の例です。

Error with child process: Unable to upload artifact HelloWorldFunction referenced by CodeUri parameter of HelloWorldFunction resource.S3 Bucket does not exist. Execute the command to create a new bucketaws s3 mb s3://pbart-my-sam-app-bucketAn error occurred while deploying a SAM Application. Check the logs for more information by running the "View AWS Toolkit Logs" command from the Command Palette.

この例では、Amazon S3 バケットが存在しないためエラーが発生しました。

デプロイが完了したら、アプリケーションが [AWSExplorer] に表示されます。アプリケーションの一部として作成された Lambda 関数の呼び出し方法については、「リモート Lambda 関数の操作 (p. 26)」を参照してください。

AWS Lambda 関数を操作するVisual Studio Code AWS Toolkit では、AWS Lambda 関数がサポートされています。VS Code Toolkitを使用して、サーバーレスアプリケーションの一部である Lambda 関数のコードを記述できます。さらに、Lambda 関数をローカルまたは AWS で呼び出すことができます。

Lambda は、カスタムコードによって生成されるイベント、または Amazon Simple Storage Service(Amazon S3)、Amazon DynamoDB、Amazon Kinesis、Amazon Simple Notification Service (AmazonSNS)、および Amazon Cognito などのさまざまな AWS サービスから生成されるイベントに応答してコードを実行する、フルマネージド型のコンピューティングサービスです。

トピック• リモート Lambda 関数の操作 (p. 26)

リモート Lambda 関数の操作このトピックで後述するように、VS Code Toolkit を使用して AWS Lambda 関数をさまざまな方法で操作できます。

Lambda の詳細については、「AWS Lambda Developer Guide」を参照してください。Note

AWS マネジメントコンソールを使用する別の方法ですでに Lambda 関数を作成している場合は、Toolkit から呼び出すことができます。AWS Lambda にデプロイできる新しい関数を作成する

26


https://aws.amazon.com/serverless/


https://docs.aws.amazon.com/lambda/latest/dg/


には (VS Code を使用)、まず、サーバーレスアプリケーションを作成する (p. 21)必要があります。

前提条件


• 「認証情報の設定 (p. 4)」で設定した認証情報に、AWS Lambda サービスに対する適切な読み取り/書き込みアクセス許可が含まれていることを確認します。[Lambda] の [AWS Explorer] に「Error loadingLambda resources」のようなメッセージが表示された場合は、それらの認証情報にアタッチされているアクセス許可を確認します。アクセス許可に加えた変更は、VS Code の [AWS Explorer] に影響するまでに数分かかります。

Lambda 関数を呼び出す

AWS の Lambda 関数を VS Code Toolkit から呼び出すことができます。

1. [AWS Explorer] で、呼び出す Lambda 関数の名前を選択し、コンテキストメニューを開きます。

2. [Invoke on AWS (AWS での呼び出し)] を選択します。3. 開いた呼び出しウィンドウで、Lambda 関数に必要な入力を入力します。たとえば、Lambda 関数で

は、テキストボックスに示すように、入力として文字列を要求する場合があります。

27


Lambda 関数の出力が表示されます。これは、他のプロジェクトで VS Code を使用する場合と同様です。

Lambda 関数を削除します。同じコンテキストメニューを使用して Lambda 関数を削除することもできます。

Warning

この手順を使用して、AWS CloudFormation に関連付けられている Lambda 関数 (たとえば、このガイドの「サーバーレスアプリケーションの作成 (p. 21)」で先ほど作成した Lambda 関数)を削除しないでください。これらの関数は、AWS CloudFormation スタックを通じて削除する必要があります。

28

https://docs.aws.amazon.com/cloudformation/

AWS Toolkit for VS Code ユーザーガイドAWS CloudFormation スタック

1. [AWS Explorer] で、削除する Lambda 関数の名前を選択し、コンテキストメニューを開きます。

2. [削除] を選択します。3. 表示されるメッセージで、[はい] を選択して削除を確認します。

関数が削除されると、[AWS Explorer] に表示されなくなります。

AWS CloudFormation スタックの操作Visual Studio Code AWS Toolkit は、AWS CloudFormation をサポートしています。VS Code Toolkit を使用して、スタックの削除など、AWS CloudFormationで特定のタスクを実行できます。

トピック• AWS CloudFormation スタックの削除 (p. 29)

AWS CloudFormation スタックの削除Visual Studio Code AWS Toolkit を使用して AWS CloudFormation スタックを削除できます。

29

https://aws.amazon.com/cloudformation/

AWS Toolkit for VS Code ユーザーガイドAmazon EventBridge

前提条件


• 「認証情報の設定 (p. 4)」で設定した認証情報に、AWS CloudFormation サービスに対する適切な読み取り/書き込みアクセス許可が含まれていることを確認します。[CloudFormation] の [AWS Explorer] で、「Error loading CloudFormation resources」のようなメッセージが表示された場合は、それらの認証情報にアタッチされているアクセス許可を確認します。アクセス許可に加えた変更は、VS Code の [AWSExplorer] に影響するまでに数分かかります。

CloudFormation スタックを削除する

1. [AWS Explorer] で、削除する AWS CloudFormation スタックのコンテキストメニューを開きます。

2. [Delete CloudFormation Stack (CloudFormation スタックを削除する)] を選択します。3. 表示されるメッセージで、[はい] を選択して削除を確認します。

スタックが削除されると、[AWS Explorer] に表示されなくなります。

Amazon EventBridge の使用Visual Studio Code AWS Toolkit (VS Code) は、Amazon EventBridge をサポートしています。VS CodeToolkit を使用すると、EventBridge の特定の側面 (スキーマなど) を操作できます。

トピック• Amazon EventBridge スキーマの使用 (p. 30)

Amazon EventBridge スキーマの使用Visual Studio Code AWS Toolkit (VS Code) を使用すると、Amazon EventBridge スキーマに対してさまざまなオペレーションを実行できます。

前提条件


30

https://aws.amazon.com/eventbridge/

https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-schemas.html

AWS Toolkit for VS Code ユーザーガイドAmazon EventBridge

• 使用する EventBridge スキーマは、お客様の AWS アカウントで使用可能である必要があります。そうでない場合は、スキーマを作成またはアップロードします。「Amazon EventBridge ユーザーガイド」の「Amazon EventBridge スキーマ」を参照してください。

• AWS Explorer (p. 15) のサイドバーを開きます。

使用可能なスキーマの表示

1. AWS Explorer で、[スキーマ] を展開します。2. 表示するスキーマを含むレジストリの名前を展開します。たとえば、AWS が提供するスキーマの多く

は aws.events レジストリにあります。3. エディタでスキーマを表示するには、スキーマのコンテキストメニューを開き、[スキーマの表示] を

選択します。

使用可能なスキーマの検索

AWS Explorer で、次のいずれかの操作を行います。

• 検索するスキーマのタイトルの入力を開始します。AWS Explorer で、一致を含むスキーマタイトルがハイライト表示されます (ハイライト表示されたタイトルを表示するには、レジストリを展開する必要があります)。

31

https://docs.aws.amazon.com/eventbridge/latest/userguide/

https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-schemas.html

AWS Toolkit for VS Code ユーザーガイドAWS Step Functions

• [スキーマ] のコンテキストメニューを開き、[スキーマの検索] を選択します。または、[スキーマ] を展開し、検索するスキーマを含むレジストリのコンテキストメニューを開いて、[Search Schemas inRegistry (レジストリのスキーマの検索)] を選択します。[EventBridge スキーマの検索] ダイアログボックスで、検索するスキーマのタイトルの入力を開始します。ダイアログボックスには、一致を含むスキーマタイトルが表示されます。

ダイアログボックスにスキーマを表示するには、スキーマのタイトルを選択します。

使用可能なスキーマのコードの生成

1. AWS Explorer で、[スキーマ] を展開します。2. コードを生成するスキーマを含むレジストリの名前を展開します。3. スキーマのタイトルを右クリックし、[Download code bindings (コードバインドのダウンロード)] を

選択します。4. 表示されたウィザードのページで、以下を選択します。

• スキーマのバージョン• コードのバインド言語• 生成されたコードを保存するローカル開発マシン上のワークスペースフォルダ

AWS Step Functions の使用Visual Studio Code AWS Toolkit (VS Code) は、AWS Step Functions をサポートしています。VS CodeToolkit を使用して、Step Functions ステートマシンを作成、更新、および実行できます。

トピック• AWS Step Functions の使用 (p. 32)

AWS Step Functions の使用Visual Studio Code AWS Toolkit (VS Code) を使用すると、ステートマシンでさまざまなオペレーションを実行できます。

トピック• 前提条件 (p. 33)

32

https://aws.amazon.com/step-functions/

https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html


• VS Code でのステートマシンの使用 (p. 33)• ステートマシンのテンプレート (p. 36)• ステートマシンのグラフ可視化 (p. 37)• コードスニペット (p. 38)• コードの補完と検証 (p. 39)

前提条件

• システムが「VS Code のツールキットのインストール (p. 2)」に指定されている前提条件を満たしていることを確認し、ツールキットをインストールします。

• AWS Explorer を開く前に、認証情報が設定済みであることを確認します。

VS Code でのステートマシンの使用

VS Code を使用して、リモートステートマシンとやり取りし、ローカルでステートマシンを開発できます。ステートマシンの作成や更新、既存のステートマシンの一覧表示、実行、およびダウンロードを行うことができます。VS Code を使用して、テンプレートから新しいステートマシンを作成したり、ステートマシンを可視化したり、コードスニペット、コード補完、コード検証を行ったりすることもできます。

既存のステートマシンの一覧表示

作成済みのステートマシンがある場合は、それらを一覧表示できます。

1. AWS Explorer を開きます。2. Step Functions の選択3. アカウント内のすべてのステートマシンが一覧表示されていることを確認します。

ステートマシンのダウンロード

ステートマシンをダウンロードするには

1. AWS Explorer で、ダウンロードするステートマシンを右クリックします。2. [Download] を選択し、ステートマシンのダウンロード先を選択します。3. 正常にダウンロードされたことを確認します。

33


ステートマシンの作成

新しいステートマシンは、自分で作成するか、テンプレートを使用して作成できます。テンプレートからステートマシンを作成する方法の詳細については、「ステートマシンのテンプレート」セクションを参照してください。新しいステートマシンを作成するには

1. ステートマシン定義を含む新しい Amazon ステート言語 (ASL) ファイルを作成します。右下のメニューを使用して、それを Amazon ステート言語として設定します。

2. [Publish to Step Functions] を選択します。

3. [Quick Create] を選択し、ロールを選択して、ステートマシンに名前を付けます。

34

https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html


ステートマシンの更新

ステートマシンを更新するには

1. ステートマシン定義を含む ASL ファイルを編集します。2. [Publish to Step Functions] を選択します。

3. [Quick Update] を選択し、更新するステートマシンを選択します。

ステートマシンの実行

ステートマシンを実行するには

1. AWS Explorer で、実行するステートマシンを右クリックします。2. 実行の入力を指定します。ファイルからの入力と、テキストボックスへの入力の両方を試すことができ

ます。3. 実行を開始し、正常に実行されていることを確認します。

35


ステートマシンのテンプレート

ステートマシンを作成する場合、テンプレートから作成することを選択できます。テンプレートには、よく使用されるいくつかのステートが設定されたサンプルのステートマシン定義が含まれており、ここから作成を開始できます。ステートマシンテンプレートを使用するには

1. VS Code で、Command Palette を開きます。2. [AWS: Create a new Step Functions state machine] を選択します。3. 使用するテンプレートを選択します。

36


ステートマシンのグラフ可視化

グラフ可視化を使用すると、ステートマシンの外観をグラフ形式で確認できます。グラフ可視化を作成すると、別のタブが開いて、ステートマシン JSON の可視化が表示されます。記述しているステートマシンの定義を、その可視化と並行して比較できます。ステートマシン定義を変更すると、可視化が更新されます。

Note

ステートマシン定義の可視化を作成するには、その定義をアクティブなエディタで開いておく必要があります。定義ファイルを閉じたり、名前を変更したりすると、可視化が閉じます。

ステートマシンのグラフ可視化を作成するには

1. ステートマシンを定義します。2. VS Code で、Command Palette を開きます。3. 可視化を作成するには、右上にある可視化ボタンを使用するか、[AWS Preview state machine graph] を

選択します。

37


コードスニペット

コードスニペットを使用すると、コードの短いセクションを挿入できます。コードスニペットを使用するには

1. ファイルを開き、拡張子 .asl.json を付けて保存します。2. States プロパティを使用して新しいステートマシンを作成します。3. [States] 内にカーソルを置きます。4. キーの組み合わせ Control + Space を使用して、必要なコードスニペットを選択します。5. Tab を使用して、コードスニペットの変数とパラメータをスキャンします。6. 関連するステート内にカーソルを置いて、Retry スニペットと Catch スニペットをテストします。

38


コードの補完と検証

コード補完の動作を確認するには

1. 複数のステートを作成します。2. Next、StartAt、Default のいずれかのプロパティの後にカーソルを置きます。3. キーの組み合わせ Control + Space を使用して、使用可能な補完を一覧表示します。その他のプロ

パティにアクセスするには、Control + Space を再び使用します。State の Type 別にアクセスできます。

4. 作業を進めるに従って、以下に関するコード検証が実行されます。• 不足しているプロパティ• 不正な値• 存在しない最終ステート• 存在しない参照先ステート

39

AWS Toolkit for VS Code ユーザーガイドAmazon ECS

Amazon Elastic Container Service の使用Visual Studio Code AWS Toolkit では、Amazon Elastic Container Service (Amazon ECS) がサポートされています。VS Code Toolkit は、タスク定義の作成など Amazon ECS 関連の特定の作業に役立ちます。

トピック• Amazon ECS タスク定義ファイルでの IntelliSense の使用 (p. 40)

Amazon ECS タスク定義ファイルでの IntelliSense の使用Amazon Elastic Container Service (Amazon ECS) の使用時に行うことの 1 つに、タスク定義の作成があります。この作業については、Amazon Elastic Container Service Developer Guide の「タスク定義の作成」で説明されています。Visual Studio Code AWS Toolkit をインストールすると、Amazon ECS タスク定義ファイル用に IntelliSense 機能が追加されます。

前提条件• システムが、「VS Code のツールキットをインストールする (p. 2)」で指定されている前提条件を満た

していることを確認してください。

Amazon ECS タスク定義ファイルで IntelliSense を使用する以下の例では、Amazon ECS タスク定義ファイルで IntelliSense を活用する方法を示しています。

1. Amazon ECS タスク定義の JSON ファイルを作成します。ファイルの名前には、末尾に ecs-task-def.json が必要ですが、先頭に追加の文字を含めることができます。

この例では、my-ecs-task-def.json という名前のファイルを作成します。2. VS Code エディタでファイルを開き、最初の中かっこを入力します。3. 定義に cpu を追加する場合と同様に、文字「c」を入力します。表示される IntelliSense ダイアログを

確認します。これは以下のようになっています。

40

https://docs.aws.amazon.com/AmazonECS/latest/developerguide/

https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-task-definition.html

AWS Toolkit for VS Code ユーザーガイドAWS CDK Explorer

AWS CDK Explorer の操作これはプレビューリリースの機能に関するプレリリースドキュメントです。このドキュメントは変更される可能性があります。

AWS CDK Explorer を使用すると、AWS クラウド開発キット (AWS CDK) アプリケーションまたはアプリを操作できます。AWS CDK の詳細については、「AWS クラウド開発キット (AWS CDK) DeveloperGuide」を参照してください。

AWS CDK アプリケーションは Construct として知られるビルディングブロックで構成されており、AWSCloudFormation スタックや AWS リソースの定義を含んでいます。AWS CDK Explorer を使用すると、AWS CDK Construct で定義されているスタックとリソースを視覚化できます。この視覚化は、VisualStudio Code (VS Code) エディタ内の Explorer ペインのツリービューで提供されます。「ナビゲーション (p. 16)」トピックで、AWS CDK Explorer の概要を参照してください。

このセクションでは、VS Code エディタで [AWS CDK Explorer] にアクセスして使用する方法について説明します。システムに VS Code Toolkit がすでにインストールされ、設定されていること (p. 2)を前提としています。

Note

[AWS CDK Explorer] を無効にして、VS Code エディタに表示されないようできます。[ファイル]メニューで、[環境設定]、[設定] の順に選択します。次に、[検索] ボックスに「cdk」と入力し、[Enable the AWS CDK Explorer (AWS CDK Explorer を有効にする)] ボックスをオフにします。

トピック• AWS CDK アプリケーションの使用 (p. 41)

AWS CDK アプリケーションの使用

これはプレビューリリースの機能に関するプレリリースドキュメントです。このドキュメントは変更される可能性があります。

41

https://aws.amazon.com/cdk/

https://docs.aws.amazon.com/cdk/latest/guide/

https://docs.aws.amazon.com/cdk/latest/guide/

https://docs.aws.amazon.com/cdk/latest/guide/constructs.html

https://docs.aws.amazon.com/cdk/latest/guide/stacks.html

https://docs.aws.amazon.com/cdk/latest/guide/resources.html

AWS Toolkit for VS Code ユーザーガイドAWS CDK アプリケーション

AWSVS Code Toolkitの AWS CDK Explorer を使用して、AWS CDK アプリケーションを視覚化し、操作します。

前提条件• システムが、「VS Code のツールキットをインストールする (p. 2)」で指定されている前提条件を満た

していることを確認してください。• AWS クラウド開発キット (AWS CDK) 開発者ガイドの「AWS CDK 入門ガイド」の最初のいくつかの

セクションで説明されているように、AWS CDK コマンドラインインターフェイスをインストールします。

Important

AWS CDK のバージョンは 1.17.0 以降である必要があります。コマンドラインで cdk --version を使用して、実行しているバージョンを確認します。

AWS CDK アプリケーションの視覚化AWS CDK Explorer を使用して、CDK アプリを作成したり、既存のアプリをロードしたりできます。次に、そのアプリの CDK Construct で定義されているスタックとリソースを視覚化することができます。

AWS CDK 開発者ガイドの Hello World チュートリアルの最初のいくつかのステップを実行します。「スタックのデプロイ」というステップに進んだら、停止します。チュートリアルで提供されているコマンド(mkdir や cdk init など) は、オペレーティングシステムのコマンドラインまたは VS Code エディタ内のターミナルウィンドウで実行できます。

CDK チュートリアルの最初の部分を完了したら、結果のフォルダを VS Code エディタにロードします (まだロードされていない場合)。VS Code Explorer のサイドバーの下部にある [AWS CDK Explorer] を見つけ、図のようにアプリのツリービューを開きます。

42

https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html

https://docs.aws.amazon.com/cdk/latest/guide/stacks.html

https://docs.aws.amazon.com/cdk/latest/guide/resources.html

https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#hello_world_tutorial


ツリービューには、CDK アプリの tree.json ファイル内の情報が視覚的に表示されます。この情報は、cdk synth コマンドの実行時に作成されます。ファイルは、アプリの cdk.out ディレクトリにあります。

重要な注意点

• VS Code エディタに CDK アプリをロードするときに、一度に複数のフォルダをロードすることができます。各フォルダには複数の CDK アプリを含めることができます。これは、前の図に示されています。

43


• チュートリアルの最初のいくつかのステップを実行すると、最後に実行するコマンドは cdk synth であることに気付きます。これにより、tree.json ファイルが生成されます。たとえば、リソースの追加など、CDK アプリの側面を変更する場合は、そのコマンドを再度実行して、変更がツリービューに反映されていることを確認する必要があります。

AWS CDK アプリでのその他のオペレーションの実行VS Code エディタを使用して、オペレーティングシステムのコマンドラインやその他のツールを使用する場合と同様に、CDK アプリで他のオペレーションを実行できます。たとえば、エディタでコードファイルを更新し、VS Code ターミナルウィンドウを使用してアプリをデプロイできます。

このようなアクションを試すには、VS Code エディタを使用してAWS CDK開発者ガイドの「Hello Worldチュートリアル」を続けます。AWS アカウントに予測外の費用が発生しないように、最後のステップ「アプリのリソースの破棄」を必ず実行してください。

44



AWS Toolkit for VS Code ユーザーガイドデータ保護

this AWS Product or Service のセキュリティ

Cloud security at Amazon Web Services (AWS) is the highest priority. As an AWS customer, youbenefit from a data center and network architecture that is built to meet the requirements of the mostsecurity-sensitive organizations. Security is a shared responsibility between AWS and you. The SharedResponsibility Model describes this as Security of the Cloud and Security in the Cloud.

Security of the Cloud – AWS is responsible for protecting the infrastructure that runs all of the servicesoffered in the AWS Cloud and providing you with services that you can use securely. Our securityresponsibility is the highest priority at AWS, and the effectiveness of our security is regularly tested andverified by third-party auditors as part of the AWS Compliance Programs.

Security in the Cloud – Your responsibility is determined by the AWS service you are using, and otherfactors including the sensitivity of your data, your organization’s requirements, and applicable laws andregulations.

This AWS product or service follows the shared responsibility model through the specific Amazon WebServices (AWS) services it supports. For AWS service security information, see the AWS service securitydocumentation page and AWS services that are in scope of AWS compliance efforts by complianceprogram.

トピック• this AWS Product or Service でのデータ保護 (p. 45)• Identity and Access Management for this AWS Product or Service (p. 46)• this AWS Product or Service でのログ記録とモニタリング (p. 46)• Compliance Validation for this AWS Product or Service (p. 47)• Resilience for this AWS Product or Service (p. 47)• Infrastructure Security for this AWS Product or Service (p. 48)• this AWS Product or Service での設定と脆弱性の分析 (p. 48)

this AWS Product or Service でのデータ保護This AWS product or service は、データ保護の規制やガイドラインを含む AWS 責任共有モデルに準拠しています。AWS は、AWS のすべてのサービスを実行するグローバルなインフラストラクチャを保護する責任を担います。また、AWS は、カスタマーコンテンツおよび個人データを取り扱うためのセキュリティ構成の統制など、このインフラストラクチャ上でホストされるデータ管理を維持します。データコントローラーまたはデータプロセッサとして機能する AWS のお客様と APN パートナーは、AWS クラウドに保存された個人データに対する責任を担います。

データ保護目的の場合、AWS アカウント認証情報を保護して IAM (AWS Identity and AccessManagement) で個々のユーザーアカウントをセットアップし、そのユーザーに各自の職務を果たすために必要なアクセス許可のみが付与されるようにすることをお勧めします。また、以下の方法でデータを保護することをお勧めします。

• 各アカウントで多要素認証 (MFA) を使用します。• SSL/TLS を使用して AWS リソースと通信します。

45

https://aws.amazon.com/compliance/shared-responsibility-model/


https://aws.amazon.com/compliance/programs/


https://docs.aws.amazon.com/security/?id=docs_gateway#aws-security


https://aws.amazon.com/compliance/services-in-scope/


http://aws.amazon.com/compliance/shared-responsibility-model/

AWS Toolkit for VS Code ユーザーガイドIdentity and Access Management

• AWS CloudTrail で API とユーザーアクティビティログをセットアップします。• AWS 暗号化ソリューションを、AWS サービス内のすべてのデフォルトのセキュリティ管理と一緒に使

用します。• Amazon Macie などの高度なマネージドセキュリティサービスを使用します。これにより、Amazon S3

に保存される個人データの検出と保護が支援されます。

顧客のアカウント番号などの機密の識別情報は、[名前] フィールドなどの自由形式のフィールドに配置しないことを強くお勧めします。これは、コンソール、API、AWS CLI、または AWS で this AWS productor service または他の AWS サービスを使用する場合も同様です。this AWS product or service または他のサービスに入力したデータはすべて、診断ログの内容として取得される可能性があります。外部サーバーへの URL を指定するときは、そのサーバーへのリクエストを検証するための認証情報を URL に含めないでください。

データ保護の詳細については、AWS セキュリティブログのブログ投稿「AWS の責任共有モデルとGDPR」を参照してください。

Identity and Access Management for this AWSProduct or Service

AWS Identity and Access Management (IAM) is an Amazon Web Services (AWS) service that helpsan administrator securely control access to AWS resources. IAM administrators control who can beauthenticated (signed in) and authorized (have permissions) to use resources in AWS services. IAM is anAWS service that you can use with no additional charge.

To use this AWS product or service to access AWS, you need an AWS account and AWS credentials. Toincrease the security of your AWS account, we recommend that you use an IAM user to provide accesscredentials instead of using your AWS account credentials.

For details about working with IAM, see AWS Identity and Access Management.

For an overview of IAM users and why they are important for the security of your account, see AWSSecurity Credentials in the Amazon Web Services General Reference.


this AWS Product or Service でのログ記録とモニタリング

This AWS product or service では、[OUTPUT (出力)] タブと [DEBUG CONSOLE (デバッグコンソール)] タブにステータスと結果が表示されます。このアクティビティのログを表示することもできます。

this AWS product or service のログを表示するには

1. [表示]、[Command Palette (コマンドパレット)] の順に開きます。2. 検索ボックスに「aws」と入力し、[AWS: View AWS Toolkit Logs (AWS: AWS Toolkit のログを表示)]

を選択します。

46

http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/

http://aws.amazon.com/blogs/security/the-aws-shared-responsibility-model-and-gdpr/

https://aws.amazon.com/iam/



https://docs.aws.amazon.com/general/latest/gr/






AWS Toolkit for VS Code ユーザーガイドCompliance Validation

Compliance Validation for this AWS Product orService


The security and compliance of AWS services is assessed by third-party auditors as part of multiple AWScompliance programs. These include SOC, PCI, FedRAMP, HIPAA, and others. AWS provides a frequentlyupdated list of AWS services in scope of specific compliance programs at AWS Services in Scope byCompliance Program.

Third-party audit reports are available for you to download using AWS Artifact. For more information, seeDownloading Reports in AWS Artifact.

For more information about AWS compliance programs, see AWS Compliance Programs.

Your compliance responsibility when using this AWS product or service to access an AWS service isdetermined by the sensitivity of your data, your organization’s compliance objectives, and applicable lawsand regulations. If your use of an AWS service is subject to compliance with standards such as HIPAA,PCI, or FedRAMP, AWS provides resources to help:

• Security and Compliance Quick Start Guides – Deployment guides that discuss architecturalconsiderations and provide steps for deploying security-focused and compliance-focused baselineenvironments on AWS.

• Architecting for HIPAA Security and Compliance Whitepaper – A whitepaper that describes howcompanies can use AWS to create HIPAA-compliant applications.

• AWS Compliance Resources – A collection of workbooks and guides that might apply to your industryand location.

• AWS Config – A service that assesses how well your resource configurations comply with internalpractices, industry guidelines, and regulations.

• AWS Security Hub – A comprehensive view of your security state within AWS that helps you check yourcompliance with security industry standards and best practices.

Resilience for this AWS Product or ServiceThe Amazon Web Services (AWS) global infrastructure is built around AWS Regions and AvailabilityZones.

AWS Regions provide multiple physically separated and isolated Availability Zones, which are connectedwith low-latency, high-throughput, and highly redundant networking.

With Availability Zones, you can design and operate applications and databases that automatically fail overbetween Availability Zones without interruption. Availability Zones are more highly available, fault tolerant,and scalable than traditional single or multiple data center infrastructures.

For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure.


47








https://docs.aws.amazon.com/artifact/latest/ug/downloading-documents.html

https://aws.amazon.com/compliance/programs/

https://aws.amazon.com/quickstart/?quickstart-all.sort-by=item.additionalFields.updateDate&quickstart-all.sort-order=desc&awsf.quickstart-homepage-filter=categories%23security-identity-compliance

https://d0.awsstatic.com/whitepapers/compliance/AWS_HIPAA_Compliance_Whitepaper.pdf

https://aws.amazon.com/compliance/resources/

https://aws.amazon.com/config/

https://aws.amazon.com/security-hub/

https://aws.amazon.com/about-aws/global-infrastructure/






AWS Toolkit for VS Code ユーザーガイドInfrastructure Security

Infrastructure Security for this AWS Product orService


this AWS Product or Service での設定と脆弱性の分析

This AWS product or service の新しい機能や修正が開発されると、Visual Studio Marketplace にリリースされます。これらの更新にはセキュリティ更新が含まれることがあるため、this AWS product or service を最新の状態に保つことが重要です。

拡張機能の自動更新が有効になっていることを確認するには

1. [ファイル]、[Preferences (環境設定)]、[Settings (設定)] の順に選択して、[Settings (設定)] ウィンドウを開きます。

2. [Features (機能)] を展開し、[拡張機能] を選択します。3. 環境の設定を調整します。

拡張機能の自動更新を無効にする場合は、this AWS product or service の更新が環境に適した間隔で実行されていることを必ず確認してください。

48






https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode


Visual Studio Code AWS Toolkit ユーザーガイドのドキュメント履歴

主要なドキュメントの最終更新日: 2019 年 9 月 25 日

次の表に、『Visual Studio Code AWS Toolkit』の各リリースにおける重要な変更点を示します。このドキュメントの更新に関する通知については、RSS フィードにサブスクライブできます。

update-history-change update-history-description update-history-date

AWS Step Functions のサポート (p. 49)

AWS Step Functions のサポートが追加されました。

March 31, 2020

セキュリティコンテンツ (p. 45) セキュリティコンテンツを追加しました。

February 6, 2020

Amazon EventBridge スキーマの使用 (p. 30)

Amazon EventBridge スキーマのサポートが追加されました

December 1, 2019

AWS CDK Explorer (p. 41) AWS CDK Explorer 機能のプレビューリリース。

November 25, 2019

外部認証情報プロセスの使用 (p. 8)

外部認証情報プロセスによるAWS 認証情報の取得に関する情報を追加しました。

September 25, 2019

タスク定義ファイルでのIntelliSense の使用 (p. 40)

Amazon ECS タスク定義ファイルを使用するための IntelliSenseのサポートが追加されました。

September 24, 2019

Visual Studio Code AWS Toolkit用ユーザーガイド (p. 1)

一般的な可用性のリリース July 11, 2019

Visual Studio Code AWS Toolkit用ユーザーガイド (p. 1)

わかりやすさと使いやすさのためにドキュメントの構造を更新しました。

July 3, 2019

ツールチェーンを設定する (p. 13)

さまざまなツールチェーンの設定に関する情報を追加しました。

June 12, 2019

AWS Toolkit for VS Code をインストールする (p. 2)

さまざまなツールチェーンをサポートするための言語 SDK のインストールに関する情報を追加しました。

June 12, 2019

初回リリース (p. 49) Visual Studio Code AWS Toolkitユーザーガイドの初回リリース。

March 28, 2019

49

https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/amazon-toolkit-for-vs-code-guide-doc-history.rss

Documents

AWS Toolkit for VS Code - ユーザーガイド...• Visual Studio Code AWS Toolkit を介した AWS への接続 (p. 8) • AWS リージョンを変更する (p. 10) • ツールチェーンの設定