

这是新的《Amazon CloudFormation 模板参考指南》**。请更新您的书签和链接。有关开始使用 CloudFormation 的帮助，请参阅《Amazon CloudFormation 用户指南》[https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html)。

# `Metadata` 属性
<a name="aws-attribute-metadata"></a>

`Metadata` 属性能够将结构化数据与资源相关联。通过向资源添加 `Metadata` 属性，您可以将 JSON 或 YAML 格式的数据添加到资源声明中。此外，您还可以在 `Metadata` 属性中使用内置函数（如 [`Fn::GetAtt`](intrinsic-function-reference-getatt.md) 和 [`Ref`](intrinsic-function-reference-ref.md)）、参数和伪参数以添加这些解释值。

**注意**  
Amazon CloudFormation 不会验证元数据属性中的语法。

**重要**  
CloudFormation 不会对包含在元数据属性中的任何信息进行编辑或模糊处理。我们强烈建议您不要使用此部分存储敏感信息，例如密码或密钥。

您可以使用 [describe-stack-resource](https://docs.amazonaws.cn/cli/latest/reference/cloudformation/describe-stack-resource.html) CLI 命令或 [DescribeStackResource](https://docs.amazonaws.cn/AWSCloudFormation/latest/APIReference/API_DescribeStackResource.html) API 操作来检索此数据。

## 示例
<a name="aws-attribute-metadata-example"></a>

以下模板包含一个具有 `Metadata` 属性的 Amazon S3 存储桶字段。

### JSON
<a name="aws-attribute-metadata-example.json"></a>

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

### YAML
<a name="aws-attribute-metadata-example.yaml"></a>

```
1. AWSTemplateFormatVersion: '2010-09-09'
2. Resources:
3.   MyBucket:
4.     Type: AWS::S3::Bucket
5.     Metadata:
6.       Object1: Location1
7.       Object2: Location2
```