這是新的 *CloudFormation 範本參考指南*。請更新您的書籤和連結。如需 CloudFormation 入門的說明，請參閱 [AWS CloudFormation 使用者指南](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# cfn-get-metadata
<a name="cfn-get-metadata"></a>

您可以使用 `cfn-get-metadata` 協助程式指令碼，從 CloudFormation 擷取中繼資料區塊並將其列印至標準輸出。如果您指定金鑰，也可以列印中繼資料區塊的子樹狀結構。不過，只支援最上層金鑰。

**Topics**
+ [語法](#cfn-get-metadata-Syntax)
+ [選項](#cfn-get-metadata-options)

## 語法
<a name="cfn-get-metadata-Syntax"></a>

```
cfn-get-metadata --access-key {{access.key}} \
                 --secret-key {{secret.key}} \
                 --credential-file|f {{credential.file}} \
                 --key|k {{key}} \
                 --stack|-s {{stack.name.or.id}} \
                 --resource|-r {{logical.resource.id}} \
                 --role {{IAM.role.name}} \
                 --url|-u {{service.url}} \
                 --region {{region}}
```

**注意**  
`cfn-get-metadata` 不需要憑證，因此您不需要使用 `--access-key`、`--secret-key`、`--role` 或 `--credential-file` 選項。不過，如果未指定憑證，CloudFormation 會檢查是否有堆疊成員資格，並將呼叫範圍限制為執行個體所屬的堆疊。如需詳細資訊，請參閱[協助程式指令碼的許可](cfn-helper-scripts-reference.md#cfn-helper-scripts-reference-permissions)。

## 選項
<a name="cfn-get-metadata-options"></a>


| 名稱 | 描述 | 必要 | 
| --- | --- | --- | 
|  `-k, --key`  | 針對鍵/值對，傳回金鑰的名稱作為您指定的值。<br />*類型：*字串<br />*範例*：針對 `{ "Key1": "SampleKey1", "Key2": "SampleKey2" }`，`cfn-get-metadata -k Key2` 會傳回 `SampleKey2`。 | 否 | 
|  `-s, --stack`  | 堆疊的名稱。<br />*類型：*字串<br />*預設*：無<br />*範例*：`-s { "Ref" : "AWS::StackName" },` | 是 | 
|  `-r, --resource`  | 包含中繼資料之資源的邏輯資源 ID。<br />*類型：*字串<br />*範例*：`-r WebServerHost` | 是 | 
| `--role` (僅限發出資源訊號) | 與執行個體相關聯的 IAM 角色名稱。<br />*類型：*字串<br />條件：憑證檔案參數會取代此參數。 | 否 | 
|  `--region`  | 衍生 CloudFormation URL 的來源區域。<br />*類型：*字串<br />*預設*：無<br />*範例*：`--region ", { "Ref" : "AWS::Region" },` | 否 | 
|  `--access-key`  | AWS 具有在 CloudFormation 上呼叫 DescribeStackResource 許可之帳戶的存取金鑰。<br />*類型：*字串<br />條件：憑證檔案參數會取代此參數。 | 有條件 | 
|  `--secret-key`  | AWS 對應至指定 AWS 存取金鑰的私密金鑰。<br />*類型：*字串<br />條件：憑證檔案參數會取代此參數。 | 有條件 | 
|  `-f, --credential-file`  | 包含私密金鑰和存取金鑰的檔案。<br />*類型：*字串<br />條件：憑證檔案參數會取代 --access-key 和 --secret-key 參數。 | 有條件 |