这是新的《CloudFormation 模板参考指南》**。请更新您的书签和链接。有关开始使用 CloudFormation 的帮助，请参阅《AWS CloudFormation 用户指南》[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)。

# CloudFormation 资源规范
<a name="cfn-resource-specification"></a>

CloudFormation 资源规范是一个 JSON 格式的文本文件，用于定义 CloudFormation 支持的资源和属性。该文档是机器可读的强类型规范，可用于构建工具来创建 CloudFormation 模板。例如，您可以使用此规范在 IDE（集成式开发环境）中为 CloudFormation 模板构建自动完成和验证功能。

此资源规范组织为单个文件和一系列文件，其中，每个文件均包含一种资源类型的定义。单个文件和分隔的文件包含相同的信息。根据工具和您的实施，使用适合您的文件。

要下载此资源规范，请参阅下表。

资源可用性可能因区域而异。要检查给定区域中某个资源的可用性，请参考该区域的资源规范。


|  区域名称  |  区域  |  单个文件  |  所有文件  | 
| --- | --- | --- | --- | 
|  美国东部（俄亥俄州）  |  `us-east-2`  |  [.json](https://dnwj8swjjbsbt.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://dnwj8swjjbsbt.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  美国东部（弗吉尼亚州北部）  |  `us-east-1`  |  [.json](https://d1uauaxba7bl26.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d1uauaxba7bl26.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  美国西部（加利福尼亚北部）  |  `us-west-1`  |  [.json](https://d68hl49wbnanq.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d68hl49wbnanq.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  美国西部（俄勒冈州）  |  `us-west-2`  |  [.json](https://d201a2mn26r7lk.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d201a2mn26r7lk.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  非洲（开普敦）  |  `af-south-1`  |  [.json](https://cfn-resource-specifications-af-south-1-prod.s3.af-south-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-af-south-1-prod.s3.af-south-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（香港）  |  `ap-east-1`  |  [.json](https://cfn-resource-specifications-ap-east-1-prod.s3.ap-east-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-east-1-prod.s3.ap-east-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（海得拉巴）  |  `ap-south-2`  |  [.json](https://cfn-resource-specifications-ap-south-2-prod.s3.ap-south-2.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-south-2-prod.s3.ap-south-2.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（雅加达）  |  `ap-southeast-3`  |  [.json](https://cfn-resource-specifications-ap-southeast-3-prod.s3.ap-southeast-3.amazonaws.com/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-southeast-3-prod.s3.ap-southeast-3.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（墨尔本）  |  `ap-southeast-4`  |  [.json](https://cfn-resource-specifications-ap-southeast-4-prod.s3.ap-southeast-4.amazonaws.com/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-southeast-4-prod.s3.ap-southeast-4.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（马来西亚）  |  `ap-southeast-5`  |  [.json](https://cfn-resource-specifications-ap-southeast-5-prod.s3.ap-southeast-5.amazonaws.com/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-southeast-5-prod.s3.ap-southeast-5.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（台北）  |  `ap-east-2`  |  [.json](https://cfn-resource-specifications-ap-east-2-975050364454-prod.s3.ap-east-2.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-east-2-975050364454-prod.s3.ap-east-2.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（泰国）  |  `ap-southeast-7`  |  [.json](https://cfn-resource-specifications-ap-southeast-7-767397843873-prod.s3.ap-southeast-7.amazonaws.com/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ap-southeast-7-767397843873-prod.s3.ap-southeast-7.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（孟买）  |  `ap-south-1`  |  [.json](https://d2senuesg1djtx.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d2senuesg1djtx.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（大阪）  |  `ap-northeast-3`  |  [.json](https://d2zq80gdmjim8k.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d2zq80gdmjim8k.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（首尔）  |  `ap-northeast-2`  |  [.json](https://d1ane3fvebulky.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d1ane3fvebulky.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（新加坡）  |  `ap-southeast-1`  |  [.json](https://doigdx0kgq9el.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://doigdx0kgq9el.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（悉尼）  |  `ap-southeast-2`  |  [.json](https://d2stg8d246z9di.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d2stg8d246z9di.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  亚太地区（东京）  |  `ap-northeast-1`  |  [.json](https://d33vqc0rt9ld30.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d33vqc0rt9ld30.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  加拿大（中部）  |  `ca-central-1`  |  [.json](https://d2s8ygphhesbe7.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d2s8ygphhesbe7.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  加拿大西部（卡尔加里）  |  `ca-west-1`  |  [.json](https://cfn-resource-specifications-ca-west-1-prod.s3.ca-west-1.amazonaws.com/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-ca-west-1-prod.s3.ca-west-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  中国（北京）  |  `cn-north-1`  |  [.json](https://cfn-resource-specifications-cn-north-1-prod---s3---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-cn-north-1-prod---s3---cn-north-1.amazonaws.com.rproxy.govskope.ca.cn/latest/CloudFormationResourceSpecification.zip)  | 
|  中国（宁夏）  |  `cn-northwest-1`  |  [.json](https://cfn-resource-specifications-cn-northwest-1-prod---s3---cn-northwest-1.amazonaws.com.rproxy.govskope.ca.cn/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-cn-northwest-1-prod---s3---cn-northwest-1.amazonaws.com.rproxy.govskope.ca.cn/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（法兰克福）  |  `eu-central-1`  |  [.json](https://d1mta8qj7i28i2.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d1mta8qj7i28i2.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（爱尔兰）  |  `eu-west-1`  |  [.json](https://d3teyb21fexa9r.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d3teyb21fexa9r.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（伦敦）  |  `eu-west-2`  |  [.json](https://d1742qcu2c1ncx.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d1742qcu2c1ncx.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（米兰）  |  `eu-south-1`  |  [.json](https://cfn-resource-specifications-eu-south-1-prod.s3.eu-south-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-eu-south-1-prod.s3.eu-south-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（巴黎）  |  `eu-west-3`  |  [.json](https://d2d0mfegowb3wk.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d2d0mfegowb3wk.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（西班牙）  |  `eu-south-2`  |  [.json](https://cfn-resource-specifications-eu-south-2-prod.s3.eu-south-2.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-eu-south-2-prod.s3.eu-south-2.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲地区（斯德哥尔摩）  |  `eu-north-1`  |  [.json](https://diy8iv58sj6ba.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://diy8iv58sj6ba.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  欧洲（苏黎世）  |  `eu-central-2`  |  [.json](https://cfn-resource-specifications-eu-central-2-prod.s3.eu-central-2.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-eu-central-2-prod.s3.eu-central-2.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  以色列（特拉维夫）  |  `il-central-1`  |  [.json](https://cfn-resource-specifications-il-central-1-prod.s3.il-central-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-il-central-1-prod.s3.il-central-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  中东（巴林）  |  `me-south-1`  |  [.json](https://cfn-resource-specifications-me-south-1-prod.s3.me-south-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-me-south-1-prod.s3.me-south-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  中东（阿联酋）  |  `me-central-1`  |  [.json](https://cfn-resource-specifications-me-central-1-prod.s3.me-central-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-me-central-1-prod.s3.me-central-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  墨西哥（中部）  |  `mx-central-1`  |  [.json](https://cfn-resource-specifications-mx-central-1-590183656522-prod.s3.mx-central-1.amazonaws.com/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://cfn-resource-specifications-mx-central-1-590183656522-prod.s3.mx-central-1.amazonaws.com/latest/CloudFormationResourceSpecification.zip)  | 
|  南美洲（圣保罗）  |  `sa-east-1`  |  [.json](https://d3c9jyj3w509b0.cloudfront.net/latest/gzip/CloudFormationResourceSpecification.json)  |  [.zip](https://d3c9jyj3w509b0.cloudfront.net/latest/CloudFormationResourceSpecification.zip)  | 
|  AWS GovCloud（美国东部）  |  `us-gov-east-1`  |  [.json](https://s3.us-gov-east-1.amazonaws.com/cfn-resource-specifications-us-gov-east-1-prod/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://s3.us-gov-east-1.amazonaws.com/cfn-resource-specifications-us-gov-east-1-prod/latest/CloudFormationResourceSpecification.zip)  | 
|  AWS GovCloud（美国西部）  |  `us-gov-west-1`  |  [.json](https://s3.us-gov-west-1.amazonaws.com/cfn-resource-specifications-us-gov-west-1-prod/latest/CloudFormationResourceSpecification.json)  |  [.zip](https://s3.us-gov-west-1.amazonaws.com/cfn-resource-specifications-us-gov-west-1-prod/latest/CloudFormationResourceSpecification.zip)  | 

以下示例显示 AWS Key Management Service 键资源 (`AWS::KMS::Key`) 的规范。它显示了 `AWS::KMS::Key` 资源的属性、哪些属性是必需的、每个属性允许的值的类型以及属性的更新行为。有关此规范的详细信息，请参阅[规范格式](cfn-resource-specification-format.md)。

```
    "AWS::KMS::Key": {
      "Attributes": {
        "Arn": {
          "PrimitiveType": "String"
        }
      },
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html",
      "Properties": {
        "Description": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-description",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "EnableKeyRotation": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enablekeyrotation",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "Enabled": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-enabled",
          "PrimitiveType": "Boolean",
          "Required": false,
          "UpdateType": "Mutable"
        },
        "KeyPolicy": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keypolicy",
          "PrimitiveType": "Json",
          "Required": true,
          "UpdateType": "Mutable"
        },
        "KeyUsage": {
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-key.html#cfn-kms-key-keyusage",
          "PrimitiveType": "String",
          "Required": false,
          "UpdateType": "Immutable"
        }
      }
    }
```