As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

AWS Systems Manager A automação fornece runbooks predefinidos para o Amazon DocumentDB (com compatibilidade com o MongoDB). Para obter informações sobre como usar runbooks, consulte [Trabalhado com runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents.html). Para obter informações sobre como visualizar o conteúdo do runbook, consulte [Exibir conteúdo do runbook](automation-runbook-reference.md#view-automation-json). 

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

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

 **Descrição** 

 O `AWS-EnableDocDbClusterBackupRetentionPeriod` runbook permite um período de retenção de backup para o cluster Amazon DocumentDB que você especificar. Esse recurso define o número total de dias durante os quais um backup automatizado é retido. Para modificar um cluster, o cluster deve estar no estado disponível com um tipo de mecanismo de`docdb`. 

 [Executar esta automação (console)](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-EnableDocDbClusterBackupRetentionPeriod) 

**Tipo de documento**

Automação

**Proprietário**

Amazon

**Plataformas**

Linux, macOS, Windows

**Parâmetros**
+ AutomationAssumeRole

  Tipo: String

  Descrição: (opcional) o nome do recurso da Amazon (ARN) do perfil do AWS Identity and Access Management (IAM) que permite que o Systems Manager Automation realize ações em seu nome. Se nenhum perfil for especificado, o Systems Manager Automation usa as permissões do usuário que inicia este runbook.
+ DBClusterResourceId

  Tipo: string

  Descrição: (Obrigatório) O ID do recurso para o cluster Amazon DocumentDB para o qual você deseja habilitar o período de retenção de backup.
+ BackupRetentionPeriod

  Tipo: inteiro

  Descrição: (Obrigatório) O número de dias durante os quais os backups automatizados são retidos. Deve ser um valor de 7 a 35 dias.
+ PreferredBackupWindow

  Tipo: string

  Descrição: (Opcional) Um intervalo de tempo diário em Tempo Universal Coordenado (UTC) no formato hh24:mm-hh24:mm, por exemplo, 07:14-07:44. O valor deve ser de pelo menos 30 minutos e não pode entrar em conflito com a janela de manutenção preferida.
+ `ssm:GetAutomationExecution`
+ `ssm:StartAutomationExecution`
+ `docdb:DescribeDBClusters`
+ `docdb:ModifyDBCluster`
+ `rds:DescribeDBClusters`
+ `rds:ModifyDBCluster`

 **Etapas do documento** 
+ GetDocDbClusterIdentifier (`aws:executeAwsApi`) - Retorna o identificador do cluster Amazon DocumentDB usando o ID do recurso fornecido.
+ VerifyDocDbEngine (`aws:assertAwsResourceProperty`) - Verifica se o tipo de mecanismo Amazon DocumentDB `docdb` é para evitar alterações inadvertidas em outros tipos de mecanismo do Amazon RDS.
+ VerifyDocDbStatus (`aws:waitAwsResourceProperty`) - Verifica se o status do cluster Amazon DocumentDB é. `available` 
+ ModifyDocDbRetentionPeriod (`aws:executeAwsApi`) - Define o período de retenção usando os valores fornecidos para o cluster Amazon DocumentDB especificado. 
+ VerifyDocDbBackupsEnabled (`aws:executeScript`) - Verifica se o período de retenção do cluster Amazon DocumentDB e a janela de backup preferencial, se especificada, foram configurados com sucesso. 

 **Saídas** 

ModifyDocDbRetentionPeriod. ModifyDbClusterResponse - Resposta da operação `ModifyDBCluster` da API.

VerifyDocDbBackupsEnabled. VerifyDbClusterBackupsEnabledResponse - Saída da `VerifyDocDbBackupsEnabled` etapa que confirma a modificação bem-sucedida do cluster Amazon DocumentDB.