

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

# sam local start-lambda
<a name="sam-cli-command-reference-sam-local-start-lambda"></a>

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) `sam local start-lambda`サブコマンドのリファレンス情報を提供します。
+ の概要については AWS SAM CLI、「」を参照してください。 [とは AWS SAM CLI](what-is-sam-overview.md#what-is-sam-cli)
+ `sam local start-lambda` サブコマンドの使用に関するドキュメントについては、 AWS SAM CLI「」を参照してください[sam local start-lambda を使用したテストの概要](using-sam-cli-local-start-lambda.md)。

`sam local start-lambda` サブコマンドは、 AWS Lambdaをエミュレートするローカルエンドポイントを起動します。

## 使用方法
<a name="ref-sam-cli-local-start-lambda-usage"></a>

```
$ sam local start-lambda {{<options>}}
```

## オプション
<a name="ref-sam-cli-local-start-lambda-options"></a>

`--add-host {{LIST}}`  <a name="ref-sam-cli-local-start-lambda-options-add-host"></a>
Docker コンテナのホストファイルへの IP アドレスマッピングに、ホスト名を渡します。このパラメータは、複数回渡すことができます。  

**Example**  
例: `--add-host {{example.com:127.0.0.1}}`

`--beta-features | --no-beta-features`  <a name="ref-sam-cli-local-start-lambda-options-beta-features"></a>
ベータ機能を許可または拒否します。

`--config-env {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-config-env"></a>
使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--config-file {{PATH}}`  <a name="ref-sam-cli-local-start-lambda-options-config-file"></a>
使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「[AWS SAM CLI 設定ファイル](serverless-sam-cli-config.md)」を参照してください。

`--container-env-vars`  <a name="ref-sam-cli-local-start-lambda-options-container-env-vars"></a>
オプション。ローカルでデバッグする時に、環境変数をイメージコンテナに渡します。

`--container-host {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-container-host"></a>
ローカルでエミュレートされた Lambda コンテナのホストです。デフォルト値は `localhost` です。macOS 上の Docker コンテナで AWS SAM CLI を実行する場合は、`host.docker.internal` を指定できます。コンテナを とは異なるホストで実行する場合は AWS SAM CLI、リモートホストの IP アドレスを指定できます。

`--container-host-interface {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-container-host-interface"></a>
コンテナポートがバインドする必要があるホストネットワークインターフェイスの IP アドレスです。デフォルト値は `127.0.0.1` です。`0.0.0.0` を使用して、すべてのインターフェイスにバインドします。

`--container-dns {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-container-dns"></a>
Docker コンテナのカスタム DNS サーバーを指定します。このパラメータは、複数の DNS サーバーを指定するために複数回渡すことができます。  

**Example**  
例: `--container-dns {{8.8.8.8}}`

`--debug`  <a name="ref-sam-cli-local-start-lambda-options-debug"></a>
デバッグロギングをオンにして、 AWS SAM CLI が生成するデバッグメッセージを出力表示し、タイムスタンプを表示します。

`--debug-args {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-debug-args"></a>
デバッガーに渡される追加の引数です。

`--debug-function`  <a name="ref-sam-cli-local-start-lambda-options-debug-function"></a>
オプション。`--warm-containers` が指定されているときにデバッグオプションを適用する Lambda 関数を指定します。このパラメータは、`--debug-port`、`--debugger-path`、および `--debug-args` に適用されます。

`--debug-port, -d {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-debug-port"></a>
指定すると、Lambda 関数コンテナをデバッグモードで起動し、このポートをローカルホストに公開します。

`--debugger-path {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-debugger-path"></a>
Lambda コンテナにマウントされるデバッガーへのホストパス。

`--docker-network {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-docker-network"></a>
デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続される必要がある既存の Docker ネットワークの名前または ID です。これを指定すると、Lambda コンテナはデフォルトのブリッジ Docker ネットワークにのみ接続します。

`--docker-volume-basedir, -v {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-docker-volume-basedir"></a>
 AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、Docker マシンに AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。

`--env-vars, -n {{PATH}}`  <a name="ref-sam-cli-local-start-lambda-options-env-vars"></a>
Lambda 関数の環境変数の値を含む JSON または `.env` ファイル。ファイル形式は自動的に検出されます。

`--force-image-build`  <a name="ref-sam-cli-local-start-lambda-options-force-image-build"></a>
レイヤーを使用して関数を呼び出すために使用されるイメージを CLI が再構築すべきかどうかを指定します。

`--help`  <a name="ref-sam-cli-local-start-lambda-options-help"></a>
このメッセージを表示して終了します。

`--hook-name {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-hook-name"></a>
 AWS SAM CLI 機能の拡張に使用されるフックの名前。  
許容値: `terraform`。

`--host {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-host"></a>
バインド先のローカルホスト名または IP アドレス (デフォルト:「127.0.0.1」)。

`--invoke-image {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-invoke-image"></a>
ローカル関数の呼び出しに使用するコンテナーイメージの URI。  
を使用する Lambda 関数の場合`PackageType: Zip`、これはランタイムベースイメージを上書きします。デフォルトで、 AWS SAM は Amazon ECR Public からコンテナイメージをプルします。このオプションは、別の場所からイメージをプルするために使用します。  
を使用する Lambda 関数の場合`PackageType: Image`、ビルドされたテンプレート`ImageUri`の が上書きされます。テンプレートを変更せずに別のアプリケーションイメージをローカルで呼び出すには、これを使用します。  
このオプションは複数回指定できます。このオプションの各インスタンスには、文字列またはキーバリューペアを使用できます。文字列を指定する場合は、アプリケーション内のすべての関数に使用するコンテナイメージの URI になります。例えば、`sam local start-lambda --invoke-image public.ecr.aws/sam/emu-python3.13`。キーバリューペアを指定する場合、キーはリソース名で、値はそのリソースに使用するコンテナイメージの URI です。例えば、`sam local start-lambda --invoke-image public.ecr.aws/sam/emu-python3.13 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.13`。キーバリューペアを使用すると、異なるリソースに異なるコンテナイメージを指定できます。

`--layer-cache-basedir {{DIRECTORY}}`  <a name="ref-sam-cli-local-start-lambda-options-layer-cache-basedir"></a>
テンプレートで使用されるレイヤーがダウンロードされる場所である basedir を指定します。

`--log-file, -l {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-log-file"></a>
ランタイムログを送信するログファイルです。

`--no-memory-limit`  <a name="ref-sam-cli-local-start-lambda-options-no-memory-limit"></a>
 AWS SAM テンプレートでメモリが設定されている場合でも、ローカル呼び出し中にコンテナのメモリ制限を削除します。

`--parameter-overrides`  <a name="ref-sam-cli-local-start-lambda-options-parameter-overrides"></a>
キーと値のペアとしてエンコードされた 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, -p {{INTEGER}}`  <a name="ref-sam-cli-local-start-lambda-options-port"></a>
リッスンするローカルポート番号 (デフォルト: 「3001」)。

`--profile {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-profile"></a>
認証情報を取得する AWS 認証情報ファイルからの特定のプロファイル。

`--region {{TEXT}}`  <a name="ref-sam-cli-local-start-lambda-options-region"></a>
デプロイ先の AWS リージョン。例えば、us-east-1 などです。

`--save-params`  <a name="ref-sam-cli-local-start-lambda-options-save-params"></a>
コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

`--shutdown`  <a name="ref-sam-cli-local-start-lambda-options-shutdown"></a>
シャットダウン動作の拡張機能処理をテストするために、呼び出し完了後にシャットダウンイベントをエミュレートします。

`--skip-prepare-infra`  <a name="ref-sam-cli-local-start-lambda-options-skip-prepare-infra"></a>
インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。`--hook-name` オプションと合わせて使用します。

`--skip-pull-image`  <a name="ref-sam-cli-local-start-lambda-options-skip-pull-image"></a>
Lambda ランタイムの最新 Docker イメージのプルダウンを CLI がスキップすべきかどうかを指定します。

`--template, -t {{PATH}}`  <a name="ref-sam-cli-local-start-lambda-options-template"></a>
 AWS SAM テンプレートファイル。  
このオプションを指定すると、 はテンプレートとそれが指すローカルリソースのみを AWS SAM ロードします。このオプションは `--hook-name` と互換性がありません。

`--terraform-plan-file`  <a name="ref-sam-cli-local-start-lambda-options-terraform-plan-file"></a>
Terraform Cloud で AWS SAMCLI を使用する場合のローカル Terraform プランファイルへの相対パスまたは絶対パス。このオプションは `--hook-name` を `terraform` に設定する必要があります。

`--warm-containers {{[EAGER | LAZY]}}`  <a name="ref-sam-cli-local-start-lambda-options-warm-containers"></a>
オプション。 AWS SAM CLI が各関数のコンテナを管理する方法を指定します。  
以下の 2 つのオプションを使用できます。  
+ `EAGER`: 起動時にすべての関数のコンテナがロードされ、呼び出し間で保持されます。
+ `LAZY`: 各関数が初めて呼び出される場合に限り、コンテナがロードされます。これらのコンテナは、追加の呼び出し用に保持されます。

## 例
<a name="sam-cli-command-reference-sam-local-start-lambda-examples"></a>

`sam local start-lambda` サブコマンドの使用での、詳細な例と詳しいチュートリアルについては、「[sam local start-lambda を使用したテストの概要](using-sam-cli-local-start-lambda.md)」を参照してください。