View a markdown version of this page

Validez les modèles avec cfn-lint - AWS CloudFormation

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.

Validez les modèles avec cfn-lint

Le CloudFormation Linter (cfn-lint) vérifie les modèles JSON et YAML par rapport aux schémas CloudFormation des fournisseurs de ressources et aux règles supplémentaires. Il peut détecter les propriétés de ressource non valides, les valeurs non prises en charge et les problèmes courants avant que vous n'envoyiez un modèle à CloudFormation.

Le code source, les notes de version, les paramètres et la liste complète des règles sont disponibles dans le référentiel cfn-lint sur. GitHub

Installer cfn-lint

Installation cfn-lint à partir de l'index des packages Python (PyPI) :

python3 -m pip install cfn-lint

SurmacOS, vous pouvez plutôt l'installer avec Homebrew :

brew install cfn-lint

Pour connaître les versions de Python prises en charge et les autres méthodes d'installation, consultez les instructions d'installation sur GitHub.

Exécutez cfn-lint

Transmettez un ou plusieurs chemins de modèle à la commande :

cfn-lint template.yaml cfn-lint template-one.yaml template-two.json

Pour vérifier plusieurs modèles Région AWS, utilisez l'--regionsoption suivante :

cfn-lint --regions us-east-1 us-west-2 -- template.yaml

La commande renvoie un code de sortie différent de zéro lorsqu'elle détecte des problèmes. Vous pouvez utiliser ce comportement pour arrêter une génération automatique lorsqu'un modèle ne passe pas les tests que vous avez sélectionnés.

Configurer les contrôles

Utilisez un .cfnlintrc.yml fichier .cfnlintrc.cfnlintrc.yaml, ou pour conserver les paramètres du projet dans vos modèles. Vous pouvez utiliser ce fichier pour sélectionner des modèles, inclure ou ignorer des contrôles Régions AWS, choisir et configurer le comportement des règles. Pour tous les paramètres, voir le fichier de configuration dans la documentation du projet sur GitHub.

Ajoutez cfn-lint à votre flux de travail

Vous pouvez exécuter cfn-lint à partir d'éditeurs pris en charge, automatiquement avant un commit Git, ou dans le cadre d'une compilation automatique. Le serveur de CloudFormation langue permet également cfn-lint de signaler les problèmes pendant que vous tapez. Pour la configuration du serveur linguistique, consultezCloudFormation Serveur de langue.

Pour les plugins d'éditeur, GitHub les actions, la configuration préalable à la validation, les règles personnalisées et d'autres exemples, consultez la documentation du projet cfn-lint sur. GitHub