View a markdown version of this page

sam local 调用 - AWS Serverless Application Model

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

sam local 调用

本页提供以下方面的参考信息 AWS Serverless Application Model 命令行界面 (AWS SAM CLI) sam local invoke 子命令。

这个 sam local invoke 子命令发起一次性调用 AWS Lambda 本地事件函数。

重要

不要使用 sam local invoke 使用不可信的代码。要与本地环境完全隔离,请直接在 Lambda 服务中运行代码。

注意

为了实现耐用的功能, sam local invoke 支持带有自动检查点和重放的状态执行。容器在持久函数执行期间保持运行状态,以处理状态持久化和恢复。

用量

$ sam local invoke <arguments> <options>
注意

如果您在中定义了多个函数 AWS SAM 模板,提供您要调用的函数逻辑 ID。

参数

Resource ID

要调用的 Lambda 函数 的 ID。

此参数是可选的。如果您的应用程序包含单个 Lambda 函数, AWS SAM CLI 将调用它。如果应用程序包含多个函数,请提供要调用的函数的 ID。

有效值:资源的逻辑 ID 或资源 ARN。

选项

--add-host LIST

将主机名到 IP 地址的映射传递到 Docker 容器的主机文件。此参数可以传递多次。

例

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

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

允许或拒绝测试版功能。

--config-env TEXT

在配置文件中指定要使用的默认参数值的环境名称。默认值为“default”。有关配置文件的详细信息,请参阅 AWS SAMCLI 配置文件。

--config-file PATH

包含要使用的默认参数值的配置文件的路径和文件名。在项目目录的根目录中,默认值为“samconfig.toml”。有关配置文件的详细信息,请参阅 AWS SAMCLI 配置文件。

--container-env-vars

(可选)在本地调试时,将环境变量传递到 Lambda 函数映像容器。

--container-host TEXT

本地模拟的 Lambda 容器的主机。默认值为 localhost。如果要在 macOS 上的 Docker 容器中运行 AWS SAM CLI,可以指定 host.docker.internal。如果你想在不同的主机上运行容器 AWS SAM CLI,您可以指定远程主机的 IP 地址。

--container-host-interface TEXT

应与容器端口绑定的主机网络接口的 IP 地址。默认值为 127.0.0.1。使用 0.0.0.0 可绑定到所有接口。

--container-dns TEXT

为 Docker 容器指定自定义 DNS 服务器。可以多次传递此参数以指定多个 DNS 服务器。

例

示例:--container-dns 8.8.8.8

--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 计算机上,修改此值以匹配远程计算机。

--durable-execution-name TEXT

持久执行的名称(仅适用于耐用函数)

--env-vars, -n PATH

JSON 或 .env 包含 Lambda 函数环境变量值的文件。文件格式会自动检测。有关环境变量文件的更多信息,请参阅环境变量文件。

--event, -e PATH

包含调用 Lambda 函数时传递给该函数的事件数据的 JSON 文件。如果不指定此选项,则不会假设任何事件。要从 stdin 中输入 JSON,必须传递值 '-'。有关不同事件消息格式的详细信息 AWS 服务,请参阅 使用其他服务 在 AWS Lambda 开发者指南。

--force-image-build

指定 AWS SAM CLI 是否应重建用于调用包含层的 Lambda 函数的映像。

--help

显示此消息并退出。

--hook-name TEXT

用于扩展 AWS SAM CLI 功能的钩子的名称。

可接受的值:terraform。

--invoke-image TEXT

要用于本地函数调用的容器映像的 URI。

对于带有 Lambda 函数 PackageType: Zip,这会覆盖运行时基础镜像。默认情况下, AWS SAM 从 Amazon ECR Public(列在 的图像存储库 AWS SAM中)拉取容器映像。使用此选项可从其他位置提取映像。

对于带有 Lambda 函数 PackageType: Image,这会覆盖 ImageUri 来自构建的模板。使用它可以在本地调用不同的应用程序镜像,而无需修改您的模板。

您可以多次指定该选项。此选项的每个实例都可以采用字符串或键值对。如果指定字符串,则字符串就是要用于应用程序中所有函数的容器映像 URI。例如 sam local invoke --invoke-image public.ecr.aws/sam/emu-python3.13。如果指定键值对,则键是资源名称,值是要用于该资源的容器映像 URI。例如 sam local invoke --invoke-image public.ecr.aws/sam/emu-python3.13 --invoke-image Function1=amazon/aws-sam-cli-emulation-image-python3.13。如果使用键值对,您可以为不同的资源指定不同的容器映像。

--layer-cache-basedir DIRECTORY

指定模板使用的层下载到的基目录的位置。

--log-file, -l TEXT

运行时日志将被发送到的日志文件。

确保 AWS SAM CLI 始终挂载文件中存在的 symlinks,以进行构建或调用。这仅适用于顶级目录中的 symlinks(即直接位于函数根目录下的 symlinks)。默认情况下,symlinks 不会被挂载,但用于在 NodeJS 中实现 node_modules 的 build-in-source 所需的 symlinks 除外。

--no-event

使用空事件调用函数。

--no-memory-limit

移除本地调用期间容器中的内存限制,即使在容器中配置了内存 AWS SAM 模板。

--parameter-overrides

一个包含以下内容的字符串 CloudFormation 参数替换编码为键值对。使用与相同的格式 AWS Command Line Interface (AWS CLI)。 AWS SAMCLI 格式为显式密钥和值关键字,每个覆盖都用空格分隔。以下是两个示例:

  • --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。

--runtime TEXT

使用指定的运行时在本地调用 Lambda 函数。这将覆盖 template.yml 文件中定义的运行时。这还让您可以在不修改原始函数配置的情况下,使用不同的运行时来测试 Lambda 函数。

--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 仅加载模板及其指向的本地资源。

--tenant-id TEXT

多租户 Lambda 函数的租户 ID。用于确保不同租户之间的计算隔离。调用使用租户隔离模式配置的函数时为必填项。

--terraform-plan-file

将 AWS SAM CLI 与 Terraform Cloud 配合使用时本地 Terraform 计划文件的相对路径或绝对路径。此选项要求将 --hook-name 设置为 terraform。

示例

以下示例使用生成的事件进行本地测试,方法是使用 s3.json 事件在本地调用 Lambda 函数

$ sam local invoke --event events/s3.json S3JsonLoggerFunction

以下示例使用 Python 3.11 运行时来测试函数 HelloWorldFunction

$ sam local invoke --runtime python3.11 HelloWorldFunction

以下示例测试该函数 HelloWorldFunction 使用耐用的执行名称

$ sam local invoke HelloWorldFunction --durable-execution-name my-execution