AWS-EnableDocDbClusterBackupRetentionPeriod - AWS Systems Manager Referenz zum Automatisierungs-Runbook

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-EnableDocDbClusterBackupRetentionPeriod

Beschreibung

Das AWS-EnableDocDbClusterBackupRetentionPeriod Runbook ermöglicht eine Aufbewahrungsfrist für Backups für den von Ihnen angegebenen Amazon DocumentDB-Cluster. Diese Funktion legt die Gesamtzahl der Tage fest, für die ein automatisiertes Backup aufbewahrt wird. Um einen Cluster zu ändern, muss sich der Cluster im verfügbaren Status mit dem Engine-Typ befindendocdb.

Führen Sie diese Automatisierung aus (Konsole)

Art des Dokuments

Automatisierung

Eigentümer

Amazon

Plattformen

Linux,macOS, Windows

Parameter

  • AutomationAssumeRole

    Typ: Zeichenfolge

    Beschreibung: (Optional) Der Amazon-Ressourcenname (ARN) der Rolle AWS Identity and Access Management (IAM), der 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.

  • DBClusterResourceId

    Typ: Zeichenfolge

    Beschreibung: (Erforderlich) Die Ressourcen-ID für den Amazon DocumentDB-Cluster, für den Sie die Aufbewahrungsfrist für Backups aktivieren möchten.

  • BackupRetentionPeriod

    Typ: Ganzzahl

    Beschreibung: (Erforderlich) Die Anzahl der Tage, für die automatische Backups aufbewahrt werden. Muss ein Wert zwischen 7 und 35 Tagen sein.

  • PreferredBackupWindow

    Typ: Zeichenfolge

    Beschreibung: (Optional) Ein täglicher Zeitbereich in Universal Time Coordinated (UTC) im Format hh24:mm-hh24:mm, zum Beispiel 07:14-07:44. Der Wert muss mindestens 30 Minuten betragen und darf nicht mit dem bevorzugten Wartungsfenster in Konflikt geraten.

  • ssm:GetAutomationExecution

  • ssm:StartAutomationExecution

  • docdb:DescribeDBClusters

  • docdb:ModifyDBCluster

  • rds:DescribeDBClusters

  • rds:ModifyDBCluster

Dokumentschritte

  • GetDocDbClusterIdentifier (aws:executeAwsApi) — Gibt die Amazon DocumentDB-Cluster-ID unter Verwendung der angegebenen Ressourcen-ID zurück.

  • VerifyDocDbEngine (aws:assertAwsResourceProperty) — Überprüft, ob der Amazon DocumentDB DocumentDB-Engine-Typ docdb dazu dient, unbeabsichtigte Änderungen an anderen Amazon-Engine-Typen zu verhindern. RDS

  • VerifyDocDbStatus (aws:waitAwsResourceProperty) — Überprüft, ob der Amazon DocumentDB-Clusterstatus lautet. available

  • ModifyDocDbRetentionPeriod (aws:executeAwsApi) — Legt die Aufbewahrungsdauer anhand der angegebenen Werte für den angegebenen Amazon DocumentDB-Cluster fest.

  • VerifyDocDbBackupsEnabled (aws:executeScript) — Überprüft, ob der Aufbewahrungszeitraum für den Amazon DocumentDB-Cluster und das bevorzugte Backup-Fenster, falls angegeben, erfolgreich festgelegt wurden.

Ausgaben

ModifyDocDbRetentionPeriod. ModifyDbClusterResponse - Antwort von der ModifyDBCluster API Operation.

VerifyDocDbBackupsEnabled. VerifyDbClusterBackupsEnabledResponse — Ausgabe des VerifyDocDbBackupsEnabled Schritts zur Bestätigung der erfolgreichen Änderung des Amazon DocumentDB-Clusters.