AWS::CloudFormation::Interface

AWS::CloudFormation::Interfaceist ein Metadatenschlüssel, der definiert, wie Parameter in der AWS CloudFormation Konsole gruppiert und sortiert werden. Standardmäßig listet die Konsole Eingabeparameter in alphabetischer Reihenfolge nach ihrer logischen Reihenfolge auf, IDs wenn Sie Stacks in der Konsole erstellen oder aktualisieren. Mit diesem Schlüssel können Sie Ihre eigenen Parameter zum Gruppieren und Sortieren definieren, damit Benutzer effizient Parameterwerte angeben können. Sie könnten beispielsweise alle verwandten Parameter in einer Gruppe und alle EC2 VPC verwandten Parameter in einer anderen Gruppe gruppieren.

Im Metadatenschlüssel können Sie angeben, welche Gruppen erstellt werden sollen, welche Parameter in die jeweiligen Gruppen eingeschlossen werden sollen und in welcher Reihenfolge die Parameter innerhalb der einzelnen Gruppen in der Konsole angezeigt werden sollen.

Sie können auch Beschriftungen für Parameter definieren. Eine Bezeichnung ist ein Anzeigename oder eine Beschreibung, den die Konsole anstelle der logischen Parameter-ID anzeigt. Anhand von Bezeichnungen können Benutzer die Werte, die für Parameter angegeben werden, einfacher verstehen. Sie können z. B. einen KeyPair-Parameter mit Select an EC2 key pair bezeichnen.

Alle Parameter, die Sie im Metadatenschlüssel referenzieren, müssen im Abschnitt Parameters der Vorlage deklariert sein.

Anmerkung

Nur die CloudFormation Konsole verwendet den AWS::CloudFormation::Interface Metadatenschlüssel. AWS CLI und API Anrufe verwenden diesen Schlüssel nicht.

Syntax

Verwenden Sie die folgende Syntax, um diese Entität in Ihrer CloudFormation Vorlage zu deklarieren:

JSON

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

YAML

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

Eigenschaften

ParameterGroups

Eine Liste der Parameter-Gruppentypen, für die Sie Gruppennamen, die Parameter in jeder Gruppe und die Reihenfolge, in der die Parameter angezeigt werden, angeben.

Required: No

Typ: AWS::CloudFormation::Interface ParameterGroup

Aktualisierung erfordert: Keine Unterbrechung

ParameterLabels

Eine Zuordnung von Parametern und ihren benutzerfreundlichen Namen, die in der CloudFormation Konsole angezeigt wird, wenn ein Stack erstellt oder aktualisiert wird.

Required: No

Typ: AWS::CloudFormation::Interface ParameterLabel

Aktualisierung erfordert: Keine Unterbrechung

Beispiel

Im folgenden Beispiel werden zwei Parametergruppen definiert: Network Configuration und Amazon EC2 Configuration. Die Network Configuration-Gruppe enthält die Parameter VPCIDSubnetId und SecurityGroupID, die im Bereich Parameters der Vorlage (nicht dargestellt) definiert werden. Die Reihenfolge, in der die Konsole diese Parameter anzeigt, wird durch die Reihenfolge bestimmt, in der die Parameter beginnend mit dem VPCID-Parameter aufgeführt sind. Im Beispiel werden die Amazon EC2 Configuration-Parameter auf ähnliche Weise gruppiert und sortiert.

Außerdem wird eine Bezeichnung für den VPCID-Parameter definiert. In der Konsole wird angezeigt, für wen das bereitgestellt werden VPC soll? statt der logischen ID (VPCID) des Parameters.

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

Parametergruppen in der Konsole

In der folgenden Abbildung wird dargestellt, wie die Konsole die Parametergruppen unter Verwendung des Metadatenschlüssels anzeigt, wenn ein Stack erstellt oder aktualisiert wird: Parametergruppen in der Konsole