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 `cloudformation-validate validieren`
Das [`cloudformation-validate` Open-Source-Projekt ](https://github.com/aws-cloudformation/cloudformation-validate) überprüft JSON- und CloudFormation YAML-Vorlagen lokal und ist unter verfügbar. GitHub Es kann eine ungültige Vorlagenstruktur, defekte Referenzen, Sicherheitsprobleme und Best-Practice-Probleme finden. Jedes Ergebnis umfasst das Problem, seinen Schweregrad und seine Position in der Vorlage.
Das Tool enthält die Regeln und CloudFormation Ressourcendefinitionen, die es benötigt, sodass es nach der Installation ohne Netzwerkzugriff oder AWS Anmeldeinformationen ausgeführt werden kann.
**Topics**
+ [Wählen Sie eine Validierungsmethode](#cloudformation-validate-ways-to-use)
+ [Installieren Sie das Befehlszeilentool](#cloudformation-validate-install)
+ [Führen Sie die Validierung durch](#cloudformation-validate-run)
+ [Fügen Sie benutzerdefinierte Regeln hinzu](#cloudformation-validate-custom-rules)
+ [Betten Sie die Validierungsbibliothek ein](#cloudformation-validate-library)
+ [Verwendet mit AWS CDK](#cloudformation-validate-cdk)
+ [Verstehen Sie den Umfang der Validierung](#cloudformation-validate-scope)
## Wählen Sie eine Validierungsmethode
+ **Befehlszeile ** — Führen Sie diese Option aus`cfn-validate`, um eine Vorlage oder jede Vorlage in einem Verzeichnis von einem Terminal oder einem automatisierten Build aus zu überprüfen.
+ **Bibliothek ** — Fügen Sie den Validator zu einer Rust-, Python- Node.js, Go- oder JVM-Anwendung hinzu und verarbeiten Sie die Ergebnisse in Ihrem Code.
+ **AWS CDK**— Validieren Sie Vorlagen automatisch, nachdem CDK sie synthetisiert hat.
+ **Benutzerdefinierte Regeln ** — Fügen Sie Schecks hinzu, die in CEL, Rego oder der Guard-Regelsprache verfasst sind. Unterstützte Regelformate und Beispiele finden Sie in der Referenz zu [ benutzerdefinierten Regeln ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/CUSTOM_RULES.md) unter GitHub. Informationen zur Syntax von Guard-Regeln finden Sie [Vorlagen mit Guard validieren](cloudformation-guard.md) in diesem Handbuch.
## Installieren Sie das Befehlszeilentool
Öffnen Sie die [ neueste `cfn-validate` Version ](https://github.com/aws-cloudformation/cloudformation-validate/releases/latest) am GitHub und laden Sie die `cfn-validate` Datei für Ihr Betriebssystem und Ihren Prozessor herunter. Folgen Sie der [ Installationsanleitung ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/INSTALLATION.md) auf, GitHub um die Datei umzubenennen`cfn-validate`, sie zu Ihrer `PATH` hinzuzufügen und die heruntergeladene Datei zu überprüfen.
## Führen Sie die Validierung durch
Der Befehl verwendet die folgende Syntax:
```
cfn-validate {{TEMPLATE_OR_DIRECTORY}} [OPTIONS]
```
Überprüfen Sie eine Vorlage:
```
cfn-validate template.yaml
```
Übergeben Sie ein Verzeichnis, um jede `.yaml``.yml`, und `.json` -Datei rekursiv zu überprüfen:
```
cfn-validate ./templates/
```
Der Befehl schreibt einen strukturierten JSON-Validierungsbericht in die Standardausgabe. Wird `--format standard` für eine kompakte Ausgabe oder `--format detailed` für den detaillierten Standardbericht verwendet.
Der Befehl kehrt zurück, `0` wenn kein Fehler oder eine schwerwiegende Diagnose gefunden wird, `1` wenn ein Fehler oder eine schwerwiegende Diagnose gefunden wird und `2` wenn ein Verwendungs- oder Initialisierungsfehler vorliegt, z. B. eine ungültige Option oder eine Datei, die nicht existiert.
Alle Engines, Filter, Ausgabeformate und Parameter finden Sie in der [`cfn-validate` CLI-Referenz ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/cfn-validate/README.md) unter GitHub.
## Fügen Sie benutzerdefinierte Regeln hinzu
Wird verwendet`--rule-source`, um eine benutzerdefinierte Rego- oder CEL-Regeldatei zu laden. Wird verwendet`--guard-rule-source`, um eine Guard-Regeldatei oder ein Verzeichnis zu laden. Sie können beide Optionen wiederholen, um mehrere Regelquellen zu laden:
```
cfn-validate template.yaml --rule-source ./rules/my-rule.rego
cfn-validate template.yaml --guard-rule-source ./guard-rules/
```
Regelformate und Beispiele finden Sie unter Referenz zu [ benutzerdefinierten Regeln ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/CUSTOM_RULES.md) unter GitHub.
## Betten Sie die Validierungsbibliothek ein
Installieren Sie das veröffentlichte Paket für Ihre Programmiersprache, um dieselben Offline-Prüfungen von Ihrer Anwendung aus durchzuführen. Erstellen Sie einmal eine Validierungsengine, verwenden Sie sie für mehrere Vorlagen wieder und verarbeiten Sie die für jede Vorlage zurückgegebenen strukturierten Diagnosen. Sie können auch benutzerdefinierte CEL-, Rego- oder Guard-Regeln über die Bibliotheks-API konfigurieren.
| Sprache | Veröffentlichtes Paket | API und Beispiele |
| --- | --- | --- |
| Rust | [`cloudformation-validate`auf crates.io ](https://crates.io/crates/cloudformation-validate) | [Rust-API und Beispiele ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/bindings-rust/README.md) |
| Node.js | [`@aws/cloudformation-validate`auf npm ](https://www.npmjs.com/package/@aws/cloudformation-validate) | [Node.js API und Beispiele ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/bindings-wasm/README.md) |
| Python | [`cloudformation-validate`auf PyPI ](https://pypi.org/project/cloudformation-validate/) | [Python-API und Beispiele ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/bindings-python/README.md) |
| Go | [CloudFormation Validiere das Go-Modul ](https://pkg.go.dev/github.com/aws-cloudformation/cloudformation-validate/src/bindings-go/go) | [Go-API und Beispiele ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/bindings-go/README.md) |
| JVM (Java oder Kotlin) | [`software.amazon.cloudformation:cloudformation-validate`auf Maven Central ](https://central.sonatype.com/artifact/software.amazon.cloudformation/cloudformation-validate) | [JVM-API und Beispiele ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/src/bindings-jvm/README.md) |
Installationsanweisungen und unterstützte Plattformen finden Sie in der Installationsanleitung [ zur ](https://github.com/aws-cloudformation/cloudformation-validate/blob/main/INSTALLATION.md#language-bindings) Sprachbindung.
Vollständige Beispiele in jeder Sprache und Links zu den einzelnen API-Anleitungen finden Sie unter Als Bibliothek [ einbetten ](https://github.com/aws-cloudformation/cloudformation-validate#embedding-as-a-library) in der Projektdokumentation unter GitHub.
## Verwendet mit AWS CDK
Wenn Sie ihn verwenden AWS CDK, müssen Sie den Validator nicht separat installieren. Die AWS CDK Konstruktbibliothek enthält eine Standardbibliothek`CloudFormationValidatePlugin`, die dieselben Prüfungen automatisch durchführt, nachdem Sie Ihre Vorlagen synthetisiert haben. CloudFormation
```
cdk synth
```
CDK meldet mögliche Bereitstellungsfehler und Best-Practice-Ergebnisse zusammen mit seinen Validierungsergebnissen. Sie können explizit konfigurieren`CloudFormationValidatePlugin`, wann Sie benutzerdefinierte Rego- oder Guard-Regeln hinzufügen möchten.
Informationen zur Plugin-Konfiguration, Bestätigungen und Validierungsberichte finden Sie unter [ Vorlagen- und Richtlinienvalidierung ](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib-readme.html#template-and-policy-validation) in der *AWS CDK API-Referenz. *
## Verstehen Sie den Umfang der Validierung
Die Einschränkungen der lokalen Validierung und die vor der Bereitstellung zu ergreifenden Schritte finden Sie unter[Verstehen Sie den Umfang der Validierung](template-guide.md#template-validation-scope).