AWS SAM CLI のインストール

サポートされているオペレーティングシステムに AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) の最新リリースをインストールします。

アップグレード、アンインストール、夜間ビルドの管理方法など、現在インストールされている AWS SAM CLI のバージョンを管理する方法については、「AWS SAM CLI バージョンの管理」を参照してください。

重要

先に進む前に、前のセクションのすべての前提条件を満たしてください。

AWS SAM CLI のインストール

AWS SAM CLI をインストールするには、お使いのオペレーティングシステムの手順に従ってください。

Linux

x86_64 - command line installer

1. AWS SAM CLI .zip ファイルを任意のディレクトリにダウンロードします。

2. 以下のコマンドを使用してハッシュ値を生成することによって、ダウンロードしたインストーラファイルの整合性と信頼性を検証します。

   $ sha256sum aws-sam-cli-linux-x86_64.zip

   出力は以下のようになる必要があります。

    <64-character SHA256 hash value> aws-sam-cli-linux-x86_64.zip

   64-character SHA-256 hash value を、GitHub の「AWS SAM CLI release notes」(AWS SAM CLI リリースノート) にある目的の AWS SAM CLI バージョンの値と比較します。

3. インストールファイルを sam-installation/ サブディレクトリに解凍します。

   注記

   オペレーティングシステムに組み込み unzip コマンドがない場合は、同等のコマンドを使用します。

   $ unzip aws-sam-cli-linux-x86_64.zip -d sam-installation

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

   $ sudo ./sam-installation/install

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

   $ sam --version

   インストールが正常に行われていれば、以下のような出力が表示されます。

    SAM CLI, version 1.58.0

ARM - command line installer

1. pip を使用して AWS SAM CLI をインストールします。

   $ pip install aws-sam-cli

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

   $ sam --version

   インストールが正常に行われていれば、以下のような出力が表示されます。

    SAM CLI, version 1.58.0

Homebrew

重要

Linux マシンに Homebrew がインストールされている必要があります。instructions のインストールについては、「AWS SAM CLI で Homebrew を使用するためのインストール方法」を参照してください。

Homebrew を使用して AWS SAM CLI をインストールするには、以下のコマンドを実行します。

$ brew tap aws/tap
$ brew install aws-sam-cli

注記

AWS SAM CLI v1.70.1 以降、homebrew-core ライブラリの変更により、aws/tap を実行する必要がなくなりました。AWS SAM CLI v1.70.1 以降をインストールするには、代わりに brew install aws/tap/aws-sam-cli を実行することをお勧めします。

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

$ sam --version

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

SAM CLI, version 1.58.0

macOS

パッケージインストーラまたは Homebrew を使用して AWS SAM CLI をインストールします。

パッケージインストーラを使用する

パッケージインストーラでは、次の 2 つのインストール方法から選択できます。

1. GUI

2. コマンドライン

すべてのユーザーにインストールすることも、現在のユーザーのみにインストールすることもできます。すべてのユーザーにインストールするには、スーパーユーザー承認が必要です。

インストール手順

次のいずれかのオプションを使用して、AWS SAM CLI をインストールします。

GUI - All users

インストールパッケージのダウンロード

注記

以前に Homebrew または pip を使用して AWS SAM CLI をインストールした場合は、まずその CLI をアンインストールする必要があります。手順については、「AWS SAM CLI のアンインストール」を参照してください。

1. インストールを開始するには、macOS pkg を任意のディレクトリにダウンロードします。

   • x86_64 — aws-sam-cli-macos-x86_64.pkg

   • arm64 — aws-sam-cli-macos-arm64.pkg

2. 以下のコマンドを使用してハッシュ値を生成することによって、ダウンロードしたインストーラの整合性と信頼性を検証します。

   $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer
   
   # Examples
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

   64-character SHA-256 のハッシュ値を、「AWS SAM CLI release notes」(AWS SAM CLI リリースノート) の GitHub リポジトリ内の対応する値と比較します。

AWS SAM CLI のインストール

1. ダウンロードしたファイルを実行し、画面の指示に従って、「はじめに」、「Read me」、「ライセンス」の手順を続けてください。

2. [Destination Select] (インストール先の選択) で、[Install for all users of this computer] (このコンピュータのすべてのユーザーにインストール) を選択します。

3. [Installation Type] (インストールタイプ) で、AWS SAM CLI をインストールする場所を選択し、[Install] (インストール) を押します。推奨されるデフォルトの場所は /usr/local/aws-sam-cli です。

   注記

   sam コマンドで AWS SAM CLI を呼び出すために、インストーラは /usr/local/bin/sam と /usr/local/aws-sam-cli/sam または選択したインストールフォルダのいずれかとの間のシンボリックリンクを自動的に作成します。

4. AWS SAM CLI がインストールされ、「The installation was successful」(インストールは成功しました) というメッセージが表示されます。[Close] (閉じる) を押します。

インストールの検証

• AWS SAM CLI が正しくインストールされ、シンボリックリンクが設定されていることを確認するには、次のコマンドを実行します。

  $ which sam
  /usr/local/bin/sam
  $ sam --version
  SAM CLI, version 1.66.0

GUI - Current user

インストールパッケージのダウンロード

注記

以前に Homebrew または pip を使用して AWS SAM CLI をインストールした場合は、まずその CLI をアンインストールする必要があります。手順については、「AWS SAM CLI のアンインストール」を参照してください。

1. インストールを開始するには、macOS pkg を任意のディレクトリにダウンロードします。

   • x86_64 — aws-sam-cli-macos-x86_64.pkg

   • arm64 — aws-sam-cli-macos-arm64.pkg

2. 以下のコマンドを使用してハッシュ値を生成することによって、ダウンロードしたインストーラの整合性と信頼性を検証します。

   $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer
   
   # Examples
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

   64-character SHA-256 のハッシュ値を、「AWS SAM CLI release notes」(AWS SAM CLI リリースノート) の GitHub リポジトリ内の対応する値と比較します。

AWS SAM CLI のインストール

1. ダウンロードしたファイルを実行し、画面の指示に従って、「はじめに」、「Read me」、「ライセンス」の手順を続けてください。

2. [Destination Select] (インストール先の選択) で、[Install for me only] (現在のユーザーのみにインストール) を選択します。このオプションが表示されない場合は、次の手順に進みます。

3. [Installation Type] (インストールタイプ) で、以下を実行します。

   1. AWS SAM CLI をインストールする場所を選択します。デフォルトの場所は /usr/local/aws-sam-cli です。書き込み権限が付与されている場所を選択してください。インストール場所を変更するには、[local] (ローカル) を選択し、場所を選択します。完了したら、[Continue] (続行) を押します。

   2. 前のステップで [Install for me only] (現在のユーザーのみにインストール) を選択するオプションが表示されない場合は、[Change Install Location] (インストール場所を変更) > [Install for me only] (現在のユーザーのみにインストール) を選択し、[Continue] (続行) を押します。

   3. [Install] (インストール) を押します。

4. AWS SAM CLI がインストールされ、「The installation was successful」(インストールは成功しました) というメッセージが表示されます。[Close] (閉じる) を押します。

シンボリックリンクの作成

• sam コマンドで AWS SAM CLI を呼び出すには、AWS SAM CLI プログラムと $PATH との間のシンボリックリンクを手動で作成する必要があります。次のコマンドを変更および実行して、シンボリックリンクを作成します。

  $ sudo ln -s /path-to/aws-sam-cli/sam /path-to-symlink-directory/sam

  • sudo — ユーザーが $PATH への書き込み権限を持っている場合、sudo は必須ではありません。それ以外の場合、sudo が必要です。

  • path-to — AWS SAM CLI プログラムをインストールした場所へのパス。例えば、/Users/myUser/Desktop です。

  • path-to-symlink-directory — $PATH の環境変数。デフォルトの場所は /usr/local/bin です。

インストールの検証

• AWS SAM CLI が正しくインストールされ、シンボリックリンクが設定されていることを確認するには、次のコマンドを実行します。

  $ which sam
  /usr/local/bin/sam
  $ sam --version
  SAM CLI, version 1.66.0

Command line - All users

インストールパッケージのダウンロード

注記

以前に Homebrew または pip を使用して AWS SAM CLI をインストールした場合は、まずその CLI をアンインストールする必要があります。手順については、「AWS SAM CLI のアンインストール」を参照してください。

1. インストールを開始するには、macOS pkg を任意のディレクトリにダウンロードします。

   • x86_64 — aws-sam-cli-macos-x86_64.pkg

   • arm64 — aws-sam-cli-macos-arm64.pkg

2. 以下のコマンドを使用してハッシュ値を生成することによって、ダウンロードしたインストーラの整合性と信頼性を検証します。

   $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer
   
   # Examples
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

   64-character SHA-256 のハッシュ値を、「AWS SAM CLI release notes」(AWS SAM CLI リリースノート) の GitHub リポジトリ内の対応する値と比較します。

AWS SAM CLI のインストール

• インストールスクリプトを変更および実行します。

  $ sudo installer -pkg path-to-pkg-installer/name-of-pkg-installer -target /
  installer: Package name is AWS SAM CLI
  installer: Upgrading at base path /
  installer: The upgrade was successful.

  注記

  sam コマンドで AWS SAM CLI を呼び出すため、インストーラは、/usr/local/bin/sam と /usr/local/aws-sam-cli/sam の間のシンボリックリンクを自動的に作成します。

インストールの検証

• AWS SAM CLI が正しくインストールされ、シンボリックリンクが設定されていることを確認するには、次のコマンドを実行します。

  $ which sam
  /usr/local/bin/sam
  $ sam --version
  SAM CLI, version 1.66.0

Command line - Current user

インストールパッケージのダウンロード

注記

以前に Homebrew または pip を使用して AWS SAM CLI をインストールした場合は、まずその CLI をアンインストールする必要があります。手順については、「AWS SAM CLI のアンインストール」を参照してください。

1. インストールを開始するには、macOS pkg を任意のディレクトリにダウンロードします。

   • x86_64 — aws-sam-cli-macos-x86_64.pkg

   • arm64 — aws-sam-cli-macos-arm64.pkg

2. 以下のコマンドを使用してハッシュ値を生成することによって、ダウンロードしたインストーラの整合性と信頼性を検証します。

   $ shasum -a 256 path-to-pkg-installer/name-of-pkg-installer
   
   # Examples
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-arm64.pkg
   $ shasum -a 256 /Users/myUser/Downloads/aws-sam-cli-macos-x86_64.pkg

   64-character SHA-256 のハッシュ値を、「AWS SAM CLI release notes」(AWS SAM CLI リリースノート) の GitHub リポジトリ内の対応する値と比較します。

AWS SAM CLI のインストール

1. 書き込み権限のあるインストールディレクトリを決定します。次に、テンプレートを使用して xml ファイルを作成し、インストールディレクトリを反映するようにファイルを変更します。ディレクトリは既に存在している必要があります。

   例えば、path-to-my-directory を /Users/myUser/Desktop に置き換えると、aws-sam-cli プログラムフォルダがそこにインストールされます。

   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
   <plist version="1.0">
     <array>
       <dict>
         <key>choiceAttribute</key>
         <string>customLocation</string>
         <key>attributeSetting</key>
         <string>path-to-my-directory</string>
         <key>choiceIdentifier</key>
         <string>default</string>
       </dict>
     </array>
   </plist>

2. xml ファイルを保存し、以下を実行して有効であることを確認します。

   $ installer -pkg path-to-pkg-installer \
   -target CurrentUserHomeDirectory \
   -showChoicesAfterApplyingChangesXML path-to-your-xml-file

   出力には、AWS SAM CLI プログラムに適用される設定が表示されるはずです。

3. 次のコマンドを実行して AWS SAM CLI をインストールします。

   $ installer -pkg path-to-pkg-installer \
   -target CurrentUserHomeDirectory \
   -applyChoiceChangesXML path-to-your-xml-file
   
   # Example output
   installer: Package name is AWS SAM CLI
   installer: choices changes file 'path-to-your-xml-file' applied
   installer: Upgrading at base path base-path-of-xml-file
   installer: The upgrade was successful.

シンボリックリンクの作成

• sam コマンドで AWS SAM CLI を呼び出すには、AWS SAM CLI プログラムと $PATH との間のシンボリックリンクを手動で作成する必要があります。次のコマンドを変更および実行して、シンボリックリンクを作成します。

  $ sudo ln -s /path-to/aws-sam-cli/sam /path-to-symlink-directory/sam

  • sudo — ユーザーが $PATH への書き込み権限を持っている場合、sudo は必須ではありません。それ以外の場合、sudo が必要です。

  • path-to — AWS SAM CLI プログラムをインストールした場所へのパス。例えば、/Users/myUser/Desktop です。

  • path-to-symlink-directory — $PATH の環境変数。デフォルトの場所は /usr/local/bin です。

インストールの検証

• AWS SAM CLI が正しくインストールされ、シンボリックリンクが設定されていることを確認するには、次のコマンドを実行します。

  $ which sam
  /usr/local/bin/sam
  $ sam --version
  SAM CLI, version 1.66.0

Homebrew

重要

マシンに Homebrew がインストールされている必要があります。インストール手順については、「AWS SAM CLI で Homebrew を使用するためのインストール方法」を参照してください。

これらの手順に従って、Homebrew を使用した AWS SAM CLI のインストールを実行します。

$ brew tap aws/tap
$ brew install aws-sam-cli

注記

AWS SAM CLI v1.70.1 以降、homebrew-core ライブラリの変更により、aws/tap を実行する必要がなくなりました。AWS SAM CLI v1.70.1 以降をインストールするには、代わりに brew install aws/tap/aws-sam-cli を実行することをお勧めします。

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

$ sam --version

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

SAM CLI, version 1.58.0

Windows

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

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

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

   注記

   32 ビットバージョンの Windows を使用している場合は、「32 ビット Windows への AWS SAM CLI のインストール」を参照してください。

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

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

   sam --version

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

   SAM CLI, version 1.58.0

3. ロングパスを有効にします (Windows 10 以降のみ)。

   重要

   AWS SAM CLI アプリテンプレートリポジトリには、Windows 10 での MAX_PATH の制限により、sam init の実行時にエラーを引き起こす可能性のある長いファイルパスがいくつか含まれています。この問題を解決するには、新しい長いパスの動作を設定する必要があります。

   長いパスを有効にするには、「Windows アプリの開発に関するドキュメント」の「Windows 10、バージョン 1607 以降で長いパスを有効にする」を参照してください。

4. Git をインストールします。

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

トラブルシューティング

AWS SAM CLI のインストール中に問題が発生した場合は、「インストールエラーのトラブルシューティング」を参照してください。

次のステップ

AWS SAM CLI と、独自のサーバーレスアプリケーションの構築に関する詳細については、以下を参照してください。

• チュートリアル: Hello World アプリケーションのデプロイ - 基本的なサーバーレスアプリケーションをダウンロード、構築、およびデプロイするためのステップバイステップの手順です。

• AWS SAM コンプリートワークショップ — AWS SAM の主な機能を学ぶためのワークショップ。

• AWS SAM アプリケーションとパターンの例 – さらに実験できるコミュニティ作成者からのサンプルアプリケーションとパターン。