View a markdown version of this page

Arbeiten mit Systems Manager Automation-Dokumenten - AWS Toolkit für VS Code

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.

Arbeiten mit Systems Manager Automation-Dokumenten

AWS Systems Manager bietet Ihnen Transparenz und Kontrolle über Ihre Infrastruktur AWS. Systems Manager bietet eine einheitliche Benutzeroberfläche, sodass Sie Betriebsdaten aus mehreren AWS Diensten einsehen und Betriebsaufgaben für Ihre AWS Ressourcen automatisieren können.

Ein Systems-Manager-Dokument definiert die Aktionen, die Systems Manager auf Ihren verwalteten Instances durchführt. Ein Automatisierungsdokument ist eine Art Systems Manager-Dokument, mit dem Sie allgemeine Wartungs- und Bereitstellungsaufgaben wie das Erstellen oder Aktualisieren eines Amazon Machine Image (AMI) ausführen. In diesem Thema wird beschrieben, wie Sie Automatisierungsdokumente mit erstellen, bearbeiten, veröffentlichen und löschen AWS Toolkit for Visual Studio Code.

Annahmen und Voraussetzungen

Bevor Sie beginnen, stellen Sie Folgendes sicher:

IAM-Berechtigungen für Dokumente zur Automatisierung von Systems Manager

Im Toolkit für VS Code benötigen Sie ein Anmeldeinformationsprofil, das die AWS Identity and Access Management (IAM-) Berechtigungen enthält, die zum Erstellen, Bearbeiten, Veröffentlichen und Löschen von Systems Manager Automation-Dokumenten erforderlich sind. Das folgende Richtliniendokument definiert die erforderlichen IAM-Berechtigungen, die in einer Hauptrichtlinie verwendet werden können:

JSON
{ "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:ListDocuments", "ssm:ListDocumentVersions", "ssm:DescribeDocument", "ssm:GetDocument", "ssm:CreateDocument", "ssm:UpdateDocument", "ssm:UpdateDocumentDefaultVersion", "ssm:DeleteDocument" ], "Resource": "*" } ] }

Informationen zum Aktualisieren einer IAM-Richtlinie finden Sie unter Erstellen von IAM-Richtlinien im IAM-Benutzerhandbuch. Informationen zur Einrichtung Ihres Anmeldeinformationsprofils finden Sie unter. AWS IAM-Anmeldeinformationen

Ein neues Systems Manager Automation-Dokument erstellen

Sie können ein neues Automatisierungsdokument in JSON oder YAML mit Visual Studio Code erstellen. Wenn Sie ein neues Automatisierungsdokument erstellen, wird es in einer Datei ohne Titel angezeigt. Sie können Ihre Datei benennen und in VS Code speichern, der Name der Datei ist jedoch nicht sichtbar für. AWS

Um ein neues Automatisierungsdokument zu erstellen
  1. Öffnen Sie VS Code.

  2. Wählen Sie im Menü Ansicht die Option Befehlspalette, um die Befehlspalette zu öffnen.

  3. Geben Sie in der Befehlspalette den Befehl AWS Toolkit Ein neues Systems Manager-Dokument lokal erstellen ein.

  4. Wählen Sie eine der Startervorlagen für ein Hello-World-Beispiel aus.

  5. Wählen Sie JSON oder YAML.

    Ein neues Automatisierungsdokument wird erstellt.

Anmerkung

Ihr neues Automatisierungsdokument in VS Code erscheint nicht automatisch in AWS. Sie müssen es veröffentlichen, AWS bevor Sie es ausführen können.

Ein vorhandenes Systems Manager Automation-Dokument öffnen

Sie verwenden den AWS Explorer, um vorhandene Systems Manager Automation-Dokumente zu finden. Wenn Sie ein vorhandenes Automation-Dokument öffnen, wird es in VS Code als Datei ohne Titel angezeigt.

Um Ihr Automatisierungsdokument zu öffnen
  1. Öffnen Sie VS Code.

  2. Wählen Sie in der linken Navigationsleiste aus, ob Sie AWS den AWS Explorer öffnen möchten.

  3. Wählen Sie im AWS Explorer für Systems Manager das Download-Symbol auf dem Dokument, das Sie öffnen möchten, und wählen Sie dann die Dokumentversion aus. Die Datei wird im Format für diese Version geöffnet. Andernfalls wählen Sie entweder Als JSON herunterladen oder Als YAML herunterladen.

Anmerkung

Wenn Sie ein Automatisierungsdokument lokal als Datei in VS Code speichern, wird es nicht in AWS angezeigt. Es muss AWS vor der Ausführung veröffentlicht werden.

Bearbeitung eines Systems Manager Automation-Dokuments

Wenn Sie Besitzer von Automation-Dokumenten sind, werden diese in der Kategorie „Mein Eigentum“ der Systems Manager-Dokumente im AWS Explorer angezeigt. Sie können Eigentümer von Automation-Dokumenten sein, die bereits in VS Code vorhanden sind AWS, und Sie können Eigentümer neuer oder aktualisierter Dokumente sein, für die Sie zuvor AWS von VS Code aus veröffentlicht haben.

Wenn Sie ein Automation-Dokument zur Bearbeitung in VS Code öffnen, können Sie mehr damit machen als im AWS-Managementkonsole. Beispiel:

  • Es gibt eine Schemavalidierung für beide JSON YAML Formate.

  • Im Dokumenteditor stehen Schnipsel zur Verfügung, mit denen Sie alle Arten von Automatisierungsschritten erstellen können.

  • In und wird die automatische Vervollständigung für verschiedene Optionen unterstützt. JSON YAML

Arbeiten mit Versionen

In Systems Manager Automation-Dokumenten werden Versionen für das Änderungsmanagement verwendet. Sie können die Standardversion für ein Automatisierungsdokument in VS Code auswählen.

Legen Sie eine Standardversion fest wie folgt
  • Navigieren Sie im AWS Explorer zu dem Dokument, für das Sie die Standardversion festlegen möchten, öffnen Sie das Kontextmenü (Rechtsklick) für das Dokument und wählen Sie Standardversion festlegen.

    Anmerkung

    Wenn das ausgewählte Dokument nur eine Version enthält, können Sie den Standardwert nicht ändern.

Ein Systems Manager Automation-Dokument veröffentlichen

Nachdem Sie Ihr Automatisierungsdokument in VS Code bearbeitet haben, können Sie es unter veröffentlichen AWS.

Um Ihr Automatisierungsdokument zu veröffentlichen
  1. Öffnen Sie das Automatisierungsdokument, das Sie veröffentlichen möchten, mithilfe des unter beschriebenen VerfahrensEin vorhandenes Systems Manager Automation-Dokument öffnen.

  2. Nehmen Sie die Änderungen vor, die veröffentlicht werden sollen. Weitere Informationen finden Sie unter Bearbeitung eines Systems Manager Automation-Dokuments.

  3. Wählen Sie oben rechts in der geöffneten Datei das Upload-Symbol.

  4. Wählen Sie im Dialogfeld für den Veröffentlichungsworkflow die AWS Region aus, in der Sie das Automatisierungsdokument veröffentlichen möchten.

  5. Wenn Sie ein neues Dokument veröffentlichen, wählen Sie „Schnell erstellen“. Wählen Sie andernfalls Quick Update, um ein vorhandenes Automatisierungsdokument in dieser AWS Region zu aktualisieren.

  6. Geben Sie den Namen für dieses Automatisierungsdokument ein.

Wenn Sie ein Update für ein vorhandenes Automation-Dokument veröffentlichen AWS, wird dem Dokument eine neue Version hinzugefügt.

Löschen eines Systems Manager Automation-Dokuments

Sie können Automatisierungsdokumente in VS Code löschen. Durch das Löschen eines Automatisierungsdokuments werden das Dokument und alle Versionen des Dokuments gelöscht.

Wichtig
  • Löschen ist eine zerstörerische Aktion, die nicht rückgängig gemacht werden kann.

  • Durch das Löschen eines Automatisierungsdokuments, das bereits ausgeführt wurde, werden die AWS Ressourcen nicht gelöscht, die beim Start erstellt oder geändert wurden.

Um Ihr Automatisierungsdokument zu löschen
  1. Öffnen Sie VS Code.

  2. Wählen Sie in der linken Navigationsleiste, ob Sie AWS den AWS Explorer öffnen möchten.

  3. Öffnen Sie im AWS Explorer für Systems Manager das Kontextmenü (Rechtsklick) für das Dokument, das Sie löschen möchten, und wählen Sie Dokument löschen.

Ein Systems Manager Automation-Dokument wird ausgeführt

Sobald Ihr Automation-Dokument veröffentlicht wurde AWS, können Sie es ausführen, um Aufgaben in Ihrem Namen in Ihrem AWS Konto auszuführen. Um Ihr Automatisierungsdokument auszuführen, verwenden Sie die AWS-Managementkonsole, die Systems Manager-APIs AWS CLI, die oder die AWS -Tools für PowerShell. Anweisungen zum Ausführen eines Automatisierungsdokuments finden Sie unter Ausführen einer einfachen Automatisierung im AWS Systems Manager Benutzerhandbuch.

Wenn Sie eines der AWS SDKs zusammen mit den Systems Manager-APIs verwenden möchten, um Ihr Automatisierungsdokument auszuführen, lesen Sie alternativ die AWS SDK-Referenzen.

Anmerkung

Durch die Ausführung eines Automatisierungsdokuments können neue Ressourcen erstellt werden, AWS und es können Abrechnungskosten anfallen. Wir empfehlen dringend, dass Sie wissen, was Ihr Automatisierungsdokument in Ihrem Konto bewirken wird, bevor Sie es starten.