AWS CloudFormation
用户指南 (API 版本 2010-05-15)

AWS CloudFormation 资源规范

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

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

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

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

资源规范

区域名称

区域

单个文件

所有文件

亚太地区(香港)

ap-east-1

.json

.zip

亚太地区(孟买)

ap-south-1

.json

.zip

亚太区域 (大阪当地)

ap-northeast-3

.json

.zip

亚太区域(首尔)

ap-northeast-2

.json

.zip

亚太区域(新加坡)

ap-southeast-1

.json

.zip

亚太区域(悉尼)

ap-southeast-2

.json

.zip

亚太区域(东京)

ap-northeast-1

.json

.zip

加拿大 (中部)

ca-central-1

.json

.zip

中国(北京)

cn-north-1

.json

.zip

中国 (宁夏)

cn-northwest-1

.json

.zip

欧洲(法兰克福)

eu-central-1

.json

.zip

欧洲(爱尔兰)

eu-west-1

.json

.zip

欧洲 (伦敦)

eu-west-2

.json

.zip

欧洲 (巴黎)

eu-west-3

.json

.zip

欧洲(斯德哥尔摩)

eu-north-1

.json

.zip

AWS GovCloud(美国东部)

us-gov-east-1

.json

.zip

AWS GovCloud (US-West)

us-gov-west-1

.json

.zip

中东(巴林)

me-south-1

.json

.zip

南美洲(圣保罗)

sa-east-1

.json

.zip

美国东部(弗吉尼亚北部)

us-east-1

.json

.zip

美国东部(俄亥俄州)

us-east-2

.json

.zip

美国西部(加利福尼亚北部)

us-west-1

.json

.zip

美国西部(俄勒冈)

us-west-2

.json

.zip

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

"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" } } }