翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
sam local invoke
このページでは、 AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) sam local invoke
サブコマンド。
-
の概要 AWS SAM CLI、「」を参照してください。 AWS SAMCLI とは?
-
の使用に関するドキュメントについては、 AWS SAM CLI
sam local invoke
サブコマンド、「」を参照してください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
です。を実行する場合 AWS SAM CLI macOS の Docker コンテナで、 を指定できますhost.docker.internal
。コンテナを とは異なるホストで実行する場合 AWS SAM CLIでは、リモートホストの 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 がリモートマシンで実行されている場合は、Docker マシンに AWS SAM ファイルが存在するパスをマウントし、この値をリモートマシンに合わせて変更する必要があります。
--env-vars, -n
PATH
-
Lambda 関数の環境変数の値を含むJSONファイル。環境変数ファイルの詳細については、「環境変数ファイル」を参照してください。
--event, -e
PATH
-
呼び出されたときに Lambda 関数に渡されるイベントデータを含むJSONファイル。このオプションを指定しない場合、イベントは想定されません。JSON から入力するには
stdin
、値 '-' を渡す必要があります。さまざまな AWS サービスのイベントメッセージ形式の詳細については、AWS Lambda 「 デベロッパーガイド」の「他の のサービスの使用」を参照してください。 --force-image-build
-
が AWS SAM CLI は、レイヤーで Lambda 関数を呼び出すために使用されるイメージを再構築する必要があります。
--help
-
このメッセージを表示して終了します。
--hook-name TEXT
-
拡張に使用されるフックの名前 AWS SAM CLI 機能。
許容値:
terraform
。 --invoke-image
TEXT
-
ローカル関数の呼び出しに使用するコンテナイメージURIの 。デフォルトでは、 は Amazon ECR Public ( にリストされている) からコンテナイメージを AWS SAM プルしますのイメージリポジトリ AWS SAM。このオプションは、別の場所からイメージをプルするために使用します。
例えば、
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。の AWS SAM CLI 形式は明示的なキーと値のキーワードで、各オーバーライドはスペースで区切られます。ここでは、以下の 2 つの例を示します。
--parameter-overrides ParameterKey=hello,ParameterValue=world
--parameter-overrides ParameterKey=hello,ParameterValue=world ParameterKey=example1,ParameterValue=example2 ParameterKey=apple,ParameterValue=banana
--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 の最新のリモートランタイム環境をチェックし、ローカルイメージを自動的に更新して同期を維持します。
最新の のプルダウンをスキップするには、このオプションを指定します。Docker Lambda ランタイム環境のイメージ。
--template, -t
PATH
-
AWS SAM テンプレートファイル。
このオプションは
--hook-name
と互換性がありません。注記
このオプションを指定すると、 は、参照先のテンプレートとローカルリソースのみを AWS SAM ロードします。
--terraform-plan-file
-
ローカルへの相対パスまたは絶対パス Terraform を使用する際の計画ファイル AWS SAM CLI with Terraform Cloud。 このオプションでは、
--hook-name
を に設定する必要がありますterraform
。
例
次の例では、s3.json
イベントを使用して Lambda 関数をローカルで呼び出すことで、生成されたイベントをローカルテストに使用します。
$
sam local invoke --event
events/s3.json S3JsonLoggerFunction