Metadata attribute - AWS CloudFormation

Metadata attribute

The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata attribute to a resource, you can add data in JSON or YAML to the resource declaration. In addition, you can use intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute to add those interpreted values.

Note

AWS CloudFormation does not validate the syntax within the Metadata attribute.

Important

CloudFormation does not redact or obfuscate any information you include in the Metadata attribute. We strongly recommend you do not use this section to store sensitive information, such as passwords or secrets.

You can retrieve this data using the AWS command aws cloudformation describe-stack-resource or the DescribeStackResource action.

Example

The following template contains an Amazon S3 bucket resource with a Metadata attribute.

JSON

{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "MyS3Bucket" : { "Type" : "AWS::S3::Bucket", "Metadata" : { "Object1" : "Location1", "Object2" : "Location2" } } } }

YAML

AWSTemplateFormatVersion: '2010-09-09' Resources: MyS3Bucket: Type: AWS::S3::Bucket Metadata: Object1: Location1 Object2: Location2