AWS-EnableDocDbClusterBackupRetentionPeriod - AWS Systems Manager Referencia del manual de automatización

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

AWS-EnableDocDbClusterBackupRetentionPeriod

Descripción

El AWS-EnableDocDbClusterBackupRetentionPeriod runbook habilita un período de retención de copias de seguridad para el clúster de Amazon DocumentDB que especifique. Esta función establece el número total de días durante los que se conserva una copia de seguridad automática. Para modificar un clúster, el clúster debe estar en el estado disponible con un tipo de motor dedocdb.

Ejecuta esta automatización (consola)

Tipo de documento

Automatización

Propietario

Amazon

Plataformas

Linux, macOS, Windows

Parámetros

  • AutomationAssumeRole

    Tipo: cadena

    Descripción: (opcional) el Nombre de recurso de Amazon (ARN) del rol de AWS Identity and Access Management (IAM) que permite a Systems Manager Automation realizar las acciones en su nombre. Si no se especifica ningún rol, Systems Manager Automation utiliza los permisos del usuario que comienza este manual de procedimientos.

  • DBClusterResourceId

    Tipo: cadena

    Descripción: (obligatorio) El ID de recurso del clúster de Amazon DocumentDB para el que desea habilitar el período de retención de copias de seguridad.

  • BackupRetentionPeriod

    Tipo: entero

    Descripción: (obligatorio) El número de días durante los que se conservan las copias de seguridad automatizadas. Debe tener un valor de 7 a 35 días.

  • PreferredBackupWindow

    Tipo: cadena

    Descripción: (opcional) Un intervalo de tiempo diario en hora universal coordinada (UTC) con el formato hh24:mm-hh24:mm, por ejemplo, 07:14-07:44. El valor debe ser de al menos 30 minutos y no puede entrar en conflicto con el período de mantenimiento preferido.

  • ssm:GetAutomationExecution

  • ssm:StartAutomationExecution

  • docdb:DescribeDBClusters

  • docdb:ModifyDBCluster

  • rds:DescribeDBClusters

  • rds:ModifyDBCluster

Pasos de documentos

  • GetDocDbClusterIdentifier (aws:executeAwsApi) - Devuelve el identificador del clúster de Amazon DocumentDB utilizando el ID de recurso proporcionado.

  • VerifyDocDbEngine (aws:assertAwsResourceProperty) - Comprueba que el tipo de motor de Amazon DocumentDB docdb es para evitar cambios inadvertidos en otros tipos de motor de Amazon RDS.

  • VerifyDocDbStatus (aws:waitAwsResourceProperty) - Verifica que el estado del clúster de Amazon DocumentDB sea. available

  • ModifyDocDbRetentionPeriod (aws:executeAwsApi) - Establece el período de retención mediante los valores proporcionados para el clúster de Amazon DocumentDB especificado.

  • VerifyDocDbBackupsEnabled (aws:executeScript) - Verifica que el período de retención del clúster de Amazon DocumentDB y la ventana de respaldo preferida, si se especificó, se hayan establecido correctamente.

Salidas

ModifyDocDbRetentionPeriod. ModifyDbClusterResponse - Respuesta de la operación de la ModifyDBCluster API.

VerifyDocDbBackupsEnabled. VerifyDbClusterBackupsEnabledResponse - Resultado del VerifyDocDbBackupsEnabled paso que confirma la modificación correcta del clúster de Amazon DocumentDB.