CloudFormation Vorlage Metadata-Syntax - AWS CloudFormation
Syntax

CloudFormation Vorlage Metadata-Syntax

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

Legt die Gruppierung und Reihenfolge der Eingabeparameter fest, wenn sie in der CloudFormation-Konsole angezeigt werden. Standardmäßig sortiert die CloudFormation-Konsole die Parameter alphabetisch nach ihrer logischen ID.

AWS::CloudFormation::Designer

CloudFormation Designer (Designer) erreichte das Ende seiner Lebensdauer am 5. Februar 2025.

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, ändert oder überarbeitet keine Informationen, die Sie im Metadata-Abschnitt einfügen. Aus diesem Grund wird dringend empfohlen, diesen Abschnitt nicht zu verwenden, um vertrauliche Informationen wie Passwörter oder Secrets zu speichern.

Syntax

Um benutzerdefinierte Metadaten in Ihrer CloudFormation-Vorlage zu deklarieren, verwenden Sie die folgende Syntax:

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::Interfacesiehe Organisieren von CloudFormation-Parametern mit AWS::CloudFormation::Interface-Metadaten.