AWS AWSCloudFormation documentation change
Summary
Restructured metadata documentation, removed deprecated sections (e.g., AWS::CloudFormation::Init), added Designer end-of-life note, and added PDF link.
Security assessment
Changes focus on documentation clarity and removing outdated content. No security vulnerabilities or security feature updates are addressed.
Diff
diff --git a/AWSCloudFormation/latest/UserGuide/metadata-section-structure.md b/AWSCloudFormation/latest/UserGuide/metadata-section-structure.md index 9d31bdf8c..2f8df92d4 100644 --- a//AWSCloudFormation/latest/UserGuide/metadata-section-structure.md +++ b//AWSCloudFormation/latest/UserGuide/metadata-section-structure.md @@ -0,0 +1,2 @@ +[](/pdfs/AWSCloudFormation/latest/UserGuide/cfn-ug.pdf#metadata-section-structure "Open PDF") + @@ -3 +5 @@ -JSONYAMLMetadata keys +Syntax @@ -7 +9 @@ JSONYAMLMetadata keys -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: +`Metadata` stores additional information using JSON or YAML objects. The types of template-level metadata you can use in your template include: @@ -9 +11 @@ You can use the optional `Metadata` section to include arbitrary JSON or YAML ob -###### Important +Custom metadata @@ -11 +13,12 @@ You can use the optional `Metadata` section to include arbitrary JSON or YAML ob -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. + +Stores user-defined key-value pairs. For example, you can provide additional information that doesn't impact resource creation but offers additional context about the infrastructure, team, or deployment specifics. + +`AWS::CloudFormation::Interface` + + +Defines the grouping and ordering of input parameters when they're displayed in the CloudFormation console. By default, the CloudFormation console alphabetically sorts parameters by their logical ID. + +`AWS::CloudFormation::Designer` + + +AWS CloudFormation Designer (Designer) reached end of life on February 5, 2025. @@ -14,0 +28,2 @@ During a stack update, you cannot update the `Metadata` section by itself. You c +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. + @@ -17 +32,5 @@ CloudFormation does not transform, modify, or redact any information you include -## JSON +## Syntax + +To declare custom metadata in your CloudFormation template, use the following syntax: + +### JSON @@ -25 +44 @@ CloudFormation does not transform, modify, or redact any information you include -## YAML +### YAML @@ -34,18 +53 @@ CloudFormation does not transform, modify, or redact any information you include -## Metadata keys - -Some CloudFormation features retrieve settings or configuration information that you define in the `Metadata` section. You define this information in the following CloudFormation-specific metadata keys: - -`AWS::CloudFormation::Init` - - -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](./aws-resource-init.html). - -`AWS::CloudFormation::Interface` - - -Defines the grouping and ordering of input parameters when they are displayed in the CloudFormation console. By default, the CloudFormation console alphabetically sorts parameters by their logical ID. For more information, see [AWS::CloudFormation::Interface](./aws-resource-cloudformation-interface.html). - -`AWS::CloudFormation::Designer` - - -AWS CloudFormation Designer (Designer) reached end of life on February 5, 2025. +For the syntax for the `AWS::CloudFormation::Interface`, see [Organizing CloudFormation parameters with AWS::CloudFormation::Interface metadata](./aws-cloudformation-interface.html). @@ -61 +63 @@ Mappings -AWS::CloudFormation::Authentication +AWS::CloudFormation::Interface