本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
sam deploy
Amazon Serverless Application Model命令行界面 (Amazon SAMCLI)sam deploy 命令的选项。
-
有关Amazon SAM CLI 的简介,请参阅什么是Amazon SAM CLI?。
-
有关使用Amazon SAM CLI
sam deploy命令的文档,请参阅使用 sam deploy。
用量
$sam deploy<options>
环境变量
| 环境变量 | 描述 |
|---|---|
SAM_CLI_POLL_DELAY |
指定 以下是示例:
|
选项
| 选项 | 描述 |
|---|---|
-g, --guided |
指定此选项可让Amazon SAM CLI 使用提示来指导您完成部署。 |
-t, --template-file, --template PATH |
您的Amazon SAM模板所在的路径和文件名。 注意:如果您指定此选项,则仅Amazon SAM部署模板及其指向的本地资源。 |
--stack-name TEXT |
(必选)您要部署到的Amazon CloudFormation堆栈的名称。如果指定现有堆栈,则该命令将更新堆栈。如果指定新堆栈,则该命令将创建它。 |
--s3-bucket TEXT |
此命令用于上传您的 Amazon S3 桶的Amazon CloudFormation名称。如果您的模板大于 51,200 字节,则该--s3-bucket选项或--resolve-s3选项为必填项。如果您同时指定--s3-bucket和--resolve-s3选项,则会出现错误。 |
--s3-prefix TEXT |
添加到 Amazon S3 桶的对象名称的前缀。前缀名称是 Amazon S3 桶的路径名(文件夹名称)。 |
--image-repository TEXT |
此命令用于上传您的函数映像的 Amazon ECR 存储库的名称。使用Image包类型声明的函数需要此选项。 |
--signing-profiles LIST |
用于签署部署包的签名配置文件列表。此选项采用键值对列表,其中密钥是要签名的函数或层的名称,值是签名配置文件,用可选的配置文件所有者分隔:。例如,FunctionNameToSign=SigningProfileName1
LayerNameToSign=SigningProfileName2:SigningProfileOwner。 |
--capabilities LIST |
必须指定才能创建特定堆栈Amazon CloudFormation的功能列表。一些堆栈模板可能包含可影响您的中权限的资源Amazon Web Services 账户,例如,通过创建新的Amazon Identity and Access Management(IAM)用户。对于这些堆栈,必须通过指定此选项来明确确认其功能。有效值仅为 CAPABILITY_IAM 和 CAPABILITY_NAMED_IAM。如果包含 IAM 资源,则可以指定任意一个功能。如果包含具有自定义名称的 IAM 资源,则必须指定CAPABILITY_NAMED_IAM。如果不指定此选项,则该操作将返回InsufficientCapabilities错误。 |
--region TEXT |
Amazon Web Services 区域要部署到的。例如,us-east-1。 |
--profile TEXT |
您的凭证文件中获取Amazon证书的特定配置文件。 |
--kms-key-id TEXT |
用于加密 Amazon S3 存储桶中静态对象的Amazon Key Management Service (Amazon KMS) 密钥的 ID。如果不指定此选项,则Amazon SAM使用 Amazon S3 托管式加密密钥。 |
--force-upload |
指定此选项可上传构件,即使它们与 Amazon S3 存储段中的现有构件相匹配。匹配的伪像会被覆盖。 |
--no-execute-changeset |
表示是否应用变更集。如果您想在应用变更集之前查看堆栈更改,请指定此选项。此命令创建一个Amazon CloudFormation变更集,然后在不应用变更集的情况下退出。要应用变更集,请运行不带此选项的相同命令。 |
--role-arn TEXT |
应用变更集时的 IAmazon ResourcAmazon CloudFormation e Name (ARN)。 |
--fail-on-empty-changeset | --no-fail-on-empty-changeset |
指定在堆栈无需更改时是否返回非零退出代码。默认行为是返回非零的退出代码。 |
--confirm-changeset | --no-confirm-changeset |
提示确认Amazon SAM CLI 是否部署了计算出的变更集。 |
--use-json |
为Amazon CloudFormation模板输出 JSON。默认输出是 YAML。 |
--resolve-s3 |
自动创建 Amazon S3 存储桶,用于打包和部署非引导式部署。如果您指定了该--guided选项,则Amazon SAM CLI 会忽略--resolve-s3。如果您同时指定--s3-bucket和--resolve-s3选项,则会出现错误。 |
--resolve-image-repos |
自动创建 Amazon ECR 存储库,用于打包和部署非引导式部署。此选项仅适用于具有PackageType: Image指定的函数和图层。如果您指定了该--guided选项,则Amazon SAM CLI 会忽略--resolve-image-repos。注意:如果使用此选项Amazon SAM自动为函数或层创建任何 Amazon ECR 存储库,并且您随后从Amazon SAM模板中删除了这些函数或层,则相应的 Amazon ECR 存储库将自动删除。 |
--metadata |
用于附加到模板中引用的所有对象的元数据地图。 |
--notification-arns LIST |
与堆栈Amazon CloudFormation关联的 Amazon Snple Notifple (Amazon SNS) 主题 ARN。 |
--tags LIST |
要与创建或更新的堆栈关联的标签列表。 Amazon CloudFormation还可以将这些标签传播到堆栈中支持它的资源。 |
--parameter-overrides |
包含编码为键/值对的Amazon CloudFormation参数覆盖的字符串。使用与Amazon Command Line Interface (Amazon CLI) 相同的格式。例如,ParameterKey=ParameterValue
InstanceType=t1.micro。 |
--disable-rollback | --no-disable-rollback |
指定在部署期间出现错误时是否回滚Amazon CloudFormation堆栈。默认情况下,如果部署期间出现错误,您的Amazon CloudFormation堆栈会回滚到上一个稳定状态。如果您指定--disable-rollback并在部署期间出现错误,则不会回退在错误发生之前创建或更新的资源。 |
--on-failure [ROLLBACK | DELETE | DO_NOTHING] |
指定堆栈创建失败时要采取的操作。 以下选项可用:
默认行为是 注意:您可以指定 |
--config-file PATH |
包含要使用的默认参数值的配置文件的路径和文件名。默认值samconfig.toml在项目目录的根目录中。有关配置文件的详细信息,请参阅 Amazon SAM CLI 配置文件。 |
--config-env TEXT |
环境名称,用于指定要使用的配置文件中的默认参数值。默认值为 default。有关配置文件的详细信息,请参阅 Amazon SAM CLI 配置文件。 |
--no-progressbar |
将构件上传到 Amazon S3 时不要显示进度条。 |
--debug |
开启调试日志记录以打印Amazon SAM CLI 生成的调试消息并显示时间戳。 |
--help |
显示此消息并退出。 |