AWS::CloudFormation::Interface

AWS::CloudFormation::Interface ist ein Metadatenschlüssel, der definiert, wie Parameter in der AWS CloudFormation-Konsole gruppiert und sortiert werden. Wenn Sie über die Konsole Stacks erstellen oder aktualisieren, werden die Eingabeparameter in der Konsole alphabetisch basierend auf ihrer logischen ID aufgelistet. Mit diesem Schlüssel können Sie Ihre eigenen Parameter zum Gruppieren und Sortieren definieren, damit Benutzer effizient Parameterwerte angeben können. Sie können beispielsweise alle EC2-bezogenen Parameter in einer Gruppe zusammenfassen und alle VPC-Parameter in einer anderen Gruppe.

Zusätzlich zum Gruppieren und Sortieren von Parametern können Sie Bezeichnungen 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.

Anmerkung

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

Syntax

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

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 Anzeigenamen, die die CloudFormation Konsole anzeigt, 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. Die Konsole zeigt Welchen VPCs sollten diese bereitgestellt werden? statt der logischen ID des Parameters (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?"

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