

# CloudFormation 模板 Description 语法
<a name="template-description-structure"></a>

`Description` 部分（可选）可用来包含描述模板的文本字符串。此部分必须始终紧随模板格式版本部分之后。

描述声明的值必须是长度介于 0 和 1024 个字节之间的文字字符串。您无法使用参数或函数来指定描述。以下代码段是描述声明的示例：

**重要**  
堆栈更新期间，您无法更新 `Description` 部分本身。您只能在包括添加、修改或删除资源的更改时更新它。

## JSON
<a name="template-description-structure-example.json"></a>

```
"Description" : "Here are some details about the template."
```

## YAML
<a name="template-description-structure-example.yaml"></a>

```
Description: > Here are some details about the template.
```