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

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

sam init

本页提供 Amazon Serverless Application Model 命令行界面 (Amazon SAMCLI) sam init 命令的参考信息。

sam init 命令提供用于初始化新的无服务器应用程序的选项。

用法

$ sam init <options>

Options

--app-template TEXT

您要使用的托管应用程序模板的标识符。如果您不确定,请在没有交互式工作流选项的情况下调用 sam init

如果指定了 --no-interactive,且不提供 --location ,则需要此参数。

此参数只在 Amazon SAM CLI 版本 0.30.0 及更高版本中提供。对早期版本指定此参数会导致错误。

--application-insights | --no-application-insights

为您的 CloudWatch 应用程序激活 Amazon 应用程序见解监控。要了解更多信息,请参阅使用 “应用洞察” 监控您的无服务器 CloudWatch 应用程序

默认选项是 --no-application-insights

--architecture, -a [ x86_64 | arm64 ]

应用程序的 Lambda 函数的指令集架构。指定 x86_64arm64

--base-image [ amazon/dotnet8-base | amazon/dotnet6-base | amazon/dotnetcore3.1-base | amazon/go1.x-base | amazon/java21-base | amazon/java17-base | amazon/java11-base | amazon/java8.al2-base | amazon/java8-base | amazon/nodejs20.x-base | amazon/nodejs18.x-base | amazon/nodejs16.x-base | | amazon/python3.12-base | amazon/python3.11-base | amazon/python3.10-base | amazon/python3.9-base | amazon/python3.8-base | amazon/ruby3.3-base | amazon/ruby3.2-base ]

应用程序的基本映像。当软件包类型为 Image 时,此选项才适用。

如果已指定 --no-interactive--package-type 被指定为 Image,且未指定 --location,则需要此参数。

--config-env TEXT

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

--config-file PATH

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

--debug

启用调试日志记录,以打印 Amazon SAM CLI 生成的调试消息并显示时间戳。

--dependency-manager, -d [ gradle | mod | maven | bundler | npm | cli-package | pip ]

Lambda 运行时的依赖项管理器。

--extra-content

覆盖模板的 cookiecutter.json 配置中的任何自定义参数,例如 {"customParam1": "customValue1", "customParam2":"customValue2"}

--help, -h

显示此消息并退出。

--location, -l TEXT

模板或应用程序的位置(Git、Mercurial、HTTP/HTTPS、.zip 文件、路径)。

如果指定了 --no-interactive 且未提供 --runtime--name--app-template,则需要此参数。

对于 Git 存储库,必须使用存储库根目录的位置。

对于本地路径,模板必须为 .zip 文件或 Cookiecutter 格式。

--name, -n TEXT

要生成为目录的项目的名称。

如果指定了 --no-interactive,且不提供 --location ,则需要此参数。

--no-input

禁用 Cookiecutter 提示并接受模板配置中定义的 vcfdefault 值。

--no-interactive

禁用 init 参数的交互式提示,如果缺少任何必需值,则失败。

--output-dir, -o PATH

已初始化的应用程序的输出位置。

--package-type [ Zip | Image ]

示例应用程序的软件包类型。Zip 会创建 .zip 文件存档,Image 会创建容器映像。

--runtime, -r [ dotnet8 | dotnet6 | dotnetcore3.1 | go1.x | java21 | java17 | java11 | java8 | java8.al2 | nodejs20.x | nodejs18.x | nodejs16.x | python3.12 | python3.11 | python3.10 | python3.9 | python3.8 | ruby3.3 | ruby3.2 ]

应用程序的 Lambda 运行时。当软件包类型为 Zip 时,此选项才适用。

如果已指定 --no-interactive--package-type 被指定为 Zip,且未指定 --location,则需要此参数。

--save-params

将您在命令行中提供的参数保存到 Amazon SAM 配置文件中。

--tracing | --no-tracing

激活您的 Lambda 函数的 Amazon X-Ray 跟踪。