Bearbeiten Sie Vorlagen visuell mit Template Studio

Template Studio ist ein Template-Editor in der CloudFormation Konsole. Es zeigt Ihre Vorlage als Text neben einem Diagramm der Ressourcen, die von der Vorlage deklariert werden. Während Sie die Vorlage bearbeiten, wird das Diagramm entsprechend neu gezeichnet. Sie können die Vorlage validieren, zwischen YAML und JSON konvertieren und in Amazon S3 speichern, ohne die Konsole zu verlassen.

Der Vorlagentext ist maßgebend. Das Diagramm ist eine visuelle Darstellung dieses Textes, keine separate bearbeitbare Oberfläche. Sie nehmen alle Änderungen in der Vorlage vor.

Überlegungen

Beachten Sie Folgendes, wenn Sie in Template Studio arbeiten:

• Sie schreiben in der Vorlage, nicht im Diagramm. Das Diagramm zeigt die Ressourcen, die in Ihrer Vorlage deklariert sind, und wie sie aufeinander verweisen. Sie können eine Ressource nicht hinzufügen oder konfigurieren, indem Sie das Diagramm bearbeiten.

• Ihre Änderungen werden nicht automatisch gespeichert. Template Studio bittet Sie um Bestätigung, bevor Sie mit ungespeicherten Änderungen weitermachen. Wenn Sie die Seite verlassen oder aktualisieren, werden ungespeicherte Änderungen verworfen. Speichern Sie auf Amazon S3 oder kopieren Sie die Vorlage oder laden Sie sie herunter, bevor Sie gehen.

• Beim Konvertieren einer Vorlage von YAML nach JSON werden ihre Kommentare verworfen, da JSON keine Syntax für sie hat. Durch die Konvertierung zurück zu YAML werden sie nicht wiederhergestellt.

• CloudFormation Die Validierung in Template Studio ist derzeit nicht für Entwürfe verfügbar, die größer als 51.200 Byte (50 KiB) sind. Die aktuelle Validierungsaktion sendet den Entwurf über den TemplateBody Parameter, für den dieses Limit gilt. Dies ist nicht die allgemeine Größenbeschränkung für Vorlagen. Sie können die Vorlage immer noch speichern und in einem Stack-Vorgang verwenden, sofern bestimmte Kontingente eingehalten werden CloudFormation . Weitere Informationen finden Sie unter Vorlage validieren.

• Beim Speichern wird die Vorlage in einen Bucket in Ihrem Konto geschrieben, sodass Vorlagen, die Sie speichern, zu den Amazon S3 S3-Standardtarifen abgerechnet werden. Weitere Informationen finden Sie unter Amazon S3 – Preise.

• Sie können das Ressourcendiagramm nur herunterladen, wenn die Arbeitsfläche in der Ansicht Canvas oder Beide angezeigt wird.

Für Template Studio sind Berechtigungen erforderlich

Welche Berechtigungen Sie benötigen, hängt von der Vorlagenquelle und den Aktionen ab, die Sie ausführen:

cloudformation:GetTemplate

Erforderlich, um die Vorlage eines vorhandenen Stacks zu öffnen. Gewähren Sie Zugriff auf den Stack, dessen Vorlage Sie bearbeiten möchten.

s3:GetObject

Erforderlich, um eine Vorlage von Amazon S3 mit Ihren Anmeldeinformationen zu lesen. Gewähren Sie Zugriff auf das Quellvorlagenobjekt. Eine vorsignierte URL verwendet die in der URL enthaltene Autorisierung.

cloudformation:ValidateTemplate

Erforderlich, um Validieren auszuwählen.

s3:PutObject

Erforderlich, um eine Vorlage zu speichern. Beschränken Sie diese Berechtigung beispielsweise auf Objekte im Ziel-Bucket arn:aws:s3:::destination-bucket/* und nicht auf alle Ressourcen.

s3:CreateBucket

Nur erforderlich, wenn die Konsole einen fehlenden Ziel-Bucket erstellt. Dies kann der von der Konsole verwaltete Bucket oder ein von Ihnen angegebener Bucket-Name sein. Für die Wiederverwendung eines vorhandenen Buckets ist diese Berechtigung nicht erforderlich.

s3:ListBucket

Erforderlich, wenn Sie in einem vorhandenen Bucket speichern, den Sie angeben. Template Studio überprüft AWS-Region vor HeadBucket dem Hochladen den Zugriff, den voraussichtlichen Bucket-Besitzer und den Bucket.

Für den von der Konsole verwalteten Bucket ist diese Berechtigung optional. Ohne sie wird im Speicherdialogfeld immer noch der Bucket-Name angezeigt. Das Speichern erfordert s3:PutObject und, falls der Bucket erstellt werden muss,s3:CreateBucket.

Öffnen Sie das Template Studio

Wo Sie Template Studio öffnen, bestimmt, womit es geöffnet wird und was nach dem Speichern passiert.

Um eine neue Vorlage zu starten

1. Öffnen Sie die CloudFormation -Konsole.

2. Wählen Sie in der Navigationsleiste oben auf dem Bildschirm die aus, in der AWS-Region Sie die Bereitstellung vornehmen möchten.

3. Wählen Sie im Navigationsbereich Template Studio aus.

Um eine Vorlage zu erstellen, während Sie einen Stapel erstellen

1. Wählen Sie auf der Seite Stack erstellen die Option Mit Template Studio erstellen aus.

2. Erstellen Sie die Vorlage und wählen Sie dann Speichern und fortfahren.

3. Der Stack-Assistent fährt mit der von Ihnen gespeicherten Vorlage fort, sodass Sie sie nicht separat hochladen müssen.

Um die Vorlage eines vorhandenen Stacks zu bearbeiten

1. Wählen Sie auf der Seite Stacks den Namen des Stacks aus.

2. Aktualisieren Sie den Stack entweder direkt oder erstellen Sie einen Änderungssatz.

3. Wählen Sie auf der Seite Vorlage vorbereiten die Option In Template Studio öffnen aus. Die aktuelle Vorlage des Stacks wird geöffnet.

4. Wählen Sie Speichern und fahren Sie fort, um zum Aktualisierungs- oder Änderungssatz mit Ihrer bearbeiteten Vorlage zurückzukehren.

An anderer Stelle in der Konsole, wo auch immer eine Vorlage angezeigt wird, können Sie „In Template Studio öffnen“ wählen, um sie zu bearbeiten.

Arbeiten Sie mit der Vorlage und dem Diagramm

Template Studio wird geöffnet, wobei die Vorlage und das Diagramm nebeneinander angezeigt werden. Verwenden Sie die Ansichtssteuerung, um auszuwählen, was auf dem Bildschirm angezeigt wird:

Vorlage

Nur die Vorlage in voller Breite. Verwenden Sie diese Option, um eine Vorlage ohne das Diagramm zu lesen oder zu schreiben.

Canvas (Zeichenbereich)

Nur das Diagramm in voller Breite. Verwenden Sie dies für eine große Vorlage, bei der das Diagramm die volle Breite benötigt.

Beides

Die Vorlage und das Diagramm zusammen. Ziehen Sie die Trennlinie zwischen ihnen, um beiden Seiten mehr Platz zu geben.

Das Diagramm gruppiert verwandte Ressourcen und stellt überall dort eine Verbindung her, wo eine Ressource durchRef, Fn::GetAttFn::Sub, oder DependsOn auf eine andere verweist. Eine Ressource, auf die nichts verweist, erscheint eigenständig, sodass eine versehentlich getrennte Ressource leicht zu erkennen ist.

Anmerkung

Beispielsweise können drei Funktionen dieselbe IAM-Rolle übernehmen. Das Diagramm zeigt die Rolle innerhalb jeder Funktion, aber die Vorlage deklariert nur eine Rolle. Sehen Sie in der Vorlage nach, wie viele Ressourcen vorhanden sind.

Konvertiert zwischen YAML und JSON

Das Format, in dem Sie speichern, bestimmt den Dateinamen und den Inhaltstyp des Objekts, das Template Studio in Amazon S3 schreibt.

Um die Vorlage zu konvertieren, die Sie gerade bearbeiten

1. Wählen Sie das Formatsteuerelement, das dem Format, in dem Sie sich gerade befinden, einen Namen gibt.

2. Wählen Sie das andere Format.

3. Bei der Konvertierung von YAML nach JSON werden Sie zur Bestätigung aufgefordert, da Kommentare nicht übertragen werden können. Wählen Sie Konvertieren, um fortzufahren.

Wichtig

JSON hat keine Syntax für Kommentare. Wenn Sie eine YAML-Vorlage, die Kommentare enthält, in JSON konvertieren, werden diese Kommentare entfernt, und wenn Sie sie wieder in YAML konvertieren, werden sie nicht wiederhergestellt. Kopieren Sie alles, was Sie behalten möchten, bevor Sie konvertieren.

Das Steuerelement für das Format ist nicht verfügbar, solange die Vorlage nicht gelesen werden kann, da keine Vorlage vollständig genug für die Konvertierung ist. Korrigieren Sie zuerst die Vorlage.

Syntaxprobleme während der Eingabe

Der Editor überprüft die Syntax der Vorlage, während Sie sie schreiben, und unterstreicht, was sie nicht lesen kann: eine offene Klammer, ein falsch gesetzter Einzug, ein doppelter Schlüssel. Bewegen Sie den Mauszeiger über eine Unterstreichung, um das Problem zu sehen. Wenn in einer Zeile mehrere Probleme auftreten, werden diese nummeriert, sodass Sie sie voneinander unterscheiden können.

Dies ist eine Überprüfung der Syntax der Vorlage, nicht ihres Inhalts. Der Editor weiß nicht, welche Ressourcentypen existieren oder welche Eigenschaften sie annehmen. Daher kann eine Vorlage, die aus perfekt geformtem YAML besteht, immer noch falsch sein, und zwar in einer Weise, über die Sie nur CloudFormation Aufschluss geben können. Wählen Sie dafür Validieren.

Validieren Sie eine Vorlage

Bei der Validierung wird die Syntax der Vorlage mit dem Editor und mit der Vorlage überprüft, CloudFormation bevor Sie sie in einem Stack-Vorgang verwenden. Bei beiden Prüfungen wird der aktuelle Entwurf verwendet, einschließlich der Änderungen, die Sie nicht gespeichert haben. Bei einer erfolgreichen CloudFormation Prüfung werden die vom Editor gemeldeten Syntaxfehler nicht außer Kraft gesetzt.

Anmerkung

Template Studio sendet den Entwurf mithilfe des TemplateBody Parameters an die ValidateTemplateAPI. Dieser Parameter hat ein Limit von 51.200 Byte (50 KiB).

Bei einem Entwurf, der dieses Limit überschreitet, sendet Template Studio die Anfrage nicht. CloudFormation Der CloudFormation Scheck ist nicht verfügbar, aber das bedeutet nicht, dass die Vorlage ungültig ist. Der Editor kann immer noch Syntaxfehler melden.

Dieselbe API unterstützt Vorlagen mit einer Größe von bis zu 1 MBTemplateURL. Template Studio lädt keine bearbeiteten Entwürfe zur URL-based Validierung hoch. Sie können die Vorlage in Amazon S3 speichern und sie mithilfe eines Stack-Vorgangs validieren, sofern bestimmte CloudFormation Kontingente eingehalten werden.

Um die Vorlage zu validieren, die Sie gerade bearbeiten

1. Wählen Sie Validieren.

2. Eine Vorlage, die beide Prüfungen besteht, wird als gültig gemeldet.

3. Wenn bei einer der Prüfungen Fehler gefunden werden, überprüfen Sie diese in der Bestätigungsnachricht. Zu den Fehlern im Editor gehören Zeilen- und Spaltennummern. Korrigieren Sie die Fehler im Editor und überprüfen Sie sie erneut.

Eine Vorlage in Amazon S3 speichern

CloudFormation liest Vorlagen für Stack-Operationen aus Amazon S3, sodass Ihre Vorlage durch Speichern für den Rest der Konsole verfügbar ist.

Verwenden Sie dynamische Verweise auf Geheimnisse, die in Secrets Manager gespeichert sind, oder auf sichere Zeichenketten im Systems Manager Parameter Store, anstatt Klartext-Geheimnisse in gespeicherte Vorlagen aufzunehmen. Weitere Informationen finden Sie unter Abrufen von in anderen Diensten gespeicherten Werten mit Hilfe von dynamischen Referenzen.

Um die Vorlage zu speichern, die Sie gerade bearbeiten

1. Wählen Sie Save and continue aus.

2. Überprüfen Sie das Ziel. Standardmäßig wird die Vorlage in den Amazon S3 S3-Bucket verschoben, der aktuell die hochgeladenen Vorlagen CloudFormation verwaltet AWS-Region. Wenn dieser Bucket noch nicht existiert, CloudFormation wird er beim Speichern erstellt und für Vorlagen wiederverwendet, die Sie später speichern.

   1. Wenn Sie stattdessen Ihr eigenes Ziel wählen möchten, wählen Sie Anderes Bucket verwenden und geben Sie einen Bucket-Namen ein. Der Bucket wird erstellt, falls er noch nicht existiert.

3. Wählen Sie Bestätigen und fortfahren.

Anmerkung

In Amazon S3 gespeicherte Vorlagen werden zu den Amazon S3-Standardtarifen abgerechnet, unabhängig davon, in welchem Bucket sie gespeichert sind. Weitere Informationen finden Sie unter Amazon S3 – Preise.

Für das Speichern ist kein erfolgreiches Überprüfungsergebnis erforderlich. Wenn bei der Überprüfung Fehler gefunden werden, fordert Template Studio Sie auf, zu bestätigen, dass Sie trotzdem speichern möchten. Durch das Speichern werden diese Fehler nicht behoben. Überprüfen und korrigieren Sie sie, bevor Sie die Vorlage in einem Stapelvorgang verwenden.

Kopieren oder laden Sie eine Vorlage oder ein Diagramm herunter

Wählen Sie Vorlagenaktionen, um die Vorlage oder das Diagramm aus der Konsole zu entfernen:

Vorlage kopieren

Kopiert die Vorlage, so wie sie im Editor erscheint, in Ihre Zwischenablage.

Vorlage herunterladen

Speichert die Vorlage als Datei in dem Format, in dem Sie gerade bearbeiten.

Laden Sie das Ressourcendiagramm herunter

Speichert das Diagramm als PNG-Bild. Da es sich bei dem Bild um eine Aufnahme des Diagramms handelt, ist diese Option nur verfügbar, wenn das Diagramm auf dem Bildschirm angezeigt wird.