# CloudFormation 模板 Metadata 语法
<a name="metadata-section-structure"></a>

`Metadata` 使用 JSON 或 YAML 对象存储其他信息。您可以在模板中使用的模板级元数据类型包括：

自定义元数据  
存储用户定义的键值对。例如，您可以提供其他信息，这些信息不影响资源创建，但可以提供有关基础设施、团队或部署细节的其他背景信息。

`AWS::CloudFormation::Interface`  
定义在 CloudFormation 控制台中显示输入参数时的分组和排序。默认情况下，CloudFormation 控制台按照参数的逻辑 ID 的字母顺序排序。

`AWS::CloudFormation::Designer`  
CloudFormation Designer (Designer) 已于 2025 年 2 月 5 日终止使用。



**重要**  
堆栈更新期间，您无法更新 `Metadata` 部分本身。您只能在包括添加、修改或删除资源的更改时更新它。  
CloudFormation 不会转换、修改或编辑您在 `Metadata` 部分中包含的任何信息。因此，我们强烈建议您不要使用此部分存储敏感信息，例如密码或密钥。

## 语法
<a name="metadata-section-structure-syntax"></a>

要在 CloudFormation 模板中声明自定义元数据，请使用以下语法：

### JSON
<a name="metadata-section-structure-syntax.json"></a>

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

### YAML
<a name="metadata-section-structure-syntax.yaml"></a>

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

有关 `AWS::CloudFormation::Interface` 的语法，请参阅 [使用 `AWS::CloudFormation::Interface` 元数据整理 CloudFormation 参数](aws-cloudformation-interface.md)。