翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
sam local start-lambda
このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) sam local start-lambdaサブコマンド。
-
の概要 AWS SAM CLI、「」を参照してください。 AWS SAMCLI とは？
-
の使用に関するドキュメント AWS SAM CLI
sam local start-lambdaサブコマンド、「」を参照してくださいを使用したテストの概要 sam local start-lambda。
sam local start-lambda サブコマンドは、 AWS Lambdaをエミュレートするローカルエンドポイントを起動します。
使用方法
$sam local start-lambda<options>
オプション
--add-hostLIST-
Docker コンテナのホストファイルへの IP アドレスマッピングに、ホスト名を渡します。このパラメータは、複数回渡すことができます。
例:
--add-hostexample.com:127.0.0.1 --beta-features | --no-beta-features-
ベータ機能を許可または拒否します。
--config-envTEXT-
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。
--config-filePATH-
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。
--container-env-vars-
オプション。ローカルでデバッグする時に、環境変数をイメージコンテナに渡します。
--container-hostTEXT-
ローカルでエミュレートされた Lambda コンテナのホストです。デフォルト値は
localhostです。を実行する場合 AWS SAM CLI macOS の Docker コンテナで、 を指定できますhost.docker.internal。コンテナを とは異なるホストで実行する場合 AWS SAM CLIでは、リモートホストの IP アドレスを指定できます。 --container-host-interfaceTEXT-
コンテナポートがバインドする必要があるホストネットワークインターフェイスの IP アドレスです。デフォルト値は
127.0.0.1です。0.0.0.0を使用して、すべてのインターフェイスにバインドします。 --debug-
デバッグログ記録を有効にして、 によって生成されたデバッグメッセージを印刷します。 AWS SAM CLI タイムスタンプを表示します。
--debug-argsTEXT-
デバッガーに渡される追加の引数です。
--debug-function-
オプション。
--warm-containersが指定されているときにデバッグオプションを適用する Lambda 関数を指定します。このパラメータは、--debug-port、--debugger-path、および--debug-argsに適用されます。 --debug-port, -dTEXT-
指定すると、Lambda 関数コンテナをデバッグモードで起動し、このポートをローカルホストに公開します。
--debugger-pathTEXT-
Lambda コンテナにマウントされるデバッガーへのホストパス。
--docker-networkTEXT-
デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続される必要がある既存の Docker ネットワークの名前または ID です。これを指定すると、Lambda コンテナはデフォルトのブリッジ Docker ネットワークにのみ接続します。
--docker-volume-basedir, -vTEXT-
AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、Docker マシン上の AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。
--env-vars, -nPATH-
Lambda 関数の環境変数の値を含むJSONファイル。
--force-image-build-
が CLI は、レイヤーで関数を呼び出すために使用されるイメージを再構築します。
--help-
このメッセージを表示して終了します。
--hook-nameTEXT-
拡張に使用されるフックの名前 AWS SAM CLI 機能。
許容値:
terraform。 --hostTEXT-
バインド先のローカルホスト名または IP アドレス (デフォルト:「127.0.0.1」)。
--invoke-imageTEXT-
ローカル関数の呼び出しに使用するコンテナイメージURIの 。デフォルトでは、 は Amazon ECR Public からコンテナイメージ AWS SAM をプルします。このオプションは、別の場所からイメージをプルするために使用します。
例えば、
sam local start-lambda MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8と指定します。 --layer-cache-basedirDIRECTORY-
テンプレートで使用されるレイヤーがダウンロードされる場所である basedir を指定します。
--log-file, -lTEXT-
ランタイムログを送信するログファイルです。
--parameter-overrides-
キーと値のペアとしてエンコードされた AWS CloudFormation パラメータを含む文字列。() と同じ形式を使用します AWS Command Line Interface AWS CLI。の AWS SAM CLI 形式は明示的なキーと値のキーワードで、各オーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。
--parameter-overrides ParameterKey=hello,ParameterValue=world--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana
--port, -pINTEGER-
リッスンするローカルポート番号 (デフォルト: 「3001」)。
--profileTEXT-
認証情報ファイルから AWS 認証情報を取得する特定のプロファイル。
--regionTEXT-
デプロイ先の AWS リージョン。例えば、us-east-1 などです。
--save-params-
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。
--shutdown-
シャットダウン動作の拡張機能処理をテストするために、呼び出し完了後にシャットダウンイベントをエミュレートします。
--skip-prepare-infra-
インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。
--hook-nameオプションと合わせて使用します。 --skip-pull-image-
が CLI は、Lambda ランタイムの最新の Docker イメージのプルダウンをスキップします。
--template, -tPATH-
AWS SAM テンプレートファイル。
注記
このオプションを指定すると、 は、参照先のテンプレートとローカルリソースのみを AWS SAM ロードします。このオプションは
--hook-nameと互換性がありません。 --terraform-plan-file-
ローカルへの相対パスまたは絶対パス Terraform を使用する際の計画ファイル AWS SAM CLI with Terraform Cloud。 このオプションでは、
--hook-nameを に設定する必要がありますterraform。 --warm-containers[EAGER | LAZY]-
オプション。方法を指定します。 AWS SAM CLI は、各関数のコンテナを管理します。
以下の 2 つのオプションを使用できます。
-
EAGER: 起動時にすべての関数のコンテナがロードされ、呼び出し間で保持されます。 -
LAZY: 各関数が初めて呼び出される場合に限り、コンテナがロードされます。これらのコンテナは、追加の呼び出し用に保持されます。
-
例
sam local start-lambda サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「を使用したテストの概要 sam local start-lambda」を参照してください。
