AWS CloudFormation Sprachserver - AWS CloudFormation
IDEs Integration mit dem Sprachserver AWS CloudFormationErste SchritteInitialisieren eines CloudFormation Projekts in der IDEOpen-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 Sprachserver 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. Entwicklertools und integrierte Entwicklungsumgebungen (IDE) können die Sprachserverfunktionen nutzen, um die Erfahrung von IaC-Entwicklern zu verbessern. CloudFormation

IDEs Integration mit dem Sprachserver AWS CloudFormation

Die AWS Toolkit-Erweiterung integriert den CloudFormation Sprachserver, um das Authoring-Erlebnis zu verbessern. Diese Integration wird derzeit in VS Code Based unterstützt IDEs, einschließlich:

Erste Schritte

Voraussetzungen

Bevor Sie beginnen, stellen Sie Folgendes sicher:

  • Sie verwenden eine VS Code-basierte IDE auf einem unterstützten Betriebssystem (macOS,Windows, oderLinux).

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

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

Schritt 1: Installieren oder aktualisieren Sie das Toolkit AWS

  • Öffnen Sie den Extensions oder den Plugin-Manager Ihrer IDE.

  • Suchen Sie nach AWS Toolkit.

  • Installieren oder aktualisieren Sie das AWS Toolkit für Ihre IDE auf Version 3.85.0 oder höher.

  • Starten Sie Ihre IDE nach der Installation neu.

Hinweis: Nach der Installation aktiviert das AWS Toolkit automatisch die CloudFormation IDE-Unterstützung. Wenn Sie das AWS Toolkit zum ersten Mal mit der AWS CloudFormation Sprachserver-Erweiterung installieren oder aktualisieren, werden Sie aufgefordert, die Erlaubnis zur Erfassung anonymer Nutzungsdaten AWS zu erteilen. Diese Daten tragen zur AWS Verbesserung des CloudFormation Sprachservers bei und verbessern das Authoring-Erlebnis. 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. 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-Panel AWS

Öffnen Sie in Ihrer IDE das AWS Toolkit-Bedienfeld über die Aktivitätsleiste. Wählen Sie unter AWS Toolkit die Option CLOUDFORMATION aus.

Panel-Abschnitte:

  • Region: Zeigt die aktuelle Region an AWS-Region. Sie können ihn ändern, indem Sie den Namen der Region auswählen oder den Befehl AWS CloudFormation: Region auswählen in der Befehlspalette verwenden.

  • Umgebung: Zeigt die Umgebung an, die Sie während dieser Zeit ausgewählt haben CFN init (z. B. dev, test oder prod). Dieser Wert wird erst angezeigt, nachdem der Schritt zur Umgebungsauswahl abgeschlossen wurde.

  • Stacks: Zeigt eine paginierte Liste der CloudFormation Stacks in Ihrem Konto an.

    • Klicken Sie auf das Aktualisierungssymbol, um die Liste der Stacks zu aktualisieren.

    • Verwenden Sie das Pluszeichen, um eine neue Vorlage als Stapel bereitzustellen.

    • Jeder Stack-Eintrag beinhaltet:

      • Überblick: Zeigt die Zusammenfassung und den Status des Stacks an

      • Stack-ID

      • Beschreibung

      • Erstellungszeit und Aktualisierungszeit

      • Status und Statusgrund

      • Ereignisse, Ergebnisse und Ressourcen

    • Set ändern

  • Ressourcen: Nachdem Sie einen Ressourcentyp ausgewählt 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.

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 Sprachserver 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.

Um Ressourcen zu Ihrer Vorlage hinzuzufügen

  • Erweitern Sie den Bereich CloudFormation Ressourcen: Erweitern CloudFormationSie im Seitenbereich des AWS Toolkits den Bereich und klicken Sie dann unter Ressourcen auf das Symbol „+ hinzufügen“.

  • Nach einem Ressourcentyp suchen: Um einen bestimmten AWS Ressourcentyp zu finden, geben Sie in der Suchleiste den spezifischen AWS Ressourcentyp ein, den Sie hinzufügen möchten. Beispiel:

    • AWS::S3::Bucket

    • AWS::Lambda::Function

    Sie können den Ressourcentyp mithilfe von AWS CloudFormation: Ressourcentypen hinzufügen in der Befehlspalette auswählen.

  • Ressourcen zu Ihrer Vorlage hinzufügen: 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 am unteren Rand des Panels, um durch weitere Seiten zu blättern 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 das Ressourcen-Panel 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 im selben Konto gehört.

  • Um zu überprüfen, ob eine Ressource bereits von verwaltet wird CloudFormation, klicken Sie auf das i-Symbol (Information) neben dem Ressourcennamen.

  • Alternativ können Sie den Befehl AWS CloudFormation Get Stack Management Info verwenden, um zu überprüfen, ob eine Ressource zu einem Stack gehört.

Sie können 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.

Statische Validierung

Die CloudFormation IDE 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 Bereitstellung 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 rote oder gelbe, verschnörkelte Linien unter Problemen an, die für Blockierungen oder Warnungen bei der Bereitstellung stehen.

  • Zeigen Sie mit der Maus auf die Hilfe: 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 sie auch im Hover-Panel 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 Sprachserver 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 unter dem Link zur Guard-Rule-Registrierung.

  • Regelpakete hinzufügen: Um Regelsätze hinzuzufügen oder zu ändern, öffnen Sie Einstellungen, Guard und wählen Sie weitere Guard-Regelpakete aus oder laden Sie sie hoch.

Tipps: Verstehen von Indikatoren mit verschnörkelten Linien

  • Blaue Schnörkel: Tipps zu bewährten Methoden oder Optimierungsempfehlungen.

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

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

Schritt 4: Navigieren Sie durch die Vorlage

Wenn Sie im Explorer auf eine Vorlagendatei klicken, zeigt das Übersichtsfenster automatisch eine strukturierte, hierarchische Ansicht Ihrer CloudFormation Vorlage an. Es organisiert die Vorlage in Abschnitte wieParameters,, und Resources OutputsMappings, und und zeigt jeden Ressourcentyp und jede logische ID an. Dies macht es einfach, innerhalb umfangreicher Vorlagen schnell nach bestimmten Ressourcen oder Parametern zu suchen und zu ihnen zu navigieren.

Sie können Go to Definition für systeminterne Funktionen wie GetAtt und verwendenRef, sodass Sie direkt zu der Ressource oder dem Parameter springen können, auf die in Ihrer Vorlage 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, öffnen Sie die Befehlspalette und führen Sie Folgendes aus AWS CloudFormation: Validieren und Bereitstellen. Der Befehl validiert Ihre Vorlage, und wenn keine Blockierungsfehler gefunden werden, wird mit der Bereitstellungsphase fortgefahren. Vor der Bestätigung zeigt die IDE eine Zusammenfassung des Änderungssatzes und eine Vergleichsansicht an, sodass Sie alle vorgeschlagenen Änderungen überprüfen können.

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 ein Benutzer jedoch mit der Bereitstellung fortfährt, ohne sie zu adressieren, 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 anhand roter oder gelber Schnörkellinien hervor und listet die Fehler im Bereich PROBLEME 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.

Hinweis: Änderungssätze, die Drift berücksichtigen, verbessern den CloudFormation Bereitstellungsprozess, da sie es Ihnen ermöglichen, Stack-Drift sicher zu handhaben. Stack-Drift tritt auf, wenn der tatsächliche Status Ihrer Ressourcen von dem abweicht, was 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. CloudFormationIm Änderungssatz mit Drift-Erkennung 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 zur CloudFormationRegisterkarte im Fenster wechseln, um den Fortschritt in Echtzeit zu überwachen. 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. Wenn Sie den Stapel im öffnen möchten AWS-Managementkonsole, verwenden Sie das externe Linksymbol neben dem Stacknamen. 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

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.

Um ein Projekt zu initialisieren: CloudFormation

  • Öffnen Sie die Befehlspalette

    • Öffnen Sie in Ihrer IDE 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

    • 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 Sprachserver ist im Rahmen der Apache-2.0 Lizenz als Open-Source-Lösung 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.