sam local start-api - AWS Serverless Application Model

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

sam local start-api

サーバーレスアプリケーションをローカルで実行して、開発とテストを迅速に行えます。サーバーレス関数と AWS SAM テンプレートを含むディレクトリでこのコマンドを実行すると、すべての関数をホストするローカル HTTP サーバーが作成されます。

(ブラウザ、CLI などを介して) アクセスされると、Docker コンテナをローカルで起動して関数を呼び出します。CodeUri リソースの AWS::Serverless::Function プロパティを読み取り、 Lambda 関数コードを含むファイルシステムのパスを見つけます。これは、Node.js や Python などの解釈された言語用のプロジェクトのルートディレクトリ、またはコンパイルされたアーティファクトや Java アーカイブ (JAR) ファイルを格納するビルドディレクトリです。

解釈された言語を使用している場合は、すべての呼び出しでローカルの変更を Docker コンテナですぐに使用できます。さらにコンパイルされた言語や複雑なパッキングサポートを必要とするプロジェクトについては、独自のビルドソリューションを実行し、AWS SAM をポイントして、ビルドアーティファクトを含むディレクトリまたはファイルを指定することをお勧めします。

このコマンドを使用するエンドツーエンドの例については、「」チュートリアル: Hello World アプリケーションのデプロイを参照してください。sam local start-api コマンドは の一部ですステップ 4: (オプション) アプリケーションをローカルでテストする

使用:

sam local start-api [OPTIONS]

オプション:

オプション 説明
--host TEXT バインド先のローカルホスト名または IP アドレス (デフォルト:「127.0.0.1」)。
-p, --port INTEGER リッスンするローカルポート番号 (デフォルト:「3000」)。
-s, --static-dir TEXT このディレクトリにある静的アセット (CSS/JavaScript/HTML など) ファイルは、/ に表示されます。
-t, --template PATH AWS SAM テンプレートファイル [デフォルト: template.[yaml|yml]]。
-n, --env-vars PATH Lambda 関数の環境変数の値を含む JSON ファイル。
--parameter-overrides 省略可能。キーと値のペアとしてエンコードされた AWS CloudFormation パラメータオーバーライドを含む文字列。と同じ形式を使用します ParameterKey=KeyPairName, AWS CLI MyKey — InstanceType,ParameterValue=t1ParameterValueParameterKeyなど)。
-d, --debug-port TEXT 指定すると、Lambda 関数コンテナをデバッグモードで起動し、このポートをローカルホストに公開します。
--debugger-path TEXT Lambda コンテナにマウントされるデバッガーへのホストパス。
--debug-args TEXT デバッガーに渡される追加の引数。
--warm-containers [EAGER | LAZY]

省略可能。AWS SAM CLI が各関数のコンテナを管理する方法を指定します。

次の 2 つのオプションを使用できます。

   EAGER: すべての関数のコンテナは起動時にロードされ、呼び出し間で保持されます。

   LAZY: 各関数が最初に呼び出されたときにのみ、コンテナがロードされます。これらのコンテナは、追加の呼び出しのために保持されます。

--debug-function

省略可能。Lambda が指定されている場合にデバッグオプションを適用する --warm-containers 関数を指定します。このパラメータは--debug-port、、--debugger-path、および に適用されます--debug-args

-v, --docker-volume-basedir TEXT AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、Docker マシン上に AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンと一致するように変更する必要があります。
--docker-network TEXT Lambda Docker コンテナが接続する必要のある既存の Docker ネットワークの名前または ID、およびデフォルトのブリッジネットワークです。これを指定しない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークにのみ接続します。
--container-env-vars 省略可能。ローカルデバッグ時に環境変数をイメージコンテナに渡します。
-l, --log-file TEXT ランタイムログを送信するログファイル。
--layer-cache-basedir DIRECTORY テンプレートが使用するレイヤーがダウンロードされる場所 basedir を指定します。
--skip-pull-image CLI が Lambda ランタイムの最新の Docker イメージのプルダウンをスキップするかどうかを指定します。
--force-image-build CLI がレイヤーを使用して関数を呼び出すために使用されるイメージを再構築するかどうかを指定します。
--profile TEXT 認証情報を取得するAWS認証情報ファイルからの特定のプロファイル。
--region TEXT デプロイ先の AWS リージョン。たとえば、us-east-1 です。
--config-file PATH 使用するデフォルトのパラメータ値を含む設定ファイルのパスとファイル名。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルについて詳しくは、 を参照してください。AWS SAM CLI 設定ファイル.
--config-env TEXT 設定ファイルで使用するデフォルトのパラメータ値を指定する環境名。デフォルト値は「default」です。設定ファイルについて詳しくは、 を参照してください。AWS SAM CLI 設定ファイル.
--debug デバッグログを有効にしてAWS SAM、CLI によって生成されたデバッグメッセージを出力し、タイムスタンプを表示します。
--help このメッセージを表示して終了します。