Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Amazon DocumentDB
<a name="automation-ref-docdb"></a>

AWS Systems Manager Automation fournit des runbooks prédéfinis pour Amazon DocumentDB (compatibles avec MongoDB). Pour plus d’informations sur les runbooks, consultez [Travailler avec des runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents.html). Pour plus d'informations sur l'affichage du contenu du runbook, consultez[Afficher le contenu du runbook](automation-runbook-reference.md#view-automation-json). 

**Topics**
+ [`AWS-EnableDocDbClusterBackupRetentionPeriod`](aws-enabledocdbclusterbackupretentionperiod.md)

# `AWS-EnableDocDbClusterBackupRetentionPeriod`
<a name="aws-enabledocdbclusterbackupretentionperiod"></a>

 **Description** 

 Le `AWS-EnableDocDbClusterBackupRetentionPeriod` runbook active une période de conservation des sauvegardes pour le cluster Amazon DocumentDB que vous spécifiez. Cette fonctionnalité définit le nombre total de jours pendant lesquels une sauvegarde automatique est conservée. Pour modifier un cluster, celui-ci doit être dans l'état disponible avec un type de moteur de`docdb`. 

 [Exécuter cette automatisation (console)](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-EnableDocDbClusterBackupRetentionPeriod) 

**Type de document**

 Automatisation

**Propriétaire**

Amazon

**Plateformes**

Linux, macOS, Windows

**Paramètres**
+ AutomationAssumeRole

  Type : String

  Description : (Facultatif) Le nom de ressource Amazon (ARN) du rôle Gestion des identités et des accès AWS (IAM) qui permet à Systems Manager Automation d'effectuer les actions en votre nom. Si aucun rôle n'est spécifié, Systems Manager Automation utilise les autorisations de l'utilisateur qui lance ce runbook.
+ DBClusterResourceId

  Type : String

  Description : (Obligatoire) L'ID de ressource du cluster Amazon DocumentDB pour lequel vous souhaitez activer la période de conservation des sauvegardes.
+ BackupRetentionPeriod

  Type : entier

  Description : (Obligatoire) Nombre de jours pendant lesquels les sauvegardes automatisées sont conservées. Doit être une valeur comprise entre 7 et 35 jours.
+ PreferredBackupWindow

  Type : String

  Description : (Facultatif) Une plage horaire quotidienne en temps universel coordonné (UTC) au format hh24:mm-hh24:mm, par exemple 07:14-07:44. La valeur doit être d'au moins 30 minutes et ne doit pas entrer en conflit avec le créneau de maintenance préféré.
+ `ssm:GetAutomationExecution`
+ `ssm:StartAutomationExecution`
+ `docdb:DescribeDBClusters`
+ `docdb:ModifyDBCluster`
+ `rds:DescribeDBClusters`
+ `rds:ModifyDBCluster`

 **Étapes de document** 
+ GetDocDbClusterIdentifier (`aws:executeAwsApi`) - Renvoie l'identifiant du cluster Amazon DocumentDB à l'aide de l'ID de ressource fourni.
+ VerifyDocDbEngine (`aws:assertAwsResourceProperty`) - Vérifie que le type de moteur Amazon DocumentDB `docdb` est destiné à empêcher toute modification involontaire d'autres types de moteurs Amazon RDS.
+ VerifyDocDbStatus (`aws:waitAwsResourceProperty`) - Vérifie que l'état du cluster Amazon DocumentDB est. `available` 
+ ModifyDocDbRetentionPeriod (`aws:executeAwsApi`) - Définit la période de rétention à l'aide des valeurs fournies pour le cluster Amazon DocumentDB spécifié. 
+ VerifyDocDbBackupsEnabled (`aws:executeScript`) - Vérifie que la période de rétention pour le cluster Amazon DocumentDB et que la fenêtre de sauvegarde préférée, si elle est spécifiée, ont été correctement définies. 

 **Sorties** 

ModifyDocDbRetentionPeriod. ModifyDbClusterResponse - Réponse de l'opération `ModifyDBCluster` API.

VerifyDocDbBackupsEnabled. VerifyDbClusterBackupsEnabledResponse - Résultat de l'`VerifyDocDbBackupsEnabled`étape de confirmation de la modification réussie du cluster Amazon DocumentDB.