Esta es la nueva *Guía de referencia de plantillas de CloudFormation*. Actualice sus marcadores y enlaces. Para obtener ayuda sobre cómo empezar a usar CloudFormation, consulte la [Guía del usuario de AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

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

Puede utilizar el script auxiliar `cfn-get-metadata` para recuperar un bloque de metadatos de CloudFormation e imprimirlo en una salida estándar. También puede imprimir un subárbol del bloque de metadatos si especifica una clave. Sin embargo, solo se admiten las claves de nivel superior.

**Topics**
+ [Sintaxis](#cfn-get-metadata-Syntax)
+ [Opciones](#cfn-get-metadata-options)

## Sintaxis
<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` no requiere credenciales, por lo que no tiene que usar las opciones `--access-key`, `--secret-key`, `--role` ni `--credential-file`. Sin embargo, si no se especifican credenciales, CloudFormation comprueba la pertenencia a la pila y limita el ámbito de la llamada a la pila al que pertenece a la instancia. Para obtener más información, consulte [Permisos para los scripts auxiliares](cfn-helper-scripts-reference.md#cfn-helper-scripts-reference-permissions).

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


| Nombre | Descripción | Obligatorio | 
| --- | --- | --- | 
|   `-k, --key`   |  Para un par clave-valor, devuelve el nombre de la clave para el valor especificado. *Tipo:* cadena *Ejemplo*: En el caso de `{ "Key1": "SampleKey1", "Key2": "SampleKey2" }`, `cfn-get-metadata -k Key2` devuelve `SampleKey2`.  |  No  | 
|   `-s, --stack`   |  Nombre de la pila. *Tipo:* cadena *Valor predeterminado*: Ninguno *Ejemplo*: `-s { "Ref" : "AWS::StackName" },`  |  Sí  | 
|   `-r, --resource`   |  El ID de recurso lógico del recurso que contiene los metadatos. *Tipo:* cadena *Ejemplo*: `-r WebServerHost`  |  Sí  | 
|  `--role` (señalización de recursos solamente)  |  El nombre de un rol de IAM asociado a la instancia. *Tipo:* cadena Condición: El parámetro del archivo de credenciales sustituye a este parámetro.  |  No  | 
|   `--region`   |  La Región de la que se debe obtener la URL de CloudFormation. *Tipo:* cadena *Valor predeterminado*: Ninguno *Ejemplo*: `--region ", { "Ref" : "AWS::Region" },`  |  No  | 
|   `--access-key`   |  Clave de acceso de AWS para una cuenta con permiso para llamar a DescribeStackResource en CloudFormation. *Tipo:* cadena Condición: El parámetro del archivo de credenciales sustituye a este parámetro.  |  Condicional  | 
|   `--secret-key`   |  Clave secreta de AWS que corresponde a la clave de acceso de AWS especificada. *Tipo:* cadena Condición: El parámetro del archivo de credenciales sustituye a este parámetro.  |  Condicional  | 
|   `-f, --credential-file`   |  Un archivo que contiene una clave secreta y una clave de acceso. *Tipo:* cadena Condición: El parámetro del archivo de credenciales sustituye a los parámetros --access-key y --secret-key.  |  Condicional  |