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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


You can use the optional Metadata section to include arbitrary JSON or YAML objects that provide details about the template. For example, you can include template implementation details about specific resources, as shown in the following snippet:


During a stack update, you cannot update the Metadata section by itself. You can update it only when you include changes that add, modify, or delete resources.


"Metadata" : { "Instances" : {"Description" : "Information about the instances"}, "Databases" : {"Description" : "Information about the databases"} }


Metadata: Instances: Description: "Information about the instances" Databases: Description: "Information about the databases"

Metadata Keys

Some AWS CloudFormation features retrieve settings or configuration information that you define in the Metadata section. You define this information in the following AWS CloudFormation-specific metadata keys:


Defines configuration tasks for the cfn-init helper script. This script is useful for configuring and installing applications on EC2 instances. For more information, see AWS::CloudFormation::Init.


Defines the grouping and ordering of input parameters when they are displayed in the AWS CloudFormation console. By default, the AWS CloudFormation console alphabetically sorts parameters by their logical ID. For more information, see AWS::CloudFormation::Interface.


Describes how your resources are laid out in AWS CloudFormation Designer (Designer). Designer automatically adds this information when you use it create and update templates. For more information, see What Is AWS CloudFormation Designer?.

On this page: