View a markdown version of this page

AWSSupport-EmptyS3Bucket - AWS Systems Manager Runbook-Referenz für Automation

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.

AWSSupport-EmptyS3Bucket

Beschreibung

Das AWSSupport-EmptyS3Bucket Automatisierungs-Runbook leert einen vorhandenen Amazon Simple Storage Service (Amazon S3) -Bucket mithilfe einer Konfigurationsregel für den Ablauf des Lebenszyklus.

Wichtig

  • Amazon S3-Buckets mit aktivierter Multi-factor Authentifizierung (MFA) werden nicht unterstützt.

  • Die durch dieses Runbook geänderten Lebenszyklusregeln löschen dauerhaft alle Objekte und ihre Versionen im angegebenen Amazon S3-Bucket. Sie können dauerhaft gelöschte Objekte nicht wiederherstellen. Weitere Informationen finden Sie unter Ablaufende Objekte.

Wie funktioniert es?

Das Runbook AWSSupport-EmptyS3Bucket führt die folgenden allgemeinen Schritte aus:

  • Unterbricht die Bucket-Versionierung, falls diese aktiviert ist.

  • Aktualisiert die Bucket-Richtlinie so, dass alle s3:PutObject API-Aufrufe abgelehnt werden (um neue Uploads zu verhindern, während sie geleert werden).

  • Aktualisiert die Lebenszyklusregeln, um alle Objekte gemäß den in den Eingabeparametern angegebenen Ablauftagen zu löschen.

Anmerkung

  • Objektversionen, die mit Amazon S3 Object Lock geschützt sind, werden nicht gelöscht oder durch Lebenszykluskonfigurationen überschrieben.

  • Der Löschvorgang ist asynchron und es kann einige Zeit dauern, bis er abgeschlossen ist, nachdem die Runbook-Ausführung abgeschlossen ist.

Führen Sie diese Automatisierung aus (Konsole)

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

/

Erforderliche IAM-Berechtigungen

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden.

Der AutomationAssumeRole Parameter erfordert die folgenden Aktionen, um das Runbook erfolgreich zu verwenden:

  • ssm: DescribeAutomationExecutions

  • ssm: GetAutomationExecution

  • s3: GetBucketVersioning

  • s3: PutBucketVersioning

  • s3: GetBucketPolicy

  • s3: GetBucketLifecycleConfiguration

  • s3: GetLifecycleConfiguration

  • s3: PutBucketPolicy

  • s3: PutBucketLifecycleConfiguration

  • s3: PutLifecycleConfiguration

  • s3: DeleteBucketPolicy

  • s3: DeleteBucketLifecycle

Anweisungen

Folgen Sie diesen Schritten, um die Automatisierung zu konfigurieren:

  1. Navigieren Sie AWSSupport-EmptyS3Bucket im Systems Manager unter Dokumente zu.

  2. Wählen Sie Execute automation (Automatisierung ausführen).

  3. Geben Sie für die Eingabeparameter Folgendes ein:

    • AutomationAssumeRole (Fakultativ):

      Der Amazon-Ressourcenname (ARN) der AWS AWS Identity and Access Management (IAM) -Rolle, die es Systems Manager Automation ermöglicht, die Aktionen in Ihrem Namen durchzuführen. Wenn keine Rolle angegeben ist, verwendet Systems Manager Automation die Berechtigungen des Benutzers, der dieses Runbook startet.

    • S3BucketName:

      Der Name des Amazon S3-Buckets, den Sie leeren möchten.

    • SNSTopicArn:

      Geben Sie den ARN des Amazon SNS-Themas für die Genehmigungsbenachrichtigung an. Dieses Amazon SNS-Thema wird verwendet, um Genehmigungsbenachrichtigungen zu senden, wenn dies während der Ausführung der Automatisierung erforderlich ist.

    • Genehmigt IAM:

      Geben Sie eine Liste der AWS authentifizierten Principals an, die die Aktion entweder genehmigen oder ablehnen können. Die maximale Anzahl von Genehmigern ist. 10 Sie können Prinzipale angeben, indem Sie eines der folgenden Formate verwenden: einen AWS Identity and Access Management (IAM-) Benutzernamen, einen IAM-Benutzer-ARN, einen IAM-Rollen-ARN oder einen Benutzer-ARN mit IAM-Übernahme.

    • MinimumRequiredApprovals(Fakultativ):

      Die erforderliche Mindestanzahl an Genehmigungen zum Fortsetzen der Automatisierung. Wenn Sie keinen Wert angeben, verwendet das System standardmäßig den 1 Wert. Der Wert für diesen Parameter muss eine positive Zahl sein. Der Wert für diesen Parameter darf die Anzahl der Genehmigenden, die durch den Parameter ApproverIam definiert ist, nicht überschreiten.

    • NoncurrentVersionExpirationDays(Fakultativ):

      Geben Sie die Anzahl der Tage an, an denen nicht aktuelle Objektversionen ablaufen. Nach Ablauf löscht Amazon S3 permanent die nicht-aktuellen Objektversionen.

      • Standard: 1

      • Höchstwert: 365

    • ExpirationDays (Fakultativ):

      Geben Sie den Ablauf für den Lebenszyklus des Objekts im Formular Tage an.

      • Standard: 1

      • Maximaler Wert: 365

    • AbortIncompleteMultipartUpload(Fakultativ):

      Geben Sie die Tage seit der Initiierung eines unvollständigen mehrteiligen Uploads an, die Amazon S3 abwartet, bevor alle Teile des Uploads dauerhaft entfernt werden.

      • Standard: 1

      • Maximaler Wert: 365

    • Bestätigung:

      Bitte lesen Sie sich die vollständigen Einzelheiten der von diesem Automatisierungs-Runbook ausgeführten Aktionen durch und geben Sie Ihr Einverständnis, Yes, I understand and acknowledge wenn Sie die Schritte bestätigen.

    Bild mit Beispieleingabeparametern für AWSSupport-EmptyS3Bucket das Dokument.

  4. Wählen Sie Ausführen aus.

  5. Die Automatisierung wird initiiert.

  6. Das Dokument führt die folgenden Schritte aus:

    • checkConcurrency:

      Stellt sicher, dass dieses Runbook nur einmal ausgeführt wird, das auf den angegebenen Amazon S3-Bucket abzielt. Wenn das Runbook eine weitere laufende Ausführung findet, die auf denselben Bucket-Namen abzielt, gibt es einen Fehler zurück und wird beendet.

    • getBucketVersioningConfiguration:

      Ruft den Versionsstatus des angegebenen Amazon S3-Buckets ab.

    • branchOnStoppingIfMFADeleteEnabled(bedingt):

      Stoppt die Automatisierung, wenn die Multi-factor Authentifizierung (MFA) für den angegebenen Amazon S3-Bucket aktiviert ist.

    • approvalToMakeChangesToTheProvidedS3Bucket:

      Wartet auf die Genehmigung des designierten Principals, um die Bucket-Versionierung zu deaktivieren und die Konfiguration der Bucket-Richtlinien und Lebenszyklusregeln für den angegebenen Amazon S3-Bucket zu aktualisieren.

    • branchOnBucketVersioningStatus(bedingt):

      Wenn die Versionierung für den angegebenen Amazon S3-Bucket aktiviert ist, deaktivieren Sie sie, andernfalls fahren Sie mit der Aktualisierung der Bucket-Richtlinie und der Lebenszykluskonfiguration fort.

    • suspendBucketVersioning:

      Unterbricht den Versionierungsstatus des angegebenen Amazon S3-Buckets.

    • updateBucketPolicyAndLifeCycleConfiguration:

      Fügt die Bucket-Richtlinie hinzu oder aktualisiert sie, um alle s3:PutObject Anfragen abzulehnen, und aktualisiert die Lebenszykluskonfiguration so, dass Objekte auf der Grundlage der vom Benutzer angegebenen Eingabeparameter ablaufen.

    • branchOnFailingIfBucketPropertiesNotUpdated(bedingt):

      Überprüft den Status des updateBucketPolicyAndLifeCycleConfiguration Schritts und versucht, den ursprünglichen Bucket-Versionsstatus wiederherzustellen, falls er durch Automatisierung geändert wird.

    • branchOnFailureOriginalVersioningStatus(bedingt):

      Bei einem Fehler erfolgt eine Verzweigung, um den ursprünglichen Versionsstatus zu ermitteln. Wenn es durch diese Automatisierung aktiviert und gesperrt wurde, versucht es erneut zu aktivieren.

    • onFailureRestoreBucketVersioning

      Stellt den aktivierten Versionsstatus des angegebenen Amazon S3-Buckets wieder her.

  7. Wenn Sie fertig sind, finden Sie im Abschnitt Ausgaben die detaillierten Ergebnisse der Ausführung:

    Bild mit der Ausgabe der Ausführung des AWSSupport-EmptyS3Bucket Dokuments, das die erfolgreiche Ausführung und die konfigurierte Lebenszyklusrichtlinie zeigt.

    • Erfolgreiche Ausführung

      Dieser Workflow aktualisiert die Lebenszyklusregel des Buckets. Objekte werden gemäß der Delete-All-AWSSupport-EmptyS3-Bucket Lebenszyklusrichtlinie gelöscht.

      Bild, das die konfigurierte Delete-All-AWSSupport-EmptyS3-Bucket Lebenszyklusrichtlinie enthält.

    • Ausführung eines Fehlers

      Eine teilweise Löschung wird nicht durchgeführt. Schlägt die Ausführung fehl, werden der Lebenszyklus und andere Bucket-Einstellungen zurückgesetzt.

Referenzen

Systems Manager Automation

Weitere Informationen zur Verwaltung von Amazon S3-Buckets und -Objekten finden Sie unter Einen Bucket leeren.