これは新しい 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`   |  キーと値のペアの場合は、指定した値のキーの名前が返されます。 タイプ: 文字列 例: `{ "Key1": "SampleKey1", "Key2": "SampleKey2" }` では、`cfn-get-metadata -k Key2` は `SampleKey2` を返します。  |  いいえ  | 
|   `-s, --stack`   |  スタックの名前です。 タイプ: 文字列 *デフォルト*: なし 例: `-s { "Ref" : "AWS::StackName" },`  |  はい  | 
|   `-r, --resource`   |  メタデータを含むリソースの論理リソース ID です。 タイプ: 文字列 例: `-r WebServerHost`  |  はい  | 
|  `--role` (リソースシグナル送信のみ)  |  インスタンスに関連付けられた IAM ロールの名前です。 タイプ: 文字列 条件: 認証情報ファイルパラメーターは、このパラメーターより優先されます。  |  いいえ  | 
|   `--region`   |  CloudFormation URL の生成元となるリージョンです。 タイプ: 文字列 *デフォルト*: なし 例: `--region ", { "Ref" : "AWS::Region" },`  |  いいえ  | 
|   `--access-key`   |  CloudFormation の DescribeStackResource を呼び出す許可が付与されたアカウントの AWS アクセスキー。 タイプ: 文字列 条件: 認証情報ファイルパラメーターは、このパラメーターより優先されます。  |  条件付き  | 
|   `--secret-key`   |  指定した AWS アクセスキーに対応する AWS シークレットキーです。 タイプ: 文字列 条件: 認証情報ファイルパラメーターは、このパラメーターより優先されます。  |  条件付き  | 
|   `-f, --credential-file`   |  シークレットキーとアクセスキーの両方を含むファイルです。 タイプ: 文字列 条件: 認証情報ファイルパラメーターは、--access-key および --secret-key パラメーターよりも優先されます。  |  条件付き  |