Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich. # CloudFormation MetadataVorlagensyntax `Metadata` speichert zusätzliche Informationen in Form von JSON- oder YAML-Objekten. Zu den Arten von Metadaten auf Vorlagenebene, die Sie in Ihrer Vorlage verwenden können, gehören: Benutzerdefinierte Metadaten Speichert benutzerdefinierte Schlüssel-Werte-Paare. Sie können zum Beispiel zusätzliche Informationen bereitstellen, die sich nicht auf die Erstellung von Ressourcen auswirken, aber zusätzlichen Kontext über die Infrastruktur, das Team oder die Besonderheiten der Bereitstellung bieten. `AWS::CloudFormation::Interface` Definiert die Gruppierung und Reihenfolge von Eingabeparametern, wenn sie in der CloudFormation Konsole angezeigt werden. Standardmäßig sortiert die CloudFormation Konsole Parameter alphabetisch nach ihrer logischen ID. `AWS::CloudFormation::Designer` CloudFormation Designer (Designer) hat am 5. Februar 2025 das Ende seiner Nutzungsdauer erreicht. **Wichtig** Der Abschnitt `Metadata` kann während einer Stack-Aktualisierung nicht allein aktualisiert werden. Sie können ihn nur aktualisieren, wenn Sie Änderungen einschließen, die Ressourcen hinzufügen, ändern oder löschen. CloudFormation transformiert, modifiziert oder redigiert keine Informationen, die Sie in den `Metadata` Abschnitt aufnehmen. Aus diesem Grund wird dringend empfohlen, diesen Abschnitt nicht zu verwenden, um vertrauliche Informationen wie Passwörter oder Secrets zu speichern. ## Syntax Verwenden Sie die folgende Syntax, um benutzerdefinierte Metadaten in Ihrer CloudFormation Vorlage zu deklarieren: ### JSON ``` "Metadata" : { "Instances" : {"Description" : "Information about the instances"}, "Databases" : {"Description" : "Information about the databases"} } ``` ### YAML ``` Metadata: Instances: Description: "Information about the instances" Databases: Description: "Information about the databases" ``` Für die Syntax für `AWS::CloudFormation::Interface`siehe [Organisieren von CloudFormation Parametern mit `AWS::CloudFormation::Interface` Metadaten](aws-cloudformation-interface.md). # Organisieren von CloudFormation Parametern mit `AWS::CloudFormation::Interface` Metadaten `AWS::CloudFormation::Interface`ist ein Metadatenschlüssel, der definiert, wie Parameter in der CloudFormation Konsole gruppiert und sortiert werden. Standardmäßig listet die Konsole Eingabeparameter in alphabetischer Reihenfolge nach ihren logischen IDs auf, wenn Sie Stapel 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önnen beispielsweise alle EC2-bezogenen Parameter in einer Gruppe zusammenfassen und alle VPC-Parameter in einer anderen Gruppe. 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-Aufrufe 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": [ { "Label": { "default": "Group Label" }, "Parameters": [ "Parameter1", "Parameter2" ] } ], "ParameterLabels": { "Parameter1": { "default": "Friendly Name for Parameter1" } } } } ``` ### YAML ``` Metadata: AWS::CloudFormation::Interface: ParameterGroups: - Label: default: Group Label Parameters: - Parameter1 - Parameter2 ParameterLabels: Parameter1: default: Friendly Name for Parameter1 ``` ## 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 `Label` Ein Name für die Parametergruppe. *Required*: No `default` Das Standardlabel, das die CloudFormation Konsole verwendet, um eine Parametergruppe zu benennen. *Required*: No *Typ:* Zeichenfolge `Parameters` Eine Liste von Parametern, bei denen Groß- und Kleinschreibung beachtet wird IDs , die logisch in die Gruppe aufgenommen werden sollen. Parameter müssen bereits im `Parameters`-Abschnitt der Vorlage definiert sein. Ein Parameter kann nur in eine Parametergruppe eingeschlossen werden. In der Konsole werden die Parameter, die nicht mit einer Parametergruppe verknüpft werden, in alphabetischer Reihenfolge in der `Other parameters`-Gruppe aufgeführt. *Required*: No *Typ*: Liste von Zeichenfolgenwerten `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 Parameterbezeichnung Eine Bezeichnung für einen Parameter. Das Label definiert einen benutzerfreundlichen Namen oder eine Beschreibung, die die CloudFormation Konsole auf der Seite „**Parameter angeben**“ anzeigt, wenn ein Stack erstellt oder aktualisiert wird. Die Parameterbezeichnung muss die logische ID eines gültigen Parameters sein, der im Abschnitt `Parameters` der Vorlage deklariert wurde. *Required*: No `default` Das Standardlabel, das die CloudFormation Konsole zur Benennung eines Parameters verwendet. *Required*: No *Typ:* Zeichenfolge ## Beispiel Im folgenden Beispiel werden zwei Parametergruppen definiert: `Network Configuration` und `Amazon EC2 Configuration`. Die `Network Configuration`-Gruppe enthält die Parameter `VPCID``SubnetId` 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** ![\[Konsole mit Parametergruppen für dieses Beispiel.\]](http://docs.aws.amazon.com/de_de/AWSCloudFormation/latest/UserGuide/images/console-create-stack-parameter-groups.png)