AWS::CloudFormation::Interface

AWS::CloudFormation::Interfaceè una chiave di metadati che definisce il modo in cui i parametri vengono raggruppati e ordinati nella console. AWS CloudFormation Quando si utilizza o si aggiornano gli stack nella console, questa elenca i parametri di input in ordine alfabetico in base ai relativi ID logici. Utilizzando questa chiave, è possibile definire il raggruppamento e l'ordine dei parametri in modo che gli utenti possano specificare i valori dei parametri in modo efficace. Ad esempio, è possibile raggruppare tutti i parametri relativi a EC2 in un gruppo e tutti i parametri relativi a VPC in un altro gruppo.

Oltre a raggruppare e ordinare i parametri, è possibile definire le etichette per i parametri. Un'etichetta è un nome semplice o una descrizione che la console visualizza invece di visualizzare un ID logico del parametro. Le etichette sono utili per aiutare gli utenti a comprendere i valori da specificare per ciascun parametro. Ad esempio, è possibile creare un'etichetta per un parametro KeyPair Select an EC2 key pair.

Sintassi

Per dichiarare questa entità nel tuo CloudFormation modello, usa la seguente sintassi:

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

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

Proprietà

Esempio

L'esempio seguente definisce due gruppi di parametri: Network Configuration e Amazon EC2 Configuration. Il gruppo Network Configuration include i parametri VPCID, SubnetId e SecurityGroupID, che sono definiti nella sezione Parameters del modello (non mostrato). L'ordine in cui la console mostra questi parametri viene definito dall'ordine in cui i parametri sono elencati, a partire dal parametro VPCID. L'esempio analogamente raggruppa e ordina i parametri Amazon EC2 Configuration.

L'esempio definisce anche un'etichetta per il parametro VPCID. La console mostrerà Which VPC should this be deployed to? (In quali VPC deve essere distribuito?) anziché l'ID logico del parametro (VPCID).

"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?" }
    }
  }
}

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?"

Gruppi di parametri nella console

Utilizzando la chiave di metadati di questo esempio, la figura riportata di seguito mostra il modo in cui la console visualizza i gruppi di parametri al momento della creazione o dell'aggiornamento di uno stack: i gruppi di parametri nella console