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

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

AWS SAM CLIのインストール

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

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

AWS SAM CLI CLI を初めてインストールする場合:

次に進む前に、前のセクションの前提条件をすべて満たします。これには、以下が含まれます。

  1. AWS アカウントへのサインアップ。

  2. 管理者 IAM ユーザーを作成する。

  3. アクセスキー ID とシークレットアクセスキーを作成する。

  4. AWS CLI をインストールする。

  5. AWS 認証情報を設定する。

AWS SAM CLIのインストール

注記

2023 年 9 月以降、AWS では AWS で管理される AWS SAM CLI (aws/tap/aws-sam-cli) 用 Homebrew インストーラーのメンテナンスを行いません。Homebrew で AWS SAM CLI をインストールし、管理する場合は、以下の方法を参照してください。

  • Homebrew を引き続き使用するには、コミュニティ管理のインストーラーを使用します。詳細については、「Homebrew で AWS SAM CLI を管理する」を参照してください。

  • このページに記載されているファーストパーティ製のインストール方法のいずれかを使用することをお勧めします。これらの方法のいずれかを使用する前に、Homebrew から移行する を参照してください。

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

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

  2. (オプション) インストール前にインストーラーの整合性を確認できます。手順については、「AWS SAM CLI インストーラの整合性を確認するには」を参照してください。

  3. インストールファイルを任意のディレクトリに解凍します。sam-installation サブディレクトリを使用した例を次に示します。

    注記

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

    $ unzip aws-sam-cli-linux-arm64.zip -d sam-installation
  4. install 実行可能ファイルを実行して AWS SAM CLI をインストールします。この実行可能ファイルは、前のステップで使用したディレクトリにあります。sam-installation サブディレクトリを使用した例を次に示します。

    $ sudo ./sam-installation/install
  5. インストールを確認します。

    $ sam --version

    正常にインストールされたことを確認するには、次のような出力が表示されますが、括弧で囲まれたテキストは最新の SAM CLI バージョンに置き換えられます。

     SAM CLI, <latest version>
x86_64 - command line installer
  1. AWS SAM CLI .zip ファイルを任意のディレクトリにダウンロードします。

  2. (オプション) インストール前にインストーラーの整合性を確認できます。手順については、「AWS SAM CLI インストーラの整合性を確認するには」を参照してください。

  3. インストールファイルを任意のディレクトリに解凍します。sam-installation サブディレクトリを使用した例を次に示します。

    注記

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

    $ unzip aws-sam-cli-linux-x86_64.zip -d sam-installation
  4. install 実行可能ファイルを実行して AWS SAM CLI をインストールします。この実行可能ファイルは、前のステップで使用したディレクトリにあります。sam-installation サブディレクトリを使用した例を次に示します。

    $ sudo ./sam-installation/install
  5. インストールを確認します。

    $ sam --version

    正常にインストールされたことを確認するには、次の角括弧で囲まれたテキストを利用可能な最新バージョンに置き換える出力が表示されます。

     SAM CLI, <latest version>

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

注記

パッケージインストーラーは、x86_64 および arm64 オプションで使用できます。Mac ハードウェアに一致するパッケージを選択します。

  • x86_64 – Intel プロセッサを実行している Macs で使用します。

  • arm64 – Apple シリコンを実行している Macs で使用します。

詳細については、「Apple シリコンを搭載した Mac コンピュータ」を参照してください。

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

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

  1. GUI

  2. コマンドライン

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

インストール手順

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

GUI - All users
インストールパッケージをダウンロードするには
注記

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

パッケージインストール (オプション) を確認するには
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, <latest version>
GUI - Current user
インストールパッケージをダウンロードするには
注記

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

パッケージインストール (オプション) を確認するには
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, <latest version>
Command line - All users
インストールパッケージをダウンロードするには
注記

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

パッケージインストール (オプション) を確認するには
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, <latest version>
Command line - Current user
インストールパッケージをダウンロードするには
注記

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

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

    例えば、 を path-to-my-directoryに置き換えると/Users/myUser/Desktopaws-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, <latest version>

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

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

  1. AWS SAM CLI 64 ビットをダウンロードします。

    注記

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

  2. (オプション) インストール前にインストーラーの整合性を確認できます。手順については、「AWS SAM CLI インストーラの整合性を確認するには」を参照してください。

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

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

    sam --version

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

    SAM CLI, <latest version>
  4. ロングパスを有効にします (Windows 10 以降のみ)。

    重要

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

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

  5. Git をインストールする。

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

トラブルシューティング

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

次のステップ

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