

# Organización de los parámetros de CloudFormation con metadatos `AWS::CloudFormation::Interface`
<a name="aws-cloudformation-interface"></a>

`AWS::CloudFormation::Interface` es una clave de metadatos que define cómo se agrupan y ordenan los parámetros en la consola de CloudFormation. De forma predeterminada, cuando crea o actualiza pilas en la consola, la consola muestra parámetros de entrada en orden alfabético por su ID lógico. Al utilizar esta clave, puede definir su propia agrupación y orden de parámetros para que los usuarios puedan especificar los valores de los parámetros de manera eficiente. Por ejemplo, puede agrupar todos los parámetros relacionados con EC2 en un grupo y todos los parámetros relacionados con la VPC en otro grupo.

En la clave de metadatos, puede especificar los grupos que desea crear, los parámetros que desea incluir en cada grupo y el orden en el que la consola muestra cada parámetro dentro de su grupo. 

También puede definir etiquetas para los parámetros. Una etiqueta es una descripción o nombre fáciles de recordar que muestra la consola en lugar de un ID lógico del parámetro. Las etiquetas son útiles para ayudar a los usuarios a entender los valores que se deben especificar para cada parámetro. Por ejemplo, puede etiquetar un parámetro `KeyPair` `Select an EC2 key pair`.

Todos los parámetros a los que se hace referencia en la clave de metadatos deben declararse en la sección `Parameters` de la plantilla.

**nota**  
Solo la consola de CloudFormation utiliza la clave de metadatos `AWS::CloudFormation::Interface`. AWS CLI y llamadas a la API no utilizan esta clave.

## Sintaxis
<a name="aws-resource-cloudformation-interface-syntax"></a>

Para declarar esta entidad en su plantilla de CloudFormation, use la siguiente sintaxis:

### JSON
<a name="aws-resource-cloudformation-interface-syntax.json"></a>

```
"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups": [
      {
        "Label": {
          "default": "Group Label"
        },
        "Parameters": [
          "Parameter1",
          "Parameter2"
        ]
      }
    ],
    "ParameterLabels": {
      "Parameter1": {
        "default": "Friendly Name for Parameter1"
      }
    }
  }
}
```

### YAML
<a name="aws-resource-cloudformation-interface-syntax.yaml"></a>

```
Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - Label:
          default: Group Label
        Parameters:
          - Parameter1
          - Parameter2
    ParameterLabels:
      Parameter1:
        default: Friendly Name for Parameter1
```

## Propiedades
<a name="w2aac11c23c29c17c17"></a>

`ParameterGroups`  
Una lista de tipos de grupos de parámetros, donde debe especificar los nombres de los grupos, los parámetros de cada grupo y el orden en el que se muestran los parámetros.  
*Obligatorio:* no    
`Label`  
Un nombre para el grupo de parámetros.  
*Obligatorio*: no  
`default`  
La etiqueta predeterminada que la consola CloudFormation utiliza para denominar un grupo de parámetro.  
*Obligatorio:* no  
*Tipo:* cadena  
`Parameters`  
Una lista de IDs lógicos de parámetros sensibles a mayúsculas y minúsculas que se incluirán en el grupo. Los parámetros ya deben estar definidos en la sección `Parameters` de la plantilla. Se puede incluir un parámetro en un único grupo de parámetros.  
La consola muestra los parámetros que no asocia a un grupo de parámetros por orden alfabético en el grupo `Other parameters`.  
*Obligatorio*: no  
*Tipo*: lista de valores de cadena

`ParameterLabels`  
Una asignación de parámetros y sus nombres fáciles de recordar que muestra la consola de CloudFormation cuando se crea o actualiza una pila.  
*Obligatorio*: no    
Etiqueta de parámetro  
Una etiqueta para un parámetro. La etiqueta define una descripción o un nombre fácil de recordar que la consola de CloudFormation muestra en la página **Specify Parameters (Especificar parámetros)** cuando se crea o actualiza una pila. La etiqueta de parámetro debe ser el ID lógico que distingue entre mayúsculas y minúsculas de un parámetro válido declarado en la sección `Parameters` de la plantilla.  
*Obligatorio*: no  
`default`  
La etiqueta predeterminada que la consola de CloudFormation utiliza para denominar un parámetro.  
*Obligatorio*: no  
*Tipo:* cadena

## Ejemplo
<a name="w2aac11c23c29c17c19"></a>

El siguiente ejemplo define dos grupos de parámetros: `Network Configuration` y `Amazon EC2 Configuration`. El grupo `Network Configuration` incluye los parámetros `VPCID`, `SubnetId` y `SecurityGroupID` que se definen en la sección `Parameters` de la plantilla (no se muestra). El orden en el que la consola muestra estos parámetros se define por el orden en el que se enumeran los parámetros, empezando por el parámetro `VPCID`. El ejemplo agrupa y ordena de manera parecida los parámetros `Amazon EC2 Configuration`.

El ejemplo también define una etiqueta para el parámetro `VPCID`. La consola mostrará **Which VPC should this be deployed to? (¿En qué VPC debe implementarse esto?)** en lugar del ID lógico del parámetro (`VPCID`).

### JSON
<a name="aws-cloudformation-interface-example.json"></a>

```
"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups" : [
      {
        "Label" : { "default" : "Network Configuration" },
        "Parameters" : [ "VPCID", "SubnetId", "SecurityGroupID" ]
      },
      {
        "Label" : { "default":"Amazon EC2 Configuration" },
        "Parameters" : [ "InstanceType", "KeyName" ]
      }
    ],
    "ParameterLabels" : {
      "VPCID" : { "default" : "Which VPC should this be deployed to?" }
    }
  }
}
```

### YAML
<a name="aws-cloudformation-interface-example.yaml"></a>

```
Metadata: 
  AWS::CloudFormation::Interface: 
    ParameterGroups: 
      - Label: 
          default: "Network Configuration"
        Parameters: 
          - VPCID
          - SubnetId
          - SecurityGroupID
      - Label: 
          default: "Amazon EC2 Configuration"
        Parameters: 
          - InstanceType
          - KeyName
    ParameterLabels: 
      VPCID: 
        default: "Which VPC should this be deployed to?"
```

### Grupos de parámetros en la consola
<a name="w2aac11c23c29c17c19c11"></a>

Con la clave de metadatos de este ejemplo, el siguiente gráfico ilustra cómo muestra la consola grupos de parámetros cuando se crea o actualiza una pila: **Grupos de parámetros en la consola** 

![\[La consola muestra los grupos de parámetros para este ejemplo.\]](http://docs.aws.amazon.com/es_es/AWSCloudFormation/latest/UserGuide/images/console-create-stack-parameter-groups.png)
