SAM 本地调用 - Amazon Serverless Application Model
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

SAM 本地调用

调用本地Amazon Lambda函数一次,在调用完成后退出。

默认情况下,当你使用此命令时,Amazon SAMCLI 假设你当前的工作目录是项目的根目录。这些区域有:Amazon SAMCLI 首先尝试查找使用sam build命令,位于.aws-sam子文件夹,并命名template.yaml或者template.yml. 下一步:Amazon SAMCLI 尝试找到名为的模板文件template.yaml或者template.yml在当前工作目录中。如果你指定--template选项,Amazon SAMCLI 的默认行为被覆盖,并且只会加载该行为Amazon SAM模板以及它指向的本地资源。

要调用嵌套应用程序或堆栈的函数,可以使用格式提供应用程序或堆栈逻辑 ID 以及函数逻辑 IDStackLogicalId/FunctionLogicalId.

这些区域有:sam local invoke命令对于开发处理异步事件的无服务器函数非常有用,如 Amazon Simple Storage Service (Amazon S3) 或 Amazon Kinesis 事件。如果你想编写测试用例的脚本,它也很有用。你可以使用--event参数。有关事件的更多信息,请参阅 。Event中的Amazon Lambda开发人员指南. 有关不同的事件消息格式的详细信息Amazon服务,请参阅使用其他服务中的Amazon Lambda开发人员指南.

运行时输出(例如,日志)输出到stderr,然后 Lambda 函数结果将输出到stdout.

注意

如果在您的中定义了多个函数Amazon SAM模板,您必须提供FUNCTION_LOGICAL_ID要调用的函数。

使用方法:

sam local invoke [OPTIONS] [FUNCTION_LOGICAL_ID]

选项:

选项 描述
-e, --event PATH 包含调用 Lambda 函数时传递给 Lambda 函数的事件数据的 JSON 文件。如果不指定此选项,将假定不会发生任何事件。要从中输入 JSONstdin,您必须传入值 “”。有关不同的事件消息格式的详细信息Amazon服务,请参阅使用其他服务中的Amazon Lambda开发人员指南.
--no-event 使用空事件调用函数。
-t, --template PATH 这些区域有:Amazon SAM模板文件。

注意:如果指定此选项,则Amazon SAM仅加载模板及其指向的本地资源。

-n, --env-vars PATH 包含 Lambda 函数环境变量值的 JSON 文件。有关环境变量文件的更多信息,请参阅。环境变量文件.
--parameter-overrides (可选)包含的字符串Amazon CloudFormation参数覆盖编码为键值对。使用的格式与Amazon Command Line Interface(Amazon CLI)。例如:'ParameterKey=KeyPairNameParameterValue=MyKey ParameterKey=InstanceTypeParameterValue=t1.micro'。
-d, --debug-port TEXT 指定后,以调试模式启动 Lambda 函数容器,并在本地主机上公开此端口。
--debugger-path TEXT 挂载到 Lambda 容器中的调试器的主机路径。
--debug-args TEXT 要传递到调试器的额外参数。
-v, --docker-volume-basedir TEXT 基目录的位置Amazon SAM文件存在。如果 Docker 在远程计算机上运行,则必须将路径挂载到Amazon SAM文件存在于 Docker 计算机上,并修改此值以匹配远程计算机。
--docker-network TEXT Lambda Docker 容器应连接到的现有 Docker 网络的名称或 ID,以及默认桥接网络。如果未指定此项,Lambda 容器将仅连接到默认的桥接 Docker 网络。
--container-env-vars (可选)在本地调试时将环境变量传递给 Lambda 函数映像容器。
-l, --log-file TEXT 要向其发送运行时日志的日志文件。
--layer-cache-basedir DIRECTORY 指定将模板使用的图层下载到的基目录的位置。
--skip-pull-image 指定是否Amazon SAMCLI 应跳过提取 Lambda 运行时的最新 Docker 映像。
--force-image-build 指定是否Amazon SAMCLI 应重建用于调用带图层的 Lambda 函数的映像。
--profile TEXT 从凭证文件中获取的特定配置文件Amazon凭证。
--region TEXT 这些区域有:Amazon部署到的区域。例如,us-east-1。
--config-file PATH 配置文件的路径和文件名,包含要使用的默认参数值。默认值是”samconfig.toml“在项目目录的根目录中。有关配置文件的详细信息,请参阅 Amazon SAMCLI 配置文件
--config-env TEXT 指定配置文件中要使用的默认参数值的环境名称。默认值为 “默认”。有关配置文件的详细信息,请参阅 Amazon SAMCLI 配置文件
--shutdown 在调用完成后模拟关闭事件,以测试关闭行为的扩展处理。
--container-host TEXT 本地模拟 Lambda 容器的主机。默认值为 localhost。如果你想跑Amazon SAM在 macOS 上 Docker 容器中的 CLI,你可以指定host.docker.internal. 如果你想在不同的主机上运行容器Amazon SAMCLI,您可以指定远程主机的 IP 地址。
--container-host-interface TEXT 容器端口应绑定到的主机网络接口的 IP 地址。默认值为 127.0.0.1。使用0.0.0.0绑定到所有接口。
--debug 打开调试日志记录以打印调试消息Amazon SAMCLI 生成,并显示时间戳。
--help 显示此消息并退出。