Syntaxe Metadata du modèle CloudFormation - AWS CloudFormation
Syntaxe

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Syntaxe Metadata du modèle CloudFormation

Metadata stocke des informations supplémentaires à l’aide d’objets JSON ou YAML. Les types de métadonnées au niveau du modèle que vous pouvez utiliser dans votre modèle sont les suivants :

Métadonnées personnalisées

Stocke des paires clé-valeur définies par l’utilisateur. Par exemple, vous pouvez fournir des informations supplémentaires qui n’ont pas d’incidence sur la création de ressources, mais qui offrent un contexte supplémentaire sur l’infrastructure, l’équipe ou les spécificités du déploiement.

AWS::CloudFormation::Interface

Définit le regroupement et l’ordre des paramètres d’entrée lorsqu’ils s’affichent dans la console CloudFormation. Par défaut, la console CloudFormation trie les paramètres par ordre alphabétique en fonction de leur ID logique.

AWS::CloudFormation::Designer

CloudFormation Designer (Designer) a atteint la fin de sa vie le 5 février 2025.

Important

Pendant une mise à jour de la pile, vous ne pouvez pas mettre à jour la section Metadata. Vous pouvez uniquement la mettre à jour lorsque vous intégrez des changements qui ajoutent, modifient ou suppriment des ressources.

CloudFormation ne transforme pas, ne modifie pas, ne rédige aucune information que vous incluez dans la section Metadata. Nous vous recommandons donc vivement de ne pas utiliser cette section pour stocker des informations sensibles, telles que des mots de passe ou des secrets.

Syntaxe

Pour déclarer des métadonnées personnalisées dans votre modèle CloudFormation, utilisez la syntaxe suivante :

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"

Pour la syntaxe du AWS::CloudFormation::Interface, voir Organisation des CloudFormation paramètres à l'aide de AWS::CloudFormation::Interface métadonnées.