AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS Documentation » AWS CloudFormation » User Guide » Working with AWS CloudFormation Templates » Template Anatomy » Template Description Declaration
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Template Description Declaration

An optional template description section is the second section in a AWS CloudFormation template.

The template Description section is optional. When it is present, it must follow the AWSTemplateFormatVersion section.

The template Description enables you to provide arbitrary comments about your template. It is a literal JSON string that is between 0 and 1024 bytes in length; its value cannot be based on a parameter or function. The Description declaration is written as a key/value pair, as shown:

"Description" : "Contains an autoscaling group and a load balancer.",
Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...