Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS CloudFormation Resource Specification

The AWS CloudFormation resource specification is a JSON-formatted text file that defines the resources and properties that AWS CloudFormation supports. The document is a machine-readable, strongly typed specification that you can use to build tools for creating AWS CloudFormation templates. For example, you can use the specification to build auto completion and validation functionality for AWS CloudFormation templates in your IDE (integrated development environment).

The resource specification is organized as both a single file and as a series of files, where each file contains the definition of one resource type. The single and separated files contain identical information. Depending on the tool and your implementation, use the file or files that work for you.

To download the resource specification, see the following table. Currently, the specifications are identical for every region, except for US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland) Region. These regions contain a resource specification for AWS CodeCommit.

Resource Specification

The following example shows the specification for an AWS Key Management Service key resource (AWS::KMS::Key). It shows the properties for the AWS::KMS::Key resource, which properties are required, the type of allowed value for each property, and their update behavior. For details about the specification, see Specification Format.

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