这是新的《CloudFormation 模板参考指南》**。请更新您的书签和链接。有关开始使用 CloudFormation 的帮助，请参阅《AWS CloudFormation 用户指南》[https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html](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`  | 针对有权对 CloudFormation 调用 DescribeStackResource 的账户的 AWS 访问密钥。<br />*类型*：字符串<br />条件：凭证文件参数替代该参数。 | 条件 | 
|  `--secret-key`  | AWS 密钥对应于指定的 AWS 访问密钥。<br />*类型*：字符串<br />条件：凭证文件参数替代该参数。 | 条件 | 
|  `-f, --credential-file`  | 同时包含密钥和访问密钥的文件。<br />*类型*：字符串<br />条件：凭证文件参数替代 --access-key 和 --secret-key 参数。 | 条件 |