AWS::CloudFormation::Interface

AWS::CloudFormation::Interface es una clave de metadatos que define cómo se agrupan y ordenan los parámetros en la consola de AWS CloudFormation. 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.

Además de agrupar y ordenar los parámetros, puede definir etiquetas para 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.

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

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

JSON

"Metadata" : {
  "AWS::CloudFormation::Interface" : {
    "ParameterGroups" : [ ParameterGroup, ... ],
    "ParameterLabels" : ParameterLabel
  }
}

YAML

Metadata:
  AWS::CloudFormation::Interface:
    ParameterGroups:
      - ParameterGroup
    ParameterLabels:
      ParameterLabel

Propiedades

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

Tipo: AWS::CloudFormation::Interface ParameterGroup

Requisitos de actualización: sin interrupción

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

Tipo: AWS::CloudFormation::Interface ParameterLabel

Requisitos de actualización: sin interrupción

Ejemplo

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

"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

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

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