這是新的 *CloudFormation 範本參考指南*。請更新您的書籤和連結。如需 CloudFormation 入門的說明，請參閱 [AWS CloudFormation 使用者指南](https://docs.aws.amazon.com/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))、參數和虛擬參數，以新增那些直譯值。

**注意**  
CloudFormation 不會驗證中繼資料屬性中的語法。

**重要**  
CloudFormation 不會對您在中繼資料屬性中包含的任何資訊進行修改或混淆。我們強烈建議您不要使用此區段來儲存機密資訊，例如密碼或秘密。

可以透過使用 [describe-stack-resource](https://docs.aws.amazon.com/cli/latest/reference/cloudformation/describe-stack-resource.html) CLI 命令或 [DescribeStackResource](https://docs.aws.amazon.com/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
```