CancelUpdateStack ContinueUpdateRollback CreateStack 部署 DeleteStack DescribeStackEvents DescribeStackResource DescribeStackResources DescribeStacks GetTemplate ListStackResources ListStacks UpdateStack ValidateTemplate

AWS CLI 和 PowerShell 的 CloudFormation 堆栈操作命令示例

以下命令行示例演示了如何使用 AWS CLI 和 PowerShell 执行各个 CloudFormation 操作。这些示例仅包括最常用的操作。有关完整列表，请参阅 AWS CloudFormation API 参考。

本主题中的示例使用反斜杠 (\) 的惯例来表示长命令行在下一行继续。

主题

取消堆栈更新
继续回滚更新
创建堆栈
创建包含转换的堆栈
删除堆栈
描述堆栈事件
描述堆栈资源
描述堆栈资源
描述堆栈
获取模板
列出堆栈资源
列出堆栈
更新堆栈
验证模板
使用 AWS CLI 将本地构件上传到 S3 存储桶

取消堆栈更新

cancel-update-stack 命令用于取消堆栈更新。有关更多信息，请参阅取消堆栈更新。

继续回滚更新

continue-update-rollback 命令用于继续回滚更新。有关更多信息，请参阅继续回滚更新。

创建堆栈

create-stack 命令用于创建堆栈。您必须提供堆栈名称、有效模板的位置和所有输入参数。参数键名称区分大小写。如果您输入错误的参数键名称，则 CloudFormation 不会创建堆栈，并且会报告模板不包含该参数。

默认情况下，describe-stacks 命令返回参数值。为了防止返回密码等敏感参数值，请在 CloudFormation 模板中包含一个设置为 TRUE 的 NoEcho 属性。

重要

使用 NoEcho 属性不会遮蔽在以下各区段中存储的任何信息：

Metadata 模板区段。CloudFormation 不会转换、修改或编辑您在 Metadata 部分中包含的任何信息。有关更多信息，请参阅 CloudFormation 模板的 Metadata 部分语法参考。
Outputs 模板区段。有关更多信息，请参阅 CloudFormation 模板的 Outputs 部分语法参考。
资源定义的 Metadata 属性。有关更多信息，请参阅 Metadata 属性。

强烈建议您不要使用这些机制来包含敏感信息，例如密码。

重要

我们建议不要将敏感信息直接嵌入 CloudFormation 模板中，而应使用堆栈模板中的动态参数来引用在 CloudFormation 外部存储和管理的敏感信息，例如 AWS Systems Manager Parameter Store 或 AWS Secrets Manager 中的敏感信息。

有关更多信息，请参阅请勿将凭证嵌入您的模板最佳实践。

以下示例演示了如何使用指定的名称、模板和输入参数创建新堆栈。

CLI

AWS CLI

创建 AWS CloudFormation 堆栈

以下 create-stacks 命令使用 sampletemplate.json 模板创建了名为 myteststack 的堆栈：


aws cloudformation create-stack --stack-name myteststack --template-body file://sampletemplate.json --parameters ParameterKey=KeyPairName,ParameterValue=TestKey ParameterKey=SubnetIDs,ParameterValue=SubnetID1\\,SubnetID2

输出：


{
    "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896"
}

有关更多信息，请参阅《AWS CloudFormation 用户指南》中的“堆栈”。

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CreateStack。

PowerShell

适用于 PowerShell 的工具

示例 1：使用指定名称创建新堆栈。模板是从提供的内容中解析出来的，使用了自定义参数（“PK1”和“PK2”代表模板内容中声明的参数名称，“PV1”和“PV2”代表这些参数的值）。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。如果堆栈创建失败，则不会将其回滚。


New-CFNStack -StackName "myStack" `
             -TemplateBody "{TEMPLATE CONTENT HERE}" `
             -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" }) `
             -DisableRollback $true

示例 2：使用指定名称创建新堆栈。模板是从提供的内容中解析出来的，使用了自定义参数（“PK1”和“PK2”代表模板内容中声明的参数名称，“PV1”和“PV2”代表这些参数的值）。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。如果堆栈创建失败，则会将其回滚。


$p1 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p1.ParameterKey = "PK1"
$p1.ParameterValue = "PV1"

$p2 = New-Object -Type Amazon.CloudFormation.Model.Parameter
$p2.ParameterKey = "PK2"
$p2.ParameterValue = "PV2"

New-CFNStack -StackName "myStack" `
             -TemplateBody "{TEMPLATE CONTENT HERE}" `
             -Parameter @( $p1, $p2 ) `
             -OnFailure "ROLLBACK"

示例 3：使用指定名称创建新堆栈。模板是从 Amazon S3 URL 获得的，使用了自定义参数（“PK1”代表模板内容中声明的参数名称，“PV1”代表该参数的值）。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。如果堆栈创建失败，则会将其回滚（与指定 -DisableRollback $false 时相同）。


New-CFNStack -StackName "myStack" `
             -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
             -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }

示例 4：使用指定名称创建新堆栈。模板是从 Amazon S3 URL 获得的，使用了自定义参数（“PK1”代表模板内容中声明的参数名称，“PV1”代表该参数的值）。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。如果堆栈创建失败，则会将其回滚（与指定 -DisableRollback $false 时相同）。指定的通知 AEN 将收到发布的堆栈相关事件。


New-CFNStack -StackName "myStack" `
             -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
             -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" } `
             -NotificationARN @( "arn1", "arn2" )

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 CreateStack。

您也可指定模板文件的 AWS Systems Manager 位置。

创建包含转换的堆栈

deploy 命令用于创建包含转换的堆栈。

要使用模板创建包含转换的堆栈，您必须使用更改集。您可以使用 deploy 命令将这些步骤组合成一个命令，而无需创建更改集，然后再将其启动。

删除堆栈

delete-stack 命令用于删除堆栈。有关更多信息，请参阅通过 CloudFormation 控制台删除堆栈。

如果删除失败并返回 DELETE_FAILED 状态，可以选择使用 --deletion-mode 选项强制删除堆栈。以下是可以与 deletion-mode 一起使用的值：

STANDARD：正常删除堆栈。这是默认删除模式。
FORCE_DELETE_STACK：删除堆栈并跳过所有无法删除的资源。

使用 FORCE_DELETE_STACK 后，您可以使用 list-stack-resources 命令列出在堆栈删除过程中跳过的资源。保留的资源将显示为 DELETE_SKIPPED 状态。有关更多信息，请参阅列出堆栈资源。

描述堆栈事件

describe-stack-events 命令用来描述堆栈事件。有关更多信息，请参阅监控堆栈进度。

CLI

AWS CLI

描述堆栈事件

以下 describe-stack-events 示例显示了指定堆栈的 2 个最新事件。


aws cloudformation describe-stack-events \
    --stack-name my-stack \
    --max-items 2

{
    "StackEvents": [
        {
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "EventId": "4e1516d0-e4d6-xmpl-b94f-0a51958a168c",
            "StackName": "my-stack",
            "LogicalResourceId": "my-stack",
            "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "ResourceType": "AWS::CloudFormation::Stack",
            "Timestamp": "2019-10-02T05:34:29.556Z",
            "ResourceStatus": "UPDATE_COMPLETE"
        },
        {
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "EventId": "4dd3c810-e4d6-xmpl-bade-0aaf8b31ab7a",
            "StackName": "my-stack",
            "LogicalResourceId": "my-stack",
            "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "ResourceType": "AWS::CloudFormation::Stack",
            "Timestamp": "2019-10-02T05:34:29.127Z",
            "ResourceStatus": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
        }
    ],
    "NextToken": "eyJOZXh0VG9XMPLiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DescribeStackEvents。

PowerShell

适用于 PowerShell 的工具

示例 1：返回指定堆栈的所有堆栈相关事件。


Get-CFNStackEvent -StackName "myStack"

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 DescribeStackEvents。

描述堆栈资源

CLI

AWS CLI

获取有关堆栈资源的信息

以下 describe-stack-resources 示例显示了指定堆栈中的资源详细信息。


aws cloudformation describe-stack-resources \
    --stack-name my-stack

输出：


{
    "StackResources": [
        {
            "StackName": "my-stack",
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "LogicalResourceId": "bucket",
            "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf",
            "ResourceType": "AWS::S3::Bucket",
            "Timestamp": "2019-10-02T04:34:11.345Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "StackName": "my-stack",
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "LogicalResourceId": "function",
            "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
            "ResourceType": "AWS::Lambda::Function",
            "Timestamp": "2019-10-02T05:34:27.989Z",
            "ResourceStatus": "UPDATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "StackName": "my-stack",
            "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204",
            "LogicalResourceId": "functionRole",
            "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E",
            "ResourceType": "AWS::IAM::Role",
            "Timestamp": "2019-10-02T04:34:06.350Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        }
    ]
}

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DescribeStackResources。

PowerShell

适用于 PowerShell 的工具

示例 1：返回与指定堆栈关联的最多 100 个资源的 AWS 资源描述。要获取与堆栈关联的所有资源的详细信息，请使用 Get-CFNStackResourceSummary，该命令还支持对结果进行手动分页。


Get-CFNStackResourceList -StackName "myStack"

示例 2：返回与指定堆栈关联的模板中用逻辑 ID “Ec2Instance”标识的 Amazon EC2 实例的描述。


Get-CFNStackResourceList -StackName "myStack" -LogicalResourceId "Ec2Instance"

示例 3：对于包含用实例 ID “i-123456”标识的 Amazon EC2 实例的堆栈，返回与该堆栈关联的最多 100 个资源的描述。要获取与堆栈关联的所有资源的详细信息，请使用 Get-CFNStackResourceSummary，该命令还支持对结果进行手动分页。


Get-CFNStackResourceList -PhysicalResourceId "i-123456"

示例 4：返回在堆栈模板中用逻辑 ID “Ec2Instance”标识的 Amazon EC2 实例的描述。该堆栈用其包含的资源的物理资源 ID 进行标识，在此例中即为实例 ID 为“i-123456”的 Amazon EC2 实例。也可以根据模板内容使用其他物理资源来识别堆栈，例如 Amazon S3 存储桶。


Get-CFNStackResourceList -PhysicalResourceId "i-123456" -LogicalResourceId "Ec2Instance"

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 DescribeStackResources。

描述堆栈

CLI

AWS CLI

描述 AWS CloudFormation 堆栈

以下 describe-stacks 命令显示了 myteststack 堆栈的摘要信息：


aws cloudformation describe-stacks --stack-name myteststack

输出：


{
    "Stacks":  [
        {
            "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896",
            "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
            "Tags": [],
            "Outputs": [
                {
                    "Description": "Name of S3 bucket to hold website content",
                    "OutputKey": "BucketName",
                    "OutputValue": "myteststack-s3bucket-jssofi1zie2w"
                }
            ],
            "StackStatusReason": null,
            "CreationTime": "2013-08-23T01:02:15.422Z",
            "Capabilities": [],
            "StackName": "myteststack",
            "StackStatus": "CREATE_COMPLETE",
            "DisableRollback": false
        }
    ]
}

有关更多信息，请参阅《AWS CloudFormation 用户指南》中的“堆栈”。

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DescribeStacks。

Go

适用于 Go V2 的 SDK

注意

查看 GitHub，了解更多信息。查找完整示例，学习如何在 AWS 代码示例存储库中进行设置和运行。



// StackOutputs defines a map of outputs from a specific stack.
type StackOutputs map[string]string

type CloudFormationActions struct {
	CfnClient *cloudformation.Client
}

// GetOutputs gets the outputs from a CloudFormation stack and puts them into a structured format.
func (actor CloudFormationActions) GetOutputs(ctx context.Context, stackName string) StackOutputs {
	output, err := actor.CfnClient.DescribeStacks(ctx, &cloudformation.DescribeStacksInput{
		StackName: aws.String(stackName),
	})
	if err != nil || len(output.Stacks) == 0 {
		log.Panicf("Couldn't find a CloudFormation stack named %v. Here's why: %v\n", stackName, err)
	}
	stackOutputs := StackOutputs{}
	for _, out := range output.Stacks[0].Outputs {
		stackOutputs[*out.OutputKey] = *out.OutputValue
	}
	return stackOutputs
}

有关 API 详细信息，请参阅《AWS SDK for Go API 参考》中的 DescribeStacks。

PowerShell

适用于 PowerShell 的工具

示例 1：返回描述用户的所有堆栈的堆栈实例集合。


Get-CFNStack

示例 2：返回描述指定堆栈的堆栈实例


Get-CFNStack -StackName "myStack"

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 DescribeStacks。

获取模板

列出堆栈资源

CLI

AWS CLI

列出堆栈中的资源

以下命令显示了指定堆栈中的资源列表。


aws cloudformation list-stack-resources \
    --stack-name my-stack

输出：


{
    "StackResourceSummaries": [
        {
            "LogicalResourceId": "bucket",
            "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf",
            "ResourceType": "AWS::S3::Bucket",
            "LastUpdatedTimestamp": "2019-10-02T04:34:11.345Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "LogicalResourceId": "function",
            "PhysicalResourceId": "my-function-SEZV4XMPL4S5",
            "ResourceType": "AWS::Lambda::Function",
            "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z",
            "ResourceStatus": "UPDATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        },
        {
            "LogicalResourceId": "functionRole",
            "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E",
            "ResourceType": "AWS::IAM::Role",
            "LastUpdatedTimestamp": "2019-10-02T04:34:06.350Z",
            "ResourceStatus": "CREATE_COMPLETE",
            "DriftInformation": {
                "StackResourceDriftStatus": "IN_SYNC"
            }
        }
    ]
}

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListStackResources。

PowerShell

适用于 PowerShell 的工具

示例 1：返回与指定堆栈关联的所有资源的描述。


Get-CFNStackResourceSummary -StackName "myStack"

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 ListStackResources。

列出堆栈

list-stacks 命令用来列出堆栈。要只列出具有指定状态代码的堆栈，请添加 --stack-status-filter 选项。可以为 --stack-status-filter 选项指定一个或多个堆栈状态代码。有关更多信息，请参阅堆栈状态代码。

CLI

AWS CLI

列出 AWS CloudFormation 堆栈

以下 list-stacks 命令显示了具有 CREATE_COMPLETE 状态的所有堆栈的摘要信息：


aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE

输出：


[
    {
        "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896",
        "TemplateDescription": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
        "StackStatusReason": null,
        "CreationTime": "2013-08-26T03:27:10.190Z",
        "StackName": "myteststack",
        "StackStatus": "CREATE_COMPLETE"
    }
]

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListStacks。

PowerShell

适用于 PowerShell 的工具

示例 1：返回所有堆栈的摘要信息。


Get-CFNStackSummary

示例 2：返回当前正在创建的所有堆栈的摘要信息。


Get-CFNStackSummary -StackStatusFilter "CREATE_IN_PROGRESS"

示例 3：返回当前正在创建或更新的所有堆栈的摘要信息。


Get-CFNStackSummary -StackStatusFilter @("CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS")

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 ListStacks。

更新堆栈

使用 update-stack 命令可直接更新堆栈。您指定要更新的堆栈、参数值和功能，如果您希望使用更新后的模板，还需指定模板的名称。有关更多信息，请参阅直接更新堆栈。

CLI

AWS CLI

更新 AWS CloudFormation 堆栈

以下 update-stack 命令更新了 mystack 堆栈的模板和输入参数：


aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,ParameterValue=SampleKeyPair ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,SampleSubnetID2

以下 update-stack 命令更新了 mystack 堆栈的 SubnetIDs 参数值：如果您没有指定参数值，则将使用模板中指定的默认值：


aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,UsePreviousValue=true ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,UpdatedSampleSubnetID2

以下 update-stack 命令向 mystack 堆栈添加了两个堆栈通知主题：


aws cloudformation update-stack --stack-name mystack --use-previous-template --notification-arns "arn:aws:sns:use-east-1:123456789012:mytopic1" "arn:aws:sns:us-east-1:123456789012:mytopic2"

有关更多信息，请参阅《AWS CloudFormation 用户指南》中的 AWS 堆栈更新。

有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UpdateStack。

PowerShell

适用于 PowerShell 的工具

示例 1：使用指定的模板和自定义参数更新堆栈“MyStack”。“PK1”代表模板中声明的参数名称，“PV1”代表参数值。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。


Update-CFNStack -StackName "myStack" `
                -TemplateBody "{Template Content Here}" `
                -Parameter @{ ParameterKey="PK1"; ParameterValue="PV1" }

示例 2：使用指定的模板和自定义参数更新堆栈“MyStack”。“PK1”和“PK2”代表模板中声明的参数名称，“PV1”和“PV2”代表请求的参数值。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。


Update-CFNStack -StackName "myStack" `
                -TemplateBody "{Template Content Here}" `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )

示例 3：使用指定的模板和自定义参数更新堆栈“MyStack”。“PK1”代表模板中声明的参数名称，“PV2”代表参数值。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。


Update-CFNStack -StackName "myStack" -TemplateBody "{Template Content Here}" -Parameters @{ ParameterKey="PK1"; ParameterValue="PV1" }

示例 4：使用从 Amazon S3 获得的指定模板和自定义参数更新堆栈“MyStack”。“PK1”和“PK2”代表模板中声明的参数名称，“PV1”和“PV2”代表请求的参数值。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。


Update-CFNStack -StackName "myStack" `
                -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } )

示例 5：使用从 Amazon S3 获得的指定模板和自定义参数更新堆栈“MyStack”（在此例中假设该堆栈包含 IAM 资源）。“PK1”和“PK2”代表模板中声明的参数名称，“PV1”和“PV2”代表请求的参数值。也可以使用“键”和“值”来指定自定义参数，而不是“ParameterKey”和“ParameterValue”。由于堆栈包含 IAM 资源，您需要指定 -Capabilities "CAPABILITY_IAM" 参数，否则更新将失败并出现“InsufficientCapabilities”错误。


Update-CFNStack -StackName "myStack" `
                -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template `
                -Parameter @( @{ ParameterKey="PK1"; ParameterValue="PV1" }, @{ ParameterKey="PK2"; ParameterValue="PV2" } ) `
                -Capabilities "CAPABILITY_IAM"

有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 UpdateStack。

注意

要移除所有通知，请为 --notification-arns 选项指定 []。

验证模板

validate-template 命令用来检查模板文件的语法错误。

在验证期间，CloudFormation 首先检查模板是否是有效的 JSON。如果不是，CloudFormation 会检查模板是否是有效的 YAML。如果两种检查都失败，CloudFormation 会返回模板验证错误。

CLI

AWS CLI

验证 AWS CloudFormation 模板

以下 validate-template 命令将验证 sampletemplate.json 模板：


aws cloudformation validate-template --template-body file://sampletemplate.json

输出：


{
    "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
    "Parameters": [],
    "Capabilities": []
}

有关更多信息，请参阅《AWS CloudTrail 用户指南》中的“使用 AWS CloudFormation 模板”。

有关 API 的详细信息，请参阅《AWS CLI 命令参考》中的 ValidateTemplate。

PowerShell

适用于 PowerShell 的工具

示例 1：验证指定模板的内容。输出详细说明了模板的功能、描述和参数。


Test-CFNTemplate -TemplateBody "{TEMPLATE CONTENT HERE}"

示例 2：验证通过 Amazon S3 URL 访问的指定模板。输出详细说明了模板的功能、描述和参数。


Test-CFNTemplate -TemplateURL https://s3.amazonaws.com/amzn-s3-demo-bucket/templatefile.template

有关 API 的详细信息，请参阅《AWS Tools for PowerShell Cmdlet 参考》中的 ValidateTemplate。

以下是产生验证错误的响应示例。


{
    "ResponseMetadata": {
        "RequestId": "4ae33ec0-1988-11e3-818b-e15a6df955cd"
    },
    "Errors": [
        {
            "Message": "Template format error: JSON not well-formed. (line 11, column 8)",
            "Code": "ValidationError",
            "Type": "Sender"
        }
    ],
    "Capabilities": [],
    "Parameters": []
}
A client error (ValidationError) occurred: Template format error: JSON not well-formed. (line 11, column 8)

注意

validate-template 命令仅用于检查模板的语法。它不能确保您为资源指定的属性值对该资源有效，也无法确定创建堆栈时将存在的资源数量。

要检查操作有效性，需要尝试创建堆栈。AWS CloudFormation 堆栈没有沙盒或测试区域，因此您需要为测试期间创建的资源付费。

示例可用性

找不到所需的内容？通过使用本页底部的提供反馈链接来请求代码示例。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

为堆栈创建快速创建链接

将本地构件上传到 S3 存储桶