Este é o novo *Guia de referência de modelos do CloudFormation*. Atualize seus favoritos e links. Para obter ajuda para começar a usar o CloudFormation, consulte o [Guia do usuário do AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

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

Você pode usar o script auxiliar `cfn-get-metadata` para buscar um bloco de metadados do CloudFormation e imprimi-lo na saída padrão. Você também pode imprimir uma subárvore do bloco de metadados se você especificar uma chave. No entanto, somente as chaves de nível superior são suportadas.

**Topics**
+ [Sintaxe](#cfn-get-metadata-Syntax)
+ [Opções](#cfn-get-metadata-options)

## Sintaxe
<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}}
```

**nota**  
`cfn-get-metadata` não exige credenciais; portanto, você não precisa usar as opções `--access-key`, `--secret-key`, `--role` ou `--credential-file`. No entanto, se nenhuma credencial for especificada, o CloudFormation verificará se há associação de pilha e limitará o escopo da chamada para a pilha à qual a instância pertence. Para obter mais informações, consulte [Permissões para scripts auxiliares](cfn-helper-scripts-reference.md#cfn-helper-scripts-reference-permissions).

## Opções
<a name="cfn-get-metadata-options"></a>


| Nome | Descrição | Obrigatório | 
| --- | --- | --- | 
|  `-k, --key`  | Para um par chave/valor, retorne o nome da chave para o valor que você especificou.<br />*Tipo:* string<br />*Exemplo*: para `{ "Key1": "SampleKey1", "Key2": "SampleKey2" }`, `cfn-get-metadata -k Key2` retorna `SampleKey2`. | Não | 
|  `-s, --stack`  | O nome da pilha.<br />*Tipo:* string<br />*Padrão*: nenhum<br />*Exemplo*: `-s { "Ref" : "AWS::StackName" },` | Sim | 
|  `-r, --resource`  | O ID de recursos lógicos do recurso que contém os metadados.<br />*Tipo:* string<br />*Exemplo*: `-r WebServerHost` | Sim | 
| `--role` (apenas sinalização de recursos) | O nome de um perfil do IAM que está associado à instância.<br />*Tipo:* string<br />Condição: o parâmetro do arquivo de credencial substitui este parâmetro. | Não | 
|  `--region`  | A região para derivar o URL do CloudFormation.<br />*Tipo:* string<br />*Padrão*: nenhum<br />*Exemplo*: `--region ", { "Ref" : "AWS::Region" },` | Não | 
|  `--access-key`  | A chave de acesso da AWS para uma conta com permissão para chamar DescribeStackResource no CloudFormation.<br />*Tipo:* string<br />Condição: o parâmetro do arquivo de credencial substitui este parâmetro. | Condicional | 
|  `--secret-key`  | A chave secreta da AWS que corresponde à chave de acesso específica da AWS.<br />*Tipo:* string<br />Condição: o parâmetro do arquivo de credencial substitui este parâmetro. | Condicional | 
|  `-f, --credential-file`  | Um arquivo que contém uma chave secreta e uma chave de acesso.<br />*Tipo:* string<br />Condição: O parâmetro do arquivo de credencial substitui os parâmetros --access-key e --secret-key. | Condicional |