sam local invoke

このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAMCLI) sam local invokeサブコマンドのリファレンス情報を提供します。

• の概要についてはCLI、 AWS SAM「」を参照してくださいとは何ですか? AWS SAMCLI。

• sam local invoke サブコマンドの使用に関するドキュメントについては、 AWS SAMCLI「」を参照してくださいsam local invoke を使用する。

sam local invoke サブコマンドは、 AWS Lambda 関数の 1 回限りの呼び出しをローカルで開始します。

使用方法

$ sam local invoke <arguments> <options>

注記

AWS SAM テンプレートに複数の関数が定義されている場合は、呼び出す関数の論理 ID を指定します。

引数

リソース ID

呼び出す Lambda 関数の ID。

この引数はオプションです。アプリケーションに単一の Lambda 関数が含まれている場合、 AWS SAM CLI はその関数を呼び出します。アプリケーションに複数の関数が含まれている場合は、呼び出す関数の ID を指定します。

有効な値: リソースの論理 ID またはリソース ARN。

オプション

--add-host LIST

Docker コンテナのホストファイルにホスト名を IP アドレスマッピングに渡します。このパラメータは複数回渡すことができます。

例: --add-host example.com:127.0.0.1

--beta-features | --no-beta-features

ベータ機能を許可または拒否します。

--config-env TEXT

使用する設定ファイル内のデフォルトパラメータ値を指定する環境名です。デフォルト値は「default」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--config-file PATH

使用するデフォルトのパラメータ値が含まれる設定ファイルのパスとファイル名です。デフォルト値は、プロジェクトディレクトリのルートにある「samconfig.toml」です。設定ファイルの詳細については、「AWS SAM CLI 設定ファイル」を参照してください。

--container-env-vars

(オプション) ローカルでデバッグするときに、環境変数を Lambda 関数イメージコンテナに渡します。

--container-host TEXT

ローカルでエミュレートされた Lambda コンテナのホストです。デフォルト値は、localhostです。macOS 上の Docker コンテナで AWS SAM CLI を実行する場合は、host.docker.internal を指定できます。コンテナを とは異なるホストで実行する場合は AWS SAMCLI、リモートホストの IP アドレスを指定できます。

--container-host-interface TEXT

コンテナポートがバインドする必要があるホストネットワークインターフェイスの IP アドレスです。デフォルト値は、127.0.0.1です。0.0.0.0 を使用して、すべてのインターフェイスにバインドします。

--debug

デバッグロギングをオンにして、 AWS SAM CLI が生成するメッセージを出力表示し、タイムスタンプを表示します。

--debug-args TEXT

デバッガーに渡す追加の引数です。

--debug-port, -d TEXT

これを指定すると、Lambda 関数コンテナがデバッグモードで起動され、このポートがローカルホストに公開されます。

--debugger-path TEXT

Lambda コンテナにマウントされたデバッガーへのホストパスです。

--docker-network TEXT

デフォルトのブリッジネットワークと共に、Lambda Docker コンテナが接続される必要がある既存の Docker ネットワークの名前または ID です。これを指定しない場合、Lambda コンテナはデフォルトのブリッジ Docker ネットワークだけに接続します。

--docker-volume-basedir, -v TEXT

AWS SAM ファイルが存在するベースディレクトリの場所。Docker がリモートマシンで実行されている場合は、 AWS SAM ファイルが Docker マシンに存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。

--env-vars, -n PATH

Lambda 関数の環境変数の値が含まれる JSON ファイルです。環境変数ファイルの詳細については、「環境変数ファイル」を参照してください。

--event, -e PATH

呼び出されたときに Lambda 関数に渡されるイベントデータが含まれる JSON ファイルです。このオプションを指定しない場合、イベントは想定されません。stdin からの JSON を入力するには、値「-」を渡す必要があります。さまざまな AWS のサービスからのイベントメッセージ形式の詳細については、「 AWS Lambda デベロッパーガイド」の「他の サービスの使用」を参照してください。

--force-image-build

レイヤーがある Lambda 関数を呼び出すために使用されるイメージを AWS SAM CLI が再構築すべきかどうかを指定します。

--help

このメッセージを表示して終了します。

--hook-name TEXT

AWS SAM CLI 機能の拡張に使用されるフックの名前。

許容値: terraform。

--invoke-image TEXT

ローカル関数の呼び出しに使用するコンテナーイメージの URI。デフォルトで、 AWS SAM は Amazon ECR Public からコンテナイメージをプルします。このオプションは、別の場所からイメージをプルするために使用します。

例えば sam local invoke MyFunction --invoke-image amazon/aws-sam-cli-emulation-image-python3.8 です。

--layer-cache-basedir DIRECTORY

テンプレートで使用するレイヤーがダウンロードされるベースディレクトリの場所を指定します。

--log-file, -l TEXT

ランタイムログを送信するログファイルです。

--no-event

空のイベントを使用して関数を呼び出します。

--parameter-overrides

（オプション) キーと値のペアとしてエンコードされた AWS CloudFormation パラメータオーバーライドを含む文字列。 AWS Command Line Interface () と同じ形式を使用しますAWS CLI。例えば、「ParameterKey=KeyPairName, ParameterValue=MyKey ParameterKey=InstanceType, ParameterValue=t1.micro」などです。

このオプションは --hook-name と互換性がありません。

--profile TEXT

認証情報ファイルから AWS 認証情報を取得する特定のプロファイル。

--region TEXT

デプロイ先の AWS リージョン。例えば、us-east-1 などです。

--save-params

コマンドラインで指定したパラメータを設定 AWS SAM ファイルに保存します。

--shutdown

シャットダウン動作の拡張機能処理をテストするために、呼び出し完了後にシャットダウンイベントをエミュレートします。

--skip-prepare-infra

インフラストラクチャに変更が加えられていない場合は、準備段階をスキップします。--hook-name オプションと合わせて使用します。

--skip-pull-image

デフォルトでは、 AWS SAM CLI は Lambda の最新のリモートランタイム環境を確認し、ローカルイメージを自動的に更新して同期を維持します。

このオプションを指定して、Lambda ランタイム環境の最新の Docker イメージのプルダウンをスキップします。

--template, -t PATH

AWS SAM テンプレートファイル。

このオプションは --hook-name と互換性がありません。

注記

このオプションを指定すると、 はテンプレートとそれがポイントするローカルリソースのみを AWS SAM ロードします。

--terraform-plan-file

Terraform Cloud で AWS SAMCLI を使用する場合のローカル Terraform プランファイルへの相対パスまたは絶対パス。このオプションは --hook-name を terraform に設定する必要があります。