Windows への AWS SAM CLI のインストール - AWS Serverless Application Model

Windows への AWS SAM CLI のインストール

Windows ホストで AWS SAM コマンドラインインターフェイス (CLI) を使用するための前提条件をインストールして設定するには、これらの手順を実行してください。

  1. AWS Identity and Access Management (AWS) アカウントを作成します。

  2. IAM 許可と AWS 認証情報を設定します。

  3. Docker をインストールします。注意: Docker が前提条件となるのは、アプリケーションをローカルでテストする、または --use-container オプションを使用する場合のみです。

  4. AWS SAM CLI をインストールします。

ステップ 1: AWS アカウントを作成する

AWS アカウントをまだお持ちでない場合は、aws.amazon.com にアクセスし、[Create an AWS Account] (AWS アカウントを作成する) を選択してください。詳細な手順については、「AWS アカウントの作成とアクティブ化」を参照してください。

ステップ 2: IAM 許可と AWS 認証情報を設定する

AWS SAM で使用する IAM ユーザーは、必要な AWS のサービスを呼び出し、AWS リソースを管理するために十分な許可を持っている必要があります。ユーザーが十分な許可を持っていることを確実にするための最も簡単な方法は、ユーザーに管理者権限を付与することです。詳細については、IAM ユーザーガイドの「最初の IAM 管理者のユーザーおよびグループの作成」を参照してください。

注記

AWS Command Line Interface (AWS CLI) を使用するユーザーに管理者権限を付与しない場合は、制限された一連の許可をユーザーに付与できます。詳細については、「許可」を参照してください。

さらに、AWS SAM CLI が AWS のサービスを呼び出せるようにするには、AWS 認証情報をセットアップする必要もあります。詳細については、「AWS 認証情報のセットアップ」を参照してください。

ステップ 3: Docker をインストールする (オプション)

注記

Docker が前提条件となるのは、アプリケーションをローカルでテストする場合と--use-container オプションを使用してデプロイパッケージを構築する場合のみです。当初はこれらの機能を使用しない予定の場合は、このセクションをスキップするか、後ほど Docker をインストールすることができます。

注記

Docker Desktop がサポートされてますが、SAM CLI バージョン 1.47.0 以降では、Docker ランタイムを使用する Docker Desktop の代替手段を使用できます。

Docker は、Linux マシン上でコンテナを実行するアプリケーションです。AWS SAM は、Docker コンテナとして使用する AWS Lambda と同様のローカル環境を提供します。このコンテナを使用して、サーバーレスアプリケーションを構築、テスト、およびデバッグできます。

AWS SAM CLI を使用してサーバーレスプロジェクトと関数をローカルで実行するには、Docker がインストール済みで機能している必要があります。AWS SAM CLI は、DOCKER_HOST 環境変数を使用して Docker デーモンにアクセスします。以下の手順は、AWS SAM CLI と連動するように Docker をインストール、設定、および検証する方法について説明します。

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

    Docker Desktop は、最新の Windows オペレーティングシステムをサポートしています。Windows の旧バージョンでは、Docker Toolbox を使用できます。正しい Docker のインストール手順については、Windows のバージョンを選択してください。

  2. 共有ドライブを設定します。

    AWS SAM CLI では、プロジェクトディレクトリまたは親ディレクトリが共有ドライブにリストされている必要があります。Docker を正しく機能させるには、ドライブを共有する必要が生じる場合があります。

    • Windows 10 を Hyper-V モードで使用している場合は、「Docker File Sharing」を参照してください。

    • 古いバージョンの Windows でドライブを共有するには、「Add Shared Directories」を参照してください。

  3. インストールを確認します。

    Docker がインストールされたら、動作していることを確認します。また、コマンドラインから Docker コマンドを実行できることを確認します (docker ps など)。コンテナをインストール、フェッチ、またはプルする必要はありません。これらは、AWS SAM CLI が必要に応じて自動的に行います。

Docker のインストールで問題が発生した場合は、Docker installation guide の「Logs and troubleshooting」を参照してください。

ステップ 4: AWS SAM CLI をインストールする

Windows インストーラ (MSI) ファイルは、Windows オペレーティングシステムのパッケージインストーラファイルです。

これらの手順に従って、MSI ファイルを使用して AWS SAM CLI をインストールします。

  1. AWS SAM CLI 64-bit をインストールします。

    注記

    32 ビットシステムで動作させる場合は、「32 ビット Windows への AWS SAM CLI のインストール」を参照してください。

  2. インストールを確認します。

    インストールが完了したら、新しいコマンドプロンプトまたは PowerShell プロンプトを開いて確認します。コマンドラインから sam を呼び出すことができるはずです。

    sam --version

    AWS SAM CLI が正常にインストールされると、以下のような出力が表示されます。

     
     SAM CLI, version 1.35.0
                    
  3. Git をインストールします。

    sam init コマンドを使用してサンプルアプリケーションをダウンロードするには、Git をインストールする必要があります。手順については、「Git のインストール」を参照してください。

これで開発を開始する準備が整いました。

アンインストール

Windows の設定を使用して AWS SAM CLI をアンインストールするには、これらの手順を実行してください。

  1. [スタート] メニューから、[プログラムの追加と削除] を検索します。

  2. AWS SAM コマンドラインインターフェイスという名前のエントリを選択し、[アンインストール] をクリックしてアンインストーラを起動します。

  3. AWS SAM CLI をアンインストールすることを確認します。

夜間ビルド

AWS SAM CLI の夜間ビルドをインストールできます。インストールされると、sam-nightly コマンドを使用した夜間ビルドを使用できるようになります。AWS SAM CLI の実稼働ビルドと夜間ビルドは、両バージョンを同時にインストールして使用することが可能です。

夜間ビルドには、実稼働バージョンよりも安定性が低い可能性があるプレリリースバージョンの AWS SAM CLI コードが含まれています。夜間ビルドにはビルドイメージのプレリリースバージョンが含まれていないことに注意してください。このため、--use-container オプションでのサーバーレスアプリケーションの構築には、ビルドイメージの最新実稼働バージョンが使用されます。

夜間ビルドは、こちらのダウンロードリンクから利用できます: AWS SAMCLI 夜間ビルド。AWS SAM CLI の夜間ビルドバージョンをインストールするには、このトピックの初めにある「ステップ 4: AWS SAM CLI をインストールする」と同じ手順を実行しますが、代わりに夜間ビルドのダウンロードリンクを使用します。

夜間ビルドバージョンがインストールされていることを確認するには、sam-nightly --version コマンドを実行します。このコマンドの出力は 1.X.Y.dev<YYYYMMDDHHmm> 形式になります。以下はその例です。

SAM CLI, version 1.20.0.dev202103151200

次のステップ

これで、AWS SAM を使用して独自のサーバーレスアプリケーションの構築を開始する準備が整いました。サンプルサーバーレスアプリケーションから開始する場合は、次のいずれかのリンクを選択します。