AWS CloudFormation Sprachserver - AWS CloudFormation
IDEs Integration mit dem Language Server AWS CloudFormationErste SchritteInitialisieren eines CloudFormation Projekts in der IDE (nur VS Code)Open-SourceBenötigen Sie Hilfe?

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.

AWS CloudFormation Sprachserver

Der AWS CloudFormation Language Server bietet Funktionen zur Beschleunigung der Inhaltserstellung infrastructure-as-code (IaC) und zur sicheren und zuverlässigen Bereitstellung von AWS Ressourcen. Es folgt dem Language Server Protocol (LSP) und bietet Dokumentation zu Hover, Autovervollständigung, Diagnose über statische Validierung, Go-to-Definitions- und Code-Aktionen. Zusätzlich zu diesen herkömmlichen Sprachserverfunktionen bietet der Server Online-Funktionen, mit denen Sie Ressourcen erkunden und bereitstellen können AWS . CloudFormation Dazu gehören die Möglichkeit, Vorlagen mithilfe von Änderungssätzen zu validieren und bereitzustellen, Stack-Diffs, Ereignisse, Ressourcen und Ausgaben anzuzeigen, Stapel aufzulisten und Ressourcen nach Typ zu durchsuchen sowie den aktuellen Ressourcenstatus direkt in CloudFormation Vorlagen einzufügen.

IDEs Integration mit dem Language Server AWS CloudFormation

AWS ermöglicht die off-the-shelf Integration mit dem CloudFormation Language Server über das AWS Toolkit für Folgendes: IDEs

Folgendes unterstützt IDEs auch den Language Server: CloudFormation

Der CloudFormation Language Server hält sich an das Language Server Protocol (LSP), weshalb andere Integrationen konfigurierbar sind. Anweisungen zur Integration des Sprachservers mit anderen Editoren finden Sie in der Installationsanleitung.

Erste Schritte

Voraussetzungen

Bevor Sie beginnen, stellen Sie Folgendes sicher:

  • Sie verwenden eine unterstützte IDE auf einem unterstützten Betriebssystem (macOSWindows, oderLinux).

  • Sie haben die neueste Version des AWS Toolkits für Ihre IDE installiert oder auf diese aktualisiert.

Für einige Funktionen im AWS CloudFormation Language Server sind aktive AWS-Konto und konfigurierte Anmeldeinformationen erforderlich. Sie müssen AWS-Konto über das AWS Toolkit mit gültigen Zugangsdaten bei Ihrem angemeldet sein.

Schritt 1: Installieren oder aktualisieren Sie das Toolkit AWS

Installieren oder aktualisieren Sie das AWS Toolkit über den Erweiterungs- oder Plugin-Manager Ihrer IDE auf die neueste Version und starten Sie dann Ihre IDE neu.

Nach der Installation aktiviert das AWS Toolkit automatisch die CloudFormation IDE-Unterstützung. Wenn Sie das AWS Toolkit zum ersten Mal mit dem AWS CloudFormation Language Server installieren oder aktualisieren, werden Sie aufgefordert, die Erlaubnis zur Erfassung anonymer Nutzungsdaten AWS zu erteilen. Diese Daten tragen dazu bei, den CloudFormation Language Server AWS zu verbessern und das Authoring-Erlebnis zu verbessern. Es werden keine vertraulichen Informationen gesammelt und AWS es werden keine Vorlageninhalte, Ressourcenkonfigurationen oder identifizierbare Kundendaten aufgezeichnet oder gespeichert. Sie können Ihre Telemetrieeinstellungen jederzeit in den IDE-Einstellungen ändern. Starten Sie die IDE neu, damit die Änderungen wirksam werden. Die gesammelten Nutzungsdaten konzentrieren sich nur auf Funktionsinteraktionen und Leistungskennzahlen. Diese Erkenntnisse helfen dabei, Verbesserungen wie schnellere Validierung, verbesserte automatische Vervollständigung und bessere Fehlerdiagnose zu AWS identifizieren und zu priorisieren.

Schritt 2: Zugriff CloudFormation im Toolkit AWS

Öffnen Sie nach der Installation des AWS Toolkits das CloudFormation Panel in Ihrer IDE. Öffnen Sie in VS Code das AWS Toolkit-Bedienfeld in der Aktivitätsleiste und wählen Sie CLOUDFORMATION. Öffnen Sie in JetBrains IDEs der Seitenleiste das AWS Toolkit-Toolfenster und wählen Sie die Registerkarte aus. CloudFormation

Das CloudFormation Panel enthält die folgenden Abschnitte:

  • Region: Zeigt den aktuellen Wert an AWS-Region. In VS Code können Sie ihn ändern, indem Sie den Namen der Region auswählen oder den Befehl AWS CloudFormation: Region auswählen in der Befehlspalette verwenden. In JetBrains IDEs wird die Region über die AWS Toolkit-Verbindungseinstellungen konfiguriert.

  • Stacks: Zeigt eine paginierte Liste der CloudFormation Stacks in Ihrem Konto an. Erweitern Sie einen Stapel, um seinen Knoten „Änderungssätze“ anzuzeigen, in dem die mit diesem Stapel verknüpften Änderungssätze aufgeführt sind. Verwenden Sie die Aktion „Stack-Details anzeigen“, um die Stack-Detailansicht zu öffnen, in der die Stack-Übersicht, Ereignisse, Ausgaben und Ressourcen angezeigt werden.

  • Ressourcen: Nachdem Sie einen Ressourcentyp hinzugefügt haben, werden im Bereich die AWS Ressourcen dieses Typs in Ihrem Konto angezeigt. Sie können sie anzeigen, aktualisieren, kopieren oder in Ihre Vorlage importieren.

In JetBrains IDEs bietet die Werkzeugleiste über der Baumstruktur schnellen Zugriff auf häufig verwendete Aktionen wie Validieren und Bereitstellen, Erneut ausführen, Ressourcentyp hinzufügen und Aktualisieren. Aktionen sind auch über Kontextmenüs mit der rechten Maustaste auf Baumknoten verfügbar.

Schritt 3: Validieren, testen und verfeinern Sie Ihre Vorlage

Während Sie Ihre CloudFormation Vorlage schreiben, bietet die IDE intelligente Authoring-Unterstützung, damit Sie schneller eine genaue und konforme Infrastruktur erstellen können. Der CloudFormation Language Server läuft im Hintergrund und bietet die folgenden Authoring-Funktionen:

  • Codevervollständigung: Schlägt Ressourcentypen, Parameter und Eigenschaften auf der Grundlage von CloudFormation Schemas vor.

  • Bestehende AWS Ressourcen hinzufügen: Ermöglicht es Ihnen, vorhandene Ressourcen aus Ihrem AWS-Konto in Ihre Vorlage zu importieren. Die IDE verwendet die AWS -Cloud-Control- API (CCAPI), um die Live-Konfiguration und die Eigenschaften der Ressource abzurufen, sodass Sie die bestehende Infrastruktur innerhalb Ihrer Vorlage klonen oder wiederverwenden können.

  • In Parameter extrahieren: Wenn sich der Cursor auf einem Literalwert in einer Vorlage befindet (z. B. einer Zeichenfolge wiet2.micro), bietet die IDE eine Refactoring-Aktion an, um den Wert in den Parameters Abschnitt zu extrahieren und das Literal durch ein für den neuen Parameter zu ersetzen. !Ref Wenn derselbe Literalwert an mehreren Stellen vorkommt, können Sie festlegen, dass alle Vorkommen auf einmal extrahiert werden.

Um Ihrer Vorlage Ressourcen hinzuzufügen

  • Einen Ressourcentyp hinzufügen: Fügen Sie im AWS CloudFormation Toolkit-Bereich unter Ressourcen einen Ressourcentyp zum Durchsuchen hinzu. Klicken Sie in VS Code auf das Symbol „+ hinzufügen“ oder verwenden Sie den Befehl AWS CloudFormation: Ressourcentypen hinzufügen in der Befehlspalette. Klicken Sie in JetBrains der Werkzeugleiste auf die Schaltfläche Ressourcentyp hinzufügen oder klicken Sie mit der rechten Maustaste auf den Knoten Ressourcen.

  • Suchen Sie nach einem Ressourcentyp: Geben Sie im Suchdialogfeld den AWS Ressourcentyp ein, den Sie hinzufügen möchten. Beispiel:

    • AWS::S3::Bucket

    • AWS::Lambda::Function

  • Ressourcen durchsuchen: Im Bereich Ressourcen wird eine paginierte Liste der erkannten AWS Ressourcen in Ihrem Konto angezeigt. Wenn Sie über viele Ressourcen verfügen, wird nur die erste Seite angezeigt. Verwenden Sie die Navigationssteuerelemente, um sich durch weitere Seiten zu bewegen und alle verfügbaren Ressourcen anzuzeigen.

  • Wählen Sie die Ressource aus, die Sie in Ihre Vorlage aufnehmen möchten.

  • Sie können eine Ressource auf zwei Arten in Ihre Vorlage einfügen, abhängig von Ihrem Ziel:

    • Klonen Sie eine vorhandene Ressource: Erstellen Sie eine neue Ressource in Ihrer Vorlage, indem Sie die Live-Konfiguration und die Eigenschaften einer vorhandenen AWS Ressource verwenden.

    • Importieren Sie eine vorhandene Ressource: Fügen Sie die tatsächliche Ressource in Ihren Stapel ein, indem Sie sie unter Verwendung ihres Live-Status zu Ihrer Vorlage hinzufügen.

Tipps

  • Sie können den Abschnitt Ressourcen jederzeit aktualisieren, um die aktuelle Liste der in Ihrem Konto oder Ihrer Region verfügbaren Ressourcen einzusehen.

  • Wenn Sie Ressourcen importieren, fügen Sie keine Ressource hinzu, die bereits zu einem vorhandenen CloudFormation Stack in demselben Konto gehört.

  • Um zu überprüfen, ob eine Ressource bereits von verwaltet wird CloudFormation, verwenden Sie die Informationsaktion neben der Ressource. Klicken Sie in VS Code auf das i-Symbol. Klicken Sie in JetBrains IDEs mit der rechten Maustaste auf die Ressource und wählen Sie Get Stack Management Info aus.

In VS Code können Sie der ausgewählten Ressource verwandte Ressourcen hinzufügen, indem Sie den folgenden Befehl verwenden AWS CloudFormation: Verwandte Ressourcen nach Typ hinzufügen. Sobald Sie einen Ressourcentyp aus den bereits in Ihrer Vorlage definierten ausgewählt haben, zeigt die IDE eine Liste von Ressourcen an, die normalerweise mit diesem Typ verknüpft sind oder von diesem abhängig sind. Wenn Sie beispielsweise einen auswählenAWS::EC2::Instance, schlägt die IDE möglicherweise vor, verwandte Ressourcen wie AWS::EC2::SecurityGroup oder hinzuzufügenAWS::EC2::Subnet. Mit dieser Funktion können Sie schnell verbundene Infrastrukturkomponenten erstellen, ohne manuell nach kompatiblen Ressourcentypen suchen zu müssen. Diese Funktion wird derzeit in nicht unterstützt JetBrains IDEs.

Statische Validierung

Der CloudFormation Language Server bietet eine integrierte statische Validierung, die von AWS CloudFormation Linter (cfn-lint) und unterstützt wird. AWS CloudFormation Guard Diese Validierungen laufen im Hintergrund ab, während Sie Vorlagen erstellen, und helfen Ihnen dabei, Syntaxfehler, Compliance-Lücken und Probleme mit bewährten Verfahren vor der Implementierung zu identifizieren.

Überblick über die statische Validierung

In der IDE werden Sie zwei Arten von statischen Echtzeitvalidierungen sehen:

  • CloudFormation Linter (cfn-lint): Validiert Ihre Vorlage anhand von CloudFormation Ressourcenspezifikationen und Schemaregeln.

  • Guard (cfn-guard): Überprüft Ihre Vorlage anhand von Compliance-Regeln und organisatorischen Policy-Paketen.

CloudFormation Linter (cfn-lint)

Der CloudFormation Linter ist in die IDE integriert, um die Syntax und Struktur Ihrer Vorlage während der Eingabe automatisch zu überprüfen.

  • Schemavalidierung: Erkennt Syntax- und Schemafehler, um sicherzustellen, dass Ihre Vorlagen dem CloudFormation Ressourcenschema entsprechen.

  • Fehlerhervorhebung: Zeigt Inline-Markierungen unter Problemen an, die für Blockierungen oder Warnungen bei der Bereitstellung stehen.

  • Hilfe beim Bewegen des Mauszeigers: Wenn Sie mit der Maus auf einen Fehler zeigen, zeigt die IDE die zu diesem Problem gehörende Diagnosemeldung an. Wenn eine schnelle Lösung verfügbar ist, wird diese ebenfalls angeboten.

Integration von Guard

Guard validiert Ihre Vorlagen anhand von Regelsätzen, die Compliance- und Sicherheitsrichtlinien definieren. Die IDE führt Guard-Validierungen in Echtzeit über den CloudFormation Language Server durch, sodass Sie bei der Erstellung von Vorlagen sofort Feedback erhalten.

  • Standardregelpakete: Die IDE enthält einen vorregistrierten Satz von Guard-Regeln, die sich auf grundlegende bewährte Methoden für Ressourcensicherheit und Konfigurationshygiene konzentrieren. Weitere Informationen finden Sie in der Guard-Rule-Registrierung.

  • Regelpakete hinzufügen: Um Regelsätze hinzuzufügen oder zu ändern, öffnen Sie Ihre IDE-Einstellungen und navigieren Sie zum Abschnitt Guard-Konfiguration, um weitere Guard-Regelpakete auszuwählen oder hochzuladen.

Tipps: Diagnoseindikatoren verstehen

  • Blaue Indikatoren: Hinweise zu bewährten Verfahren oder Optimierungsempfehlungen.

  • Gelbe Indikatoren: Warnungen vor Problemen, die nicht blockieren (z. B. fehlende Tags oder Parameter).

  • Rote Indikatoren: Blockieren der Bereitstellung, z. B. ungültige Eigenschaftsnamen, fehlende Pflichtfelder oder Schemakonflikte.

Schritt 4: Navigieren Sie durch die Vorlage

Die IDE bietet eine strukturierte, hierarchische Ansicht Ihrer CloudFormation Vorlage, die in Abschnitte wie, Parameters Resources OutputsMappings, und unterteilt ist und jeden Ressourcentyp und jede logische ID anzeigt. Auf diese Weise können Sie innerhalb umfangreicher Vorlagen schnell nach bestimmten Ressourcen oder Parametern suchen und zu ihnen navigieren. In VS Code zeigt das Gliederungsfenster in der Explorer-Seitenleiste diese Struktur an. Öffnen Sie in das Strukturwerkzeugfenster JetBrains IDEs, um die Vorlagenstruktur für die aktuell geöffnete Datei anzuzeigen.

Sie können „Gehe zu Definition“ für systeminterne Funktionen wie GetAtt und verwendenRef, sodass Sie direkt zu der Ressource oder dem Parameter in Ihrer Vorlage springen können, auf die verwiesen wird. Auf diese Weise können Sie Abhängigkeiten nachverfolgen, Ressourcenbeziehungen verstehen und Änderungen effizienter vornehmen.

Schritt 5: Validieren und bereitstellen

Wenn Sie bereit sind, Ihre CloudFormation Vorlage bereitzustellen, verwenden Sie die Funktion Validieren und Bereitstellen, um einen Änderungssatz zu erstellen. Die IDE validiert Ihre Vorlage, und wenn keine Blockierungsfehler gefunden werden, erstellt sie einen Änderungssatz, der Änderungen berücksichtigt. Die IDE zeigt dann eine Vergleichsansicht an, sodass Sie alle vorgeschlagenen Änderungen überprüfen können, bevor Sie den Änderungssatz ausführen.

Öffnen Sie in VS Code die Befehlspalette und führen Sie Folgendes aus AWS CloudFormation: Validieren und Bereitstellen. Die Befehlspalette führt Sie Schritt für Schritt durch die Auswahl einer Vorlage, eines Stack-Namens, von Parametern, Funktionen und anderen Bereitstellungsoptionen. Klicken Sie in in JetBrains IDEs der Werkzeugleiste auf die Schaltfläche Validieren und Bereitstellen, klicken Sie mit der rechten Maustaste auf eine Vorlagendatei im Editor oder klicken Sie mit der rechten Maustaste auf einen Stapel in der Baumstruktur. JetBrains öffnet ein Assistentendialogfeld, in dem Sie alle Bereitstellungsoptionen konfigurieren können, einschließlich der Vorlagenauswahl, des Stack-Namens, der Parameter, Funktionen, Tags und erweiterten Optionen.

Wie funktioniert die Validierung

Die IDE führt vor der Bereitstellung automatisch eine Validierungsprüfung durch und validiert Ihre Vorlage anhand gängiger Fehlerursachen, darunter:

  • Ungültige Eigenschaftssyntax oder falsche Schemaübereinstimmungen: Diese Probleme treten normalerweise cfn-lint beim Authoring auf. Wenn Sie jedoch mit der Bereitstellung fortfahren, ohne sie zu beheben, werden bei CloudFormation der Validierung während der Bereitstellung dieselben Fehler angezeigt, bevor der Stack erstellt oder aktualisiert wird.

  • Der Ressourcenname steht in Konflikt mit vorhandenen Ressourcen in Ihrem Konto.

  • Dienstspezifische Einschränkungen, wie z. B. Konflikte mit S3-Bucket-Namen oder fehlende Verschlüsselung.

Wenn bei der Überprüfung Fehler erkannt werden, hebt die IDE die Probleme direkt in Ihrer Vorlage hervor und listet die Fehler im Diagnosebereich auf. Jedes Problem enthält die spezifische Eigenschaft oder Ressource, die den Fehler verursacht hat, sowie einen Lösungsvorschlag. Wenn keine Blockierungsfehler vorliegen, können Sie mit der Bereitstellungsphase fortfahren.

Wenn Warnungen gefunden werden (nicht blockierende Probleme), wird ein Dialogfeld angezeigt, in dem Sie entweder mit der Bereitstellung fortfahren oder den Vorgang abbrechen und Korrekturen vornehmen können.

Die IDE öffnet einen Änderungssatz, der Änderungen berücksichtigt und alle Unterschiede zwischen Ihrer aktuellen Vorlage und der bereitgestellten Stack-Konfiguration anzeigt. Auf diese Weise können Sie den Änderungssatz vor der Ausführung überprüfen, bestätigen oder stornieren. Wenn Sie die Bereitstellung abbrechen, wird der Änderungssatz gelöscht.

Änderungssätze, die Änderungen berücksichtigen, verbessern den CloudFormation Bereitstellungsprozess, indem sie es Ihnen ermöglichen, Stack-Drift sicher zu handhaben. Stack-Drift tritt auf, wenn der tatsächliche Status Ihrer Ressourcen von dem abweicht, der in Ihrer CloudFormation Vorlage definiert ist, was häufig auf manuelle Änderungen zurückzuführen ist AWS-Managementkonsole, die über die CLI oder das SDK vorgenommen wurden. CloudFormation Bei Änderungssätzen, bei denen Abweichungen berücksichtigt werden, wird Ihre verarbeitete Stack-Konfiguration mit dem aktuellen Ressourcenstatus verglichen, und die IDE deckt diese Unterschiede auf, sodass Sie die Ressourcen vor der Bereitstellung wieder an die Richtlinien anpassen können.

Stack-Ereignisse ansehen

Wenn die Bereitstellung beginnt, können Sie den Fortschritt in Echtzeit vom Panel aus verfolgen. CloudFormation Unter Stack-Ereignisse sehen Sie eine Liste der während der Bereitstellung ausgeführten Operationen. Jedes Ereignis enthält Details wie:

  • Zeitstempel: Der Zeitpunkt, zu dem das Ereignis eingetreten ist

  • Ressource: Die spezifische AWS Ressource, die erstellt, aktualisiert oder gelöscht wird

  • Status: Der aktuelle Status des Vorgangs (z. B.CREATE_IN_PROGRESS,UPDATE_COMPLETE, oderROLLBACK_IN_PROGRESS)

  • Grund: Zusätzliche Kontext- oder Fehlermeldungen, falls zutreffend

In diesem Bereich können Sie sich auch die Ressourcen und Ausgaben des Stacks ansehen. In der Ansicht Stack-Ereignisse können Sie den Bereitstellungsfortschritt verfolgen, potenzielle Probleme identifizieren und überprüfen, wann Ihr Stack erfolgreich abgeschlossen wurde.

Initialisieren eines CloudFormation Projekts in der IDE (nur VS Code)

Durch die Initialisierung eines CloudFormation Projekts in der IDE können Sie einen strukturierten Arbeitsbereich mit den richtigen Ordnern, der richtigen Umgebungskonfiguration und den richtigen AWS Anmeldeinformationen einrichten, sodass Sie Ihre Vorlagen zuverlässig validieren und bereitstellen können. Sie können ein neues CloudFormation Projekt direkt von der IDE aus initialisieren, um dieses empfohlene Setup zu erstellen. Diese Funktion ist derzeit nur in VS Code verfügbar und wird in JetBrains IDEs nicht unterstützt.

Um ein CloudFormation Projekt zu initialisieren:

  • Öffnen Sie die Befehlspalette

    • Öffnen Sie in VS Code die Befehlspalette (Ctrl+Shift+Poder Cmd+Shift+P aktiviertmacOS).

    • Wählen Sie AWS CloudFormation: CFN Init: Projekt initialisieren.

  • Wählen Sie ein Projektverzeichnis

    • Standardmäßig verwendet die IDE Ihr aktuelles Arbeitsverzeichnis.

    • Sie können diesen Pfad in einen beliebigen Ordner ändern, in dem Sie Ihre CloudFormation Vorlagen speichern möchten.

  • Wählen Sie Ihr AWS Anmeldeinformationsprofil aus

    • Sie werden aufgefordert, ein AWS Anmeldeinformationsprofil auszuwählen. Das ausgewählte Profil wird für die Erkennung, Validierung und Bereitstellung von Umgebungen verwendet.

  • Richten Sie Ihre Umgebung ein

    • Sie werden aufgefordert, eine Umgebung zu erstellen oder auszuwählen.

    • Umgebungen definieren, wo und wie Ihre Vorlagen bereitgestellt oder validiert werden (z. B. Entwicklung, Beta oder Produktion). Sie können AWS CloudFormation: CFN Init: Add Environment verwenden, um Ihre Umgebung auszuwählen oder zu ändern.

    • Sie können AWS CloudFormation: CFN Init: Remove Environment verwenden, um die von Ihnen ausgewählte Umgebung zu entfernen.

  • (Optional) Parameterdateien importieren

    • Wenn Sie bereits über vorhandene Parameterdateien verfügen, ermöglicht Ihnen die IDE, diese während der Initialisierung zu importieren.

    • Die IDE erkennt automatisch kompatible Dateien und verknüpft sie mit Ihrem Projekt, sodass sie bei der Validierung und Bereitstellung von Vorlagen verwendet werden können.

  • Benennen Sie das Projekt und schließen Sie es ab

    • Geben Sie einen Projektnamen ein, z. B. Beta-Umgebung, und schließen Sie das Setup ab.

    • Die IDE erstellt die anfängliche Projektstruktur und die Konfigurationsdatei für Sie.

Sie können direkt von der IDE aus Validierungen ausführen, Bereitstellungen in der Vorschau anzeigen oder zwischen Umgebungen wechseln.

Open-Source

Der AWS CloudFormation Language Server ist im Rahmen der Apache-2.0 Lizenz als Open-Source-Software verfügbar, sodass Kunden volle Transparenz darüber haben, wie Vorlagendiagnosen, Schemavalidierung und statische Analysen durchgeführt werden. Dies reduziert die Probleme bei Sicherheit und Compliance für Kunden, die vor der Einführung von Tools Transparenz auf Quellenebene benötigen.

Die Codebasis ist öffentlich verfügbar unter: cloudformation-languageserver/ GitHub. https://github.com/aws-cloudformation/

Benötigen Sie Hilfe?

CloudFormation AWS re:Post Probiere die Community an.