View a markdown version of this page

Vorlagen mit cfn-lint validieren - AWS CloudFormation

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.

Vorlagen mit cfn-lint validieren

Die CloudFormation Linter (cfn-lint) überprüft JSON- und YAML-Vorlagen anhand der Schemas des CloudFormation Ressourcenanbieters und zusätzlicher Regeln. Es kann ungültige Ressourceneigenschaften, nicht unterstützte Werte und häufig auftretende Probleme finden, bevor Sie eine Vorlage an senden. CloudFormation

Quellcode, Versionshinweise, Einstellungen und die vollständige Regelliste sind im cfn-lint-Repository unter verfügbar. GitHub

Installieren Sie cfn-lint

cfn-lintAus dem Python-Paketindex (PyPI) installieren:

python3 -m pip install cfn-lint

NeinmacOS, du kannst es stattdessen mit Homebrew installieren:

brew install cfn-lint

Informationen zu unterstützten Python-Versionen und anderen Installationsmethoden finden Sie in den Installationsanweisungen unter. GitHub

Führen Sie cfn-lint aus

Übergeben Sie einen oder mehrere Vorlagenpfade an den Befehl:

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

Verwenden Sie die --regions Option AWS-Region, um nach mehreren Vorlagen zu suchen:

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

Der Befehl gibt einen Exit-Code ungleich Null zurück, wenn er Probleme findet. Sie können dieses Verhalten verwenden, um einen automatisierten Build zu stoppen, wenn eine Vorlage Ihre ausgewählten Prüfungen nicht besteht.

Schecks konfigurieren

Verwenden Sie eine.cfnlintrc,.cfnlintrc.yaml, oder .cfnlintrc.yml -Datei, um die Projekteinstellungen in Ihren Vorlagen beizubehalten. Sie können diese Datei verwenden, um Vorlagen auszuwählen, Prüfungen einzubeziehen oder zu ignorieren, das Verhalten von Regeln auszuwählen AWS-Regionen und zu konfigurieren. Alle Einstellungen finden Sie in der Konfigurationsdatei in der Projektdokumentation unter GitHub.

Fügen Sie cfn-lint zu Ihrem Workflow hinzu

Du kannst es in unterstützten Editoren ausführencfn-lint, automatisch vor einem Git-Commit oder als Teil eines automatisierten Builds. Der CloudFormation Sprachserver zeigt cfn-lint auch Probleme beim Tippen an. Informationen zur Einrichtung des Sprachservers finden Sie unterCloudFormation Sprachserver.

Editor-Plugins, GitHub Aktionen, Konfiguration vor dem Commit, benutzerdefinierte Regeln und weitere Beispiele finden Sie in der cfn-lint-Projektdokumentation unter. GitHub