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á. # Gerenciamento de clusters elásticos do Amazon DocumentDB Para gerenciar um cluster elástico do Amazon DocumentDB, é necessário ter uma política do IAM com as permissões de ambiente de gerenciamento apropriadas do Amazon DocumentDB. Essas permissões permitem criar, modificar e excluir clusters. A política de DBFull acesso a documentos da Amazon fornece todas as permissões necessárias para administrar um cluster elástico do Amazon DocumentDB. Os tópicos a seguir mostram como realizar várias tarefas ao trabalhar com clusters elásticos do Amazon DocumentDB. **Topics** + [Como modificar configurações de clusters elásticos](#elastic-modify) + [Como monitorar um cluster elástico](#elastic-monitor) + [Como excluir um cluster elástico](#elastic-delete) + [Como gerenciar snapshots de cluster elástico](elastic-manage-snapshots.md) + [Interromper e iniciar um cluster elástico do Amazon DocumentDB](elastic-cluster-stop-start.md) + [Manutenção dos clusters elásticos do Amazon DocumentDB](elastic-cluster-maintenance.md) ## Como modificar configurações de clusters elásticos Nesta seção, explicamos como modificar o cluster elástico usando Console de gerenciamento da AWS ou AWS CLI com as instruções a seguir. O principal uso da modificação do cluster é escalar fragmentos aumentando ou diminuindo a capacidade computacional do fragmento de contagem and/or de fragmentos. ------ #### [ Using the Console de gerenciamento da AWS ] Para modificar uma configuração de cluster elástico usando Console de gerenciamento da AWS: 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Clusters**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Na lista de clusters, escolha o nome do cluster que deseja modificar na coluna **Identificador do Cluster**. 1. Escolha **Modificar**. 1. Edite os campos que você deseja alterar e selecione **Modificar cluster** . ![\[Formulário mostrando as opções de configuração, manutenção, autenticação e configurações de rede que podem ser modificadas, com o botão Modificar cluster no canto inferior direito.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/cluster-shard-modify-3.png) **nota** Como alternativa, é possível acessar a caixa de diálogo **Modificar cluster** acessando a página **Clusters**, marcando a caixa ao lado do cluster e escolhendo **Ações** e, em seguida, **Modificar**. ------ #### [ Using the AWS CLI ] Para modificar uma configuração de cluster elástico usando o AWS CLI, use a `update-cluster` operação com os seguintes parâmetros: + **--cluster-arn**—Obrigatório. O identificador ARN do cluster que você deseja excluir. + **--shard-capacity**—Opcional. O número de v CPUs atribuído a cada fragmento. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64. + **--shard-count**—Opcional. O número de fragmentos atribuídos ao cluster. O máximo é 32. + **--shard-instance**-count: opcional. O número de instâncias de réplica que se aplicam a todos os fragmentos desse cluster. O máximo é 16. + **--auth-type**—Opcional. O tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são `PLAIN_TEXT` ou `SECRET_ARN`. + **--admin-user-password**—Opcional. A senha associada ao usuário administrativo. + **--vpc-security-group-ids**—Opcional. Configure uma lista de grupos de segurança do Amazon EC2 e da Nuvem privada virtual (VPC) para associar a esse cluster. + **--preferred-maintenance-window**—Opcional. O período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC) O formato é: `ddd:hh24:mi-ddd:hh24:mi`. Dias válidos (ddd): Mon, Tue, Wed, Thu, Fri, Sat, Sun O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de tempo de 8 horas para cada região da Amazon Web Services, ocorrendo em um dia da semana aleatório. Janela mínima de 30 minutos. + **--subnet-ids**—Opcional. Configure IDs de sub-rede de rede. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic update-cluster \ --cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 \ --shard-capacity 8 \ --shard-count 4 \ --shard-instance-count 3 \ --admin-user-password testPassword \ --vpc-security-group-ids ec-65f40350 \ --subnet-ids subnet-9253c6a3, subnet-9f1b5af9 ``` Para Windows: ``` aws docdb-elastic update-cluster ^ --cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ^ --shard-capacity 8 ^ --shard-count 4 ^ --shard-instance-count 3 ^ --admin-user-password testPassword ^ --vpc-security-group-ids ec-65f40350 ^ --subnet-ids subnet-9253c6a3, subnet-9f1b5af9 ``` ------ Para monitorar o status do cluster elástico após sua modificação, consulte Como monitorar um cluster elástico. ## Como monitorar um cluster elástico Nesta seção, explicamos como monitorar seu cluster elástico usando Console de gerenciamento da AWS ou AWS CLI com as instruções a seguir. ------ #### [ Using the Console de gerenciamento da AWS ] Para monitorar uma configuração de cluster elástico usando Console de gerenciamento da AWS: 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Clusters**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Escolha o nome do cluster que você deseja monitorar na coluna **Identificador do cluster**. 1. Escolha a guia **Monitoramento**. ![\[Informações resumidas do cluster elástico mostradas na guia Monitoramento.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/cluster-shard-monitor-2.png) Vários gráficos da Amazon CloudWatch são exibidos para as seguintes categorias de monitoramento: + Utilização de recursos + Throughput + Operações + Sistema Você também pode acessar a Amazon CloudWatch por meio do Console de gerenciamento da AWS para configurar seu próprio ambiente de monitoramento para seus clusters elásticos. ------ #### [ Using the AWS CLI ] Para monitorar uma configuração específica de cluster elástico usando o AWS CLI, use a `get-cluster` operação com os seguintes parâmetros: + **--cluster-arn**—Obrigatório. O identificador ARN do cluster para o qual você deseja obter informações. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic get-cluster \ --cluster-arn arn:aws:docdb-elastic:us-west-2:123456789012:cluster:/68ffcdf8-e3af-40a3-91e4-24736f2dacc9 ``` Para Windows: ``` aws docdb-elastic get-cluster ^ --cluster-arn arn:aws:docdb:-elastic:us-west-2:123456789012:cluster:/68ffcdf8-e3af-40a3-91e4-24736f2dacc9 ``` A saída dessa operação é semelhante à seguinte: ``` "cluster": { ... "clusterArn": "arn:aws:docdb-elastic:us-west-2:123456789012:cluster:/68ffcdf8-e3af-40a3-91e4-24736f2dacc9", "clusterEndpoint": "stretch-11-477568257630.us-east-1.docdb-elastic.amazonaws.com", "readerEndpoint": "stretch-11-477568257630-ro.us-east-1.docdb-elastic.amazonaws.com", "clusterName": "stretch-11", "shardCapacity": 2, "shardCount": 3, "shardInstanceCount: 5, "status": "ACTIVE", ... } ``` Para obter mais informações, consulte `DescribeClusterSnapshot` na Referência da API de gerenciamento de recursos do Amazon DocumentDB. Para visualizar os detalhes de todos os clusters elásticos usando o AWS CLI, use a `list-clusters` operação com os seguintes parâmetros: + **--next-token**—Opcional. Se o número de saída de itens (`--max-results`) for menor do que o número total de itens retornados pelas chamadas de API subjacentes, a saída incluirá um `NextToken` que pode ser passado para um comando subsequente para recuperar o próximo conjunto de itens. + **--max-results**—Opcional. O número total de itens para retornar na saída do comando. Se existirem mais registros do que o valor `max-results` especificado, um token de paginação (`next-token`) será incluído na resposta para que os resultados restantes possam ser recuperados. + Padrão: 100 + Mínimo 20, máximo 100 No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic list-clusters \ --next-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ== \ --max-results 2 ``` Para Windows: ``` aws docdb-elastic list-clusters ^ --next-token eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ== ^ --max-results 2 ``` A saída dessa operação é semelhante à seguinte: ``` { "Clusters": [ { "ClusterIdentifier":"mycluster-1", "ClusterArn":"arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster" "Status":"available", "ClusterEndpoint":"sample-cluster.sharded-cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com" } { "ClusterIdentifier":"mycluster-2", "ClusterArn":"arn:aws:docdb:us-west-2:987654321098:sharded-cluster:sample-cluster" "Status":"available", "ClusterEndpoint":"sample-cluster2.sharded-cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com" } ] } ``` ------ ## Como excluir um cluster elástico Nesta seção, explicamos como excluir um cluster elástico usando Console de gerenciamento da AWS ou AWS CLI com as instruções a seguir. ------ #### [ Using the Console de gerenciamento da AWS ] Para excluir uma configuração de cluster elástico usando o Console de gerenciamento da AWS: 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Clusters**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Na tabela da lista de cluster, marque a caixa de seleção à esquerda do nome do cluster que você deseja excluir e escolha **Ações**. No menu suspenso, escolha **Excluir**. 1. Na caixa de diálogo **Excluir cluster elástico "nome-do-cluster"**, escolha **Excluir**. ![\[Caixa de diálogo Excluir, com o botão Excluir no canto inferior direito.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/cluster-delete-dialog.png) A exclusão do cluster demora alguns minutos. Para monitorar o status do cluster, consulte [Como monitorar o status de um cluster do Amazon DocumentDB](https://docs.aws.amazon.com//documentdb/latest/developerguide/monitoring_docdb-cluster_status.html). ------ #### [ Using the AWS CLI ] Para excluir um cluster elástico usando o AWS CLI, use a `delete-cluster` operação com os seguintes parâmetros: + **--cluster-arn**—Obrigatório. O identificador ARN do cluster que deseja excluir. + **--no-skip-final-backup**—Opcional. Se você desejar um backup final, inclua esse parâmetro com um nome para o backup final. É necessário incluir `--final-backup-identifier` ou `--skip-final-backup`. + **--skip-final-backup**—Opcional. Use esse parâmetro somente se você não quiser obter um snapshot final antes de excluir seu cluster. A configuração padrão é obter uma captura de tela final. Os exemplos de AWS CLI código a seguir excluem um cluster com um ARN de arn:aws:docdb:us-west- 2:123456789012:sharded-cluster:sample-cluster com um backup final. No exemplo a seguir, substitua cada um *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic delete-cluster \ --cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster \ --no-skip-final-backup \ --final-backup-identifier finalArnBU-arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ``` Para Windows: ``` aws docdb-elastic delete-cluster ^ --cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ^ --no-skip-final-backup ^ --final-backup-identifier finalArnBU-arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ``` Os exemplos de AWS CLI código a seguir excluem um cluster com um ARN de arn:aws:docdb:us-west- 2:123456789012:sharded-cluster:sample-cluster sem fazer um backup final. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic delete-cluster \ --cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster \ --skip-final-backup \ ``` Para Windows: ``` aws docdb-elastic delete-cluster ^ --cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ^ --skip-final-backup ^ ``` A saída da operação `delete-cluster` é o cluster que você está excluindo. A exclusão do cluster demora alguns minutos. Para monitorar o status do cluster, consulte [Como monitorar o status de um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/monitoring_docdb-cluster_status.html). ------ # Como gerenciar snapshots de cluster elástico Os snapshots manuais podem ser obtidos após a criação de um cluster elástico. Os backups automatizados são criados no momento em que o snapshot do cluster elástico é criado. **nota** O cluster deve estar no estado `Available` para que um snapshot automático seja obtido. Esta seção explica como é possível criar, visualizar, restaurar e excluir snapshots de clusters elásticos. Os tópicos a seguir mostram como realizar várias tarefas ao trabalhar com snapshots de clusters elásticos do Amazon DocumentDB. **Topics** + [Como criar um snapshot manual de cluster](#elastic-create-snapshot) + [Como visualizar um snapshot de cluster elástico](#elastic-view-snapshot) + [Como restaurar um cluster usando um snapshot](#elastic-restore-snapshot) + [Copiar um snapshot de cluster elástico](#elastic-copy-snapshot) + [Como excluir um snapshot de cluster elástico](#elastic-delete-snapshot) + [Gerenciar um backup automático de snapshot de cluster elástico](#elastic-auto-snapshot) ## Como criar um snapshot manual de cluster Nesta seção, explicamos como criar um snapshot manual de cluster elástico usando Console de gerenciamento da AWS ou AWS CLI com as instruções a seguir. ------ #### [ Using the Console de gerenciamento da AWS ] Para criar um snapshot manual de cluster elástico usando o Console de gerenciamento da AWS: 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Snapshots**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Na página **Snapshots**, selecione **Criar**. 1. Na página **Criar snapshot do cluster**, no campo **Identificador do cluster**, escolha seu cluster elástico na lista suspensa. No campo **Identificador de snapshot**, insira um identificador exclusivo para seu cluster elástico. Escolha **Criar**. ![\[Diagrama: snapshot de criação de cluster elástico\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/elastic-create-snapshot.png) **nota** Como alternativa, é possível acessar a caixa de diálogo **Criar snapshot de cluster** acessando a página **Clusters**, marcando a caixa ao lado do seu cluster e escolhendo **Ações** e, em seguida, **Tirar snapshot**. Agora, seu snapshot de cluster elástico está sendo provisionado. Esse processo pode levar até alguns minutos. É possível visualizar e restaurar a partir do seu snapshot quando os status `Available` for exibido na lista **Snapshots**. ------ #### [ Using the AWS CLI ] Para criar um snapshot manual de cluster elástico usando o AWS CLI, use a `create-cluster-snapshot` operação com os seguintes parâmetros: + **--snapshot-name**—Obrigatório. O nome do snapshot a partir do qual será criado um novo cluster. + **--cluster-arn**—Obrigatório. O identificador ARN do cluster do qual você deseja criar um snapshot. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic create-cluster-snapshot \ --snapshot-name sample-snapshot-1 \ --cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ``` Para Windows: ``` aws docdb-elastic create-cluster-snapshot ^ --snapshot-name sample-snapshot-1 ^ --cluster-arn arn:aws:docdb:us-west-2:123456789012:sharded-cluster:sample-cluster ``` ------ ## Como visualizar um snapshot de cluster elástico Nesta seção, explicamos como visualizar informações de snapshots de clusters elásticos usando Console de gerenciamento da AWS ou AWS CLI com as instruções a seguir. ------ #### [ Using the Console de gerenciamento da AWS ] Para visualizar informações sobre um snapshot de cluster elástico específico usando: Console de gerenciamento da AWS 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Snapshots**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Na página **Snapshots**, escolha seu snapshot na lista clicando no nome na coluna **Identificador do snapshot**. 1. Visualize as informações do seu snapshot em **Detalhes**. ![\[Diagrama: snapshot de visualização do cluster elástico\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/elastic-snapshot-view.png) ------ #### [ Using the AWS CLI ] Para visualizar informações sobre um snapshot de cluster elástico específico usando o AWS CLI, use a `get-cluster-snapshot` operação com os seguintes parâmetros: + **--snapshot-arn**—Obrigatório. O identificador ARN do snapshot do qual você deseja informações. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic get-cluster-snapshot \ --snapshot-arn sampleResourceName ``` Para Windows: ``` aws docdb-elastic get-cluster-snapshot ^ --snapshot-arn sampleResourceName ``` Para visualizar informações sobre um snapshot de cluster elástico específico usando o AWS CLI, use a `get-cluster-snapshot` operação com os seguintes parâmetros: + **--snapshot-arn**—Obrigatório. O identificador ARN do snapshot do qual você deseja informações. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic get-cluster-snapshot \ --snapshot-arn sampleResourceName ``` Para Windows: ``` aws docdb-elastic get-cluster-snapshot ^ --snapshot-arn sampleResourceName ``` Para visualizar informações sobre todos os snapshots de clusters elásticos usando o AWS CLI, use a `list-cluster-snapshots` operação com os seguintes parâmetros: + **--snapshot-type**—Opcional. O tipo de snapshots de cluster a ser retornado. É possível especificar um dos seguintes valores: + `automated`- Retorne todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para AWS sua conta. + `manual`- Retorne todos os instantâneos do cluster que você criou manualmente para sua AWS conta. + `shared`- Retorne todos os instantâneos manuais do cluster que foram compartilhados em sua AWS conta. + `public` - retorna todos os snapshots do cluster que foram marcados como públicos. + **--next-token**—Opcional. Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `max-results`. + **--max-results**—Opcional. O número máximo de registros a serem incluídos na resposta. Se existirem mais resultados do que o valor `max-results` especificado, um token de paginação (`next-token`) será incluído na resposta para que os resultados restantes possam ser recuperados. + Padrão: 100 + Mínimo 20, máximo 100 No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic list-cluster-snapshots \ --snapshot-type value \ --next-token value \ --max-results 50 ``` Para Windows: ``` aws docdb-elastic list-cluster-snapshots ^ --snapshot-type value ^ --next-token value ^ --max-results 50 ``` ------ ## Como restaurar um cluster usando um snapshot Nesta seção, explicamos como restaurar um cluster elástico a partir de um snapshot, usando Console de gerenciamento da AWS ou AWS CLI com as instruções a seguir. ------ #### [ Using the Console de gerenciamento da AWS ] Para restaurar um cluster elástico de um snapshot de cluster usando a Console de gerenciamento da AWS: 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Snapshots**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Escolha o botão à esquerda do snapshot que você quer usar para restaurar um cluster, na coluna **Identificador de snapshot**. 1. Em **Ações**, escolha **Restaurar**. ![\[Diagrama: restauração de cluster elástico a partir de um snapshot\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/elastic-restore-snapshot.png) 1. Na página **Restaurar snapshot**, insira um nome para o novo cluster no campo **Identificador do cluster**. **nota** Para qualquer restauração manual de snapshots, você deve criar um novo cluster. 1. No campo **Nuvem Privada Virtual (VPC)**, escolha uma VPC da lista suspensa. 1. Em **Sub-redes** e **Grupos de segurança de VPC**, é possível usar os padrões ou selecionar três sub-redes de sua escolha e até três grupos de segurança de VPC (no mínimo um). 1. Se você estiver satisfeito com a configuração de cluster, escolha **Restore cluster (Restaurar cluster)** e aguarde enquanto o cluster é restaurado. ------ #### [ Using the AWS CLI ] Para restaurar um cluster elástico a partir de um snapshot usando o AWS CLI, use a `restore-cluster-from-snapshot` operação com os seguintes parâmetros: + **--cluster-name**—Obrigatório. O nome atual do cluster elástico, conforme inserido durante a criação ou a última modificação. + **--snapshot-arn**—Obrigatório. O identificador ARN do snapshot que está sendo usado para restaurar o cluster. + **--vpc-security-group-ids**—Opcional. Uma lista de grupos de segurança do Amazon EC2 e da Nuvem privada virtual (VPC) para associar a esse cluster. + **--kms-key-id**—Opcional. O identificador da chave do KMS para um cluster criptografado. O identificador da chave KMS é o Amazon Resource Name (ARN) AWS KMS da chave de criptografia. Se você estiver criando um cluster com a mesma conta da Amazon Web Services que tem a chave de criptografia KMS usada para criptografar o novo cluster, use o apelido da chave do KMS em vez de o ARN da chave de criptografia do KMS. Se uma chave de criptografia não for especificada em KmsKeyId e se o `StorageEncrypted` parâmetro for verdadeiro, o Amazon DocumentDB usará sua chave de criptografia padrão. + **--subnet-ids**—Opcional. IDs de sub-rede da rede. No exemplo a seguir, substitua cada um *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic restore-cluster-from-snapshot \ --cluster-name elastic-sample-cluster \ --snapshot-arn sampleResourceName \ --vpc-security-group-ids value ec-65f40350 \ --kms-key-id arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 \ --subnet-ids subnet-9253c6a3, subnet-9f1b5af9 ``` Para Windows: ``` aws docdb-elastic restore-cluster-from-snapshot ^ --cluster-name elastic-sample-cluster ^ --snapshot-arn sampleResourceName ^ --vpc-security-group-ids value ec-65f40350 ^ --kms-key-id arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ^ --subnet-ids subnet-9253c6a3, subnet-9f1b5af9 ``` ------ ## Copiar um snapshot de cluster elástico No Amazon DocumentDB, é possível copiar snapshots manuais e automáticos de cluster elástico na mesma região e na mesma conta. Nesta seção, explicamos como copiar um snapshot de cluster elástico usando o Console de gerenciamento da AWS ou AWS CLI. ------ #### [ Using the Console de gerenciamento da AWS ] Para copiar um snapshot de cluster elástico usando: Console de gerenciamento da AWS 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Snapshots**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Escolha o botão à esquerda do snapshot que você quer copiar na coluna **Identificador de snapshot**. 1. Escolha **Ações** e **Copiar**. ![\[Diagrama: snapshot de cópia de cluster elástico\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-copy-snapshot.png) 1. Em **Identificador do novo snapshot**, insira o nome do novo snapshot. 1. Em **Copiar tags**, marque a caixa se quiser copiar todas as tags do snapshot do cluster elástico de origem no snapshot do cluster elástico de destino. 1. Para **Criptografia**, escolha uma chave AWS KMS padrão ou uma chave KMS de sua escolha. A segunda opção permite selecionar uma chave KMS existente que você já criou ou permite criar uma nova. 1. Escolha **Copiar snapshot** ao concluir. ------ #### [ Using the AWS CLI ] Para copiar um snapshot de cluster elástico usando o AWS CLI, use a `copy-cluster-snapshot` operação com os seguintes parâmetros: + **‐‐source-db-cluster-snapshot-identifier**—Obrigatório. O identificador do snapshot do cluster elástico existente a ser copiado. O snapshot do cluster elástico deve existir e estar no estado disponível. Esse parâmetro não diferencia maiúsculas de minúsculas. + **‐‐target-db-cluster-snapshot-identifier**—Obrigatório. O identificador do novo snapshot de cluster elástico a ser criado a partir do snapshot de cluster existente. Esse parâmetro não diferencia maiúsculas de minúsculas. Restrições de nome do snapshot de destino: + Não pode ser o nome de um snapshot existente. + O comprimento é de [1 a 63] letras, números ou hífens. + O primeiro caractere deve ser uma letra. + Não pode terminar com um hífen ou conter dois hifens consecutivos. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic copy-cluster-snapshot \ ‐‐source-cluster-snapshot-arn \ ‐‐target-cluster-snapshot-name my-target-copied-snapshot ``` Para Windows: ``` aws docdb-elastic copy-cluster-snapshot ^ ‐‐source-cluster-snapshot-arn ^ ‐‐target-cluster-snapshot-name my-target-copied-snapshot ``` ------ ## Como excluir um snapshot de cluster elástico Nesta seção, explicamos como excluir um snapshot de cluster elástico usando o Console de gerenciamento da AWS ou AWS CLI. ------ #### [ Using the Console de gerenciamento da AWS ] Para restaurar um cluster elástico de um snapshot de cluster usando a Console de gerenciamento da AWS: 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Snapshots**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Escolha o botão à esquerda do snapshot que você quer usar para restaurar um cluster, na coluna **Identificador de snapshot**. 1. Escolha **Ações** e **Excluir**. ![\[Diagrama: exclusão de snapshot de cluster elástico\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/elastic-delete-snapshot.png) 1. Na caixa de diálogo **Excluir snapshot “nome-do-snapshot”**, escolha **Excluir**. ------ #### [ Using the AWS CLI ] Para excluir um snapshot de cluster elástico usando o AWS CLI, use a `delete-cluster-snapshot` operação com os seguintes parâmetros: + **--snapshot-arn**—Obrigatório. O identificador ARN do snapshot que está sendo usado para restaurar o cluster. No exemplo a seguir, substitua cada um *user input placeholder* por suas próprias informações. Para Linux, macOS ou Unix: ``` aws docdb-elastic delete-cluster-snapshot \ --snapshot-arn sampleResourceName ``` Para Windows: ``` aws docdb-elastic delete-cluster-snapshot ^ --snapshot-arn sampleResourceName ``` ------ ## Gerenciar um backup automático de snapshot de cluster elástico O Amazon DocumentDB tira snapshots diários de seus clusters elásticos. É possível especificar a janela de backup preferencial e o período de retenção de backup em uma configuração de snapshot de cluster elástico nova ou existente. Nesta seção, explicamos como definir parâmetros de backup automático em um snapshot de cluster elástico, usando o Console de gerenciamento da AWS ou AWS CLI. ------ #### [ Using the Console de gerenciamento da AWS ] Para definir um backup automático para um novo snapshot de cluster elástico usando: Console de gerenciamento da AWS 1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb/home?region=us-east-1) e abra o console do Amazon DocumentDB. 1. No painel de navegação, escolha **Clusters**. **dica** Se você não visualizar o painel de navegação à esquerda da tela, selecione o ícone do menu no canto superior esquerdo da página. 1. Escolha o botão à esquerda do cluster no qual você quer alterar as configurações de backup, na coluna **Identificador de cluster**. 1. Selecione **Ações** e **Modificar**. 1. Na seção **Backup**, edite os campos de acordo com os requisitos do seu backup. ![\[Captura de tela do painel Backup mostrando as etapas para configurar a janela de backup do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-backup.png) 1. **Período de retenção de backup**— na lista, selecione o número de dias para manter os backups automáticos desse cluster antes de excluí-los. 1. **Janela de backup**— defina o tempo e duração diários durante os quais o Amazon DocumentDB fará backups desse cluster. 1. Escolha **Selecionar janela** se quiser configurar a hora e a duração em que os backups são criados. **Hora de início**: na primeira lista, escolha a hora de início (UTC) para seus backups automáticos. Na segunda lista, escolha o minuto da hora em que você deseja que os backups automáticos sejam iniciados. **Duração**— na lista, selecione a quantidade de horas a serem alocadas na criação de backups automáticos. 1. Escolha **Sem preferência** se quiser que o Amazon DocumentDB escolha a hora e a duração em que os backups são criados. 1. Escolha **Modificar cluster** quando estiver concluído. ------ #### [ Using the AWS CLI ] Para definir um backup automático para um novo snapshot de cluster elástico usando o AWS CLI, use a `create-cluster-snapshot` operação com os seguintes parâmetros: + **--preferred-backup-window**—Opcional. O intervalo de tempo diário preferencial, durante o qual os backups automatizados são criados. O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de 8 horas para cada uma. Região da AWS Restrições: + Deve estar no formato `hh24:mi-hh24:mi`. + Deve estar expresso no Tempo Universal Coordenado (UTC). + Não pode entrar em conflito com a janela de manutenção preferencial. + Deve ser, pelo menos, 30 minutos. + **--backup-retention-period**— opcional. O número de dias durante os quais os backups automatizados são retidos. O valor padrão é 1. Restrições: + É preciso especificar o valor mínimo de 1. + Varia de 1 a 35. **nota** Os backups automatizados são feitos somente quando o cluster está no estado “ativo”. **nota** Você também pode modificar os parâmetros `preferred-backup-window` e `backup-retention-period` de um cluster elástico existente usando o comando `aws docdb-elastic update-cluster`. No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. O `create-cluster` exemplo a seguir cria o cluster elástico Amazon DocumentDB *sample-cluster* com o período de retenção para backups automáticos de *7* dias e uma janela de backup preferencial de. *18:00-18:30 UTC* Para Linux, macOS ou Unix: ``` aws docdb-elastic create-cluster \ --cluster-name sample-cluster \ --shard-capacity 2 \ --shard-count 2 \ --admin-user-name SampleAdmin \ --auth-type PLAIN_TEXT \ --admin-user-password SamplePass123! \ --preferred-backup-window 18:00-18:30 \ --backup-retention-period 7 ``` Para Windows: ``` aws docdb-elastic create-cluster ^ --cluster-name sample-cluster ^ --shard-capacity 2 ^ --shard-count 2 ^ --admin-user-name SampleAdmin ^ --auth-type PLAIN_TEXT ^ --admin-user-password SamplePass123! ^ --preferred-backup-window 18:00-18:30 ^ --backup-retention-period 7 ``` ------ # Interromper e iniciar um cluster elástico do Amazon DocumentDB Interromper e iniciar clusters elásticos do Amazon DocumentDB pode ajudar a gerenciar os custos dos ambientes de teste e desenvolvimento. Em vez de criar e excluir clusters elásticos toda vez que você usar o Amazon DocumentDB, você pode interromper temporariamente seu cluster quando não for necessário. Depois, é possível iniciá-lo novamente, ao retomar os testes. **Topics** + [Visão geral de como interromper e iniciar um cluster elástico](#elastic-cluster-stop-start-overview) + [Operações que você pode realizar em um cluster elástico interrompido](#elastic-cluster-stopped-operations) ## Visão geral de como interromper e iniciar um cluster elástico Durante os períodos nos quais não precisar de um cluster elástico do Amazon DocumentDB, você pode interromper o cluster. Depois, você pode iniciar o cluster novamente a qualquer momento, sempre que precisar usá-lo. Iniciar e interromper simplifica os processos de configuração e destruição dos clusters elásticos usados em desenvolvimento, teste ou atividades afins que não exijam disponibilidade contínua. Você pode parar e iniciar um cluster elástico usando o Console de gerenciamento da AWS ou o AWS CLI com uma única ação. Enquanto o cluster elástico estiver interrompido, o volume de armazenamento do cluster permanecerá inalterado. Serão cobrados somente o armazenamento, as captura de telas manuais e o armazenamento do backup automatizado dentro da janela de retenção especificada. O Amazon DocumentDB iniciará automaticamente seu cluster elástico depois de sete dias para garantir que ele não perca nenhuma atualização de manutenção necessária. Quando o cluster reiniciar após sete dias, você começará a ser cobrado pelo uso do cluster elástico novamente. Enquanto o cluster está interrompido, não é possível consultar o volume de armazenamento porque a consulta requer que o cluster esteja no estado disponível. Quando um cluster elástico do Amazon DocumentDB é interrompido, não pode ser modificado de maneira alguma. Isso inclui sua exclusão. ------ #### [ Using the Console de gerenciamento da AWS ] O procedimento a seguir mostra como interromper um cluster elástico com no estado disponível ou iniciar um cluster elástico interrompido. **Para interromper ou iniciar um cluster elástico do Amazon DocumentDB** 1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb) 1. No painel de navegação, escolha **Clusters**. **dica** Caso não visualize o painel de navegação à esquerda da tela, selecione o ícone do menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página. 1. Na lista de clusters, escolha o botão à esquerda do nome do cluster que você deseja interromper ou iniciar. ![\[Um cluster da lista Clusters, com a caixa de seleção marcada à esquerda do nome do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/cluster-list-ec.png) 1. Escolha **Ações** e selecione a ação que deseja executar no cluster. + Se você quiser interromper o cluster e ele estiver disponível: 1. Escolha **Parar**. ![\[A lista suspensa Ações com a opção Parar selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-stop.png) 1. Na caixa de diálogo de confirmação, confirme se deseja interromper o cluster elástico escolhendo **Interromper cluster** ou, para manter o cluster em execução, escolha **Cancelar**. ![\[Caixa de diálogo de confirmação para interromper um cluster, com os botões Cancelar e Parar cluster na parte inferior.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-stop-confirm.png) + Se quiser iniciar o cluster e o cluster estiver interrompido, escolha **Iniciar**. ![\[A lista suspensa Ações com a opção Iniciar selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-start.png) 1. Monitorar o status do cluster elástico. Se você iniciou o cluster, poderá retomar seu uso quando ele estiver *disponível*. Para obter mais informações, consulte [Determinar o status de um cluster](db-cluster-status.md). ![\[Coluna de status na tabela Clusters mostrando os status disponíveis e os iniciais.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-starting-status.png) ------ #### [ Using the AWS CLI ] Os exemplos de código a seguir mostram como interromper um cluster elástico no estado ativo ou disponível ou iniciar um cluster elástico interrompido. Para parar um cluster elástico usando o AWS CLI, use a `stop-cluster` operação. Para iniciar um cluster interrompido, use a operação `start-cluster`. Ambas as operações usam o parâmetro `--cluster-arn`. **Parâmetro** + **--cluster-arn**—Obrigatório. O identificador ARN do cluster elástico que deseja interromper ou iniciar. **Example — Para parar um cluster elástico usando o AWS CLI** No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. O código a seguir interrompe o cluster elástico com o ARN `arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2`. O cluster elástico deve estar no estado ativo ou disponível. Para Linux, macOS ou Unix: ``` aws docdb-elastic stop-cluster \ --cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ``` Para Windows: ``` aws docdb-elastic stop-cluster ^ --cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ``` **Example — Para iniciar um cluster elástico usando o AWS CLI** No exemplo a seguir, substitua cada *user input placeholder* por suas próprias informações. O código a seguir inicia o cluster elástico com o ARN `arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2`. O cluster elástico deve estar interrompido no momento. Para Linux, macOS ou Unix: ``` aws docdb-elastic start-cluster \ --cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ``` Para Windows: ``` aws docdb-elastic start-cluster ^ --cluster-arn arn:aws:docdb-elastic:us-east-1:477568257630:cluster/b9f1d489-6c3e-4764-bb42-da62ceb7bda2 ``` ------ ## Operações que você pode realizar em um cluster elástico interrompido Não é possível modificar a configuração de um cluster elástico do Amazon DocumentDB enquanto o cluster estiver interrompido. Será necessário iniciar o cluster antes de realizar uma dessas ações administrativas. O Amazon DocumentDB aplicará as manutenções programadas em seu cluster elástico interrompido somente depois que for reiniciado. Após sete dias, o Amazon DocumentDB inicia automaticamente um cluster elástico interrompido, para que não fique muito atrasado em seu status de manutenção. Quando o cluster elástico for reiniciado, você começará a ser cobrado pelos fragmentos no cluster novamente. Enquanto um cluster elástico estiver interrompido, o Amazon DocumentDB não executa quaisquer backups automatizados, nem estende o período de retenção de backup. # Manutenção dos clusters elásticos do Amazon DocumentDB **Topics** + [Visualização de ações pendentes de manutenção de clusters elásticos](#view-elastic-cluster-maintenance) + [Atualizações do mecanismo de cluster elástico](#elastic-cluster-engine-updates) + [Atualizações do sistema operacional do cluster elástico](#elastic-cluster-os-updates) Periodicamente, o Amazon DocumentDB realiza a manutenção em seus recursos de clusters elásticos. Geralmente, a manutenção envolve atualizações do mecanismo de banco de dados (manutenção do cluster elástico) ou do sistema operacional (SO) subjacente ao cluster elástico (manutenções de SO). As atualizações do mecanismo de banco de dados são patches obrigatórios e incluem correções de segurança, correções de bugs e aprimoramentos no mecanismo de banco de dados. Embora a maioria dos patches do sistema operacional sejam opcionais, se você não os aplicar por algum tempo, o patch poderá ser necessário e aplicado automaticamente para manter sua postura de segurança. Portanto, recomendamos que você aplique atualizações do sistema operacional aos seus clusters elásticos do Amazon DocumentDB assim que elas estiverem disponíveis. Os patches do mecanismo de banco de dados exigem que você coloque os clusters elásticos do Amazon DocumentDB offline por um curto período. Uma vez disponíveis, esses patches são automaticamente programados para serem aplicados durante uma próxima janela de manutenção programada do seu cluster elástico do Amazon DocumentDB. Os clusters elásticos têm suas próprias janelas de manutenção respectivas. As modificações no cluster elástico e na instância que você optou por não aplicar imediatamente são aplicadas durante a janela de manutenção. Por padrão, quando você cria um cluster elástico, o Amazon DocumentDB atribui uma janela de manutenção ao seu cluster elástico. É possível escolher a janela de manutenção ao criar um cluster elástico. Você também pode modificar as janelas de manutenção a qualquer momento para atender às suas programações ou práticas comerciais. Em geral, é recomendável escolher janelas de manutenção que minimizem o impacto da manutenção em sua aplicação (por exemplo, em noites ou fins de semana). ## Visualização de ações pendentes de manutenção de clusters elásticos É possível ver se uma atualização de manutenção está disponível para o seu cluster elástico usando a AWS CLI. Se uma atualização estiver disponível, será possível executar uma das seguintes ações: + Adiar uma ação de manutenção atualmente programada para a próxima janela de manutenção (somente para patches do sistema operacional). + Aplicar as ações de manutenção imediatamente. + Agendar as ações de manutenção para serem iniciadas durante a próxima janela de manutenção. + Agende as ações de manutenção para serem iniciadas durante sua próxima janela de manutenção. A janela de manutenção determina quando as operações pendentes começam, mas não limita o tempo total de execução dessas operações. Use a AWS CLI operação a seguir para determinar quais ações de manutenção estão pendentes. Liste todas as ações de manutenção pendentes: ``` aws docdb-elastic list-pending-maintenance-actions ``` A saída dessa operação é semelhante ao seguinte (formato JSON): ``` { 'ResourcePendingMaintenanceActions': [ { 'ResourceArn': 'string-arn', 'PendingMaintenanceActionDetails': [ { 'Action': 'ENGINE_UPDATE', 'AutoAppliedAfterDate': 'string', 'ForcedApplyDate': 'string', 'OptInStatus': 'string', 'CurrentApplyDate': 'string', 'Description': 'string' }, ] }, ], 'NextToken': 'string' } ``` Obtenha uma ação de manutenção pendente (se houver) em um determinado `resourceArn`: ``` aws docdb-elastic get-pending-maintenance-action --resource-arn string-arn ``` A saída dessa operação é semelhante ao seguinte (formato JSON). ``` { 'ResourcePendingMaintenanceAction': { 'ResourceArn': 'string-arn', 'PendingMaintenanceActionDetails': [ { 'Action': 'ENGINE_UPDATE', 'AutoAppliedAfterDate': 'string', 'ForcedApplyDate': 'string', 'OptInStatus': 'string', 'CurrentApplyDate': 'string', 'Description': 'string' } ] } } ``` Parâmetros: + `ResourceArn`: o nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica. + `Action`: o tipo de ação de manutenção pendente sendo aplicada ao recurso. Valores válidos: + `ENGINE_UPDATE` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` + `AutoAppliedAfterDate`: primeira janela de manutenção após essa data. `NEXT_MAINTENANCE OPT_IN` é ignorado nesse caso. + `ForcedApplyDate`: aplicada independentemente da janela de manutenção. `IMMEDIATE OPT_IN` é ignorado nesse caso. + `OptInStatus` - um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `IMMEDIATE` não pode ser desfeita. Valores válidos: + `IMMEDIATE` – aplique a ação de manutenção imediatamente. + `NEXT_MAINTENANCE` - Aplique a ação de manutenção durante a próxima janela de manutenção do recurso. + `APPLY_ON`: aplica a ação de manutenção na data de aplicação especificada, independentemente da próxima janela de manutenção do recurso. + `UNDO_OPT_IN`: cancela quaisquer solicitações de inclusão de `NEXT_MAINTENANCE` ou `APPLY_ON` existentes. + `CurrentApplyDate`—Exibido se opt-in-type for`APPLY_ON`. + `Description`: uma descrição da opção para a ação de manutenção. ## Atualizações do mecanismo de cluster elástico Com o Amazon DocumentDB, você pode escolher quando aplicar operações de manutenção. É possível decidir quando o Amazon DocumentDB deve aplicar as atualizações usando a AWS CLI. Aplicação de ações de manutenção pendentes: ``` aws docdb-elastic apply-pending-maintenance-action --resource-arn string-arn --apply-action string-enum --opt-in-type string-enum [--apply-on string-date-range] ``` Parâmetros: + **--resource-arn**: o nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica. + **--apply-action** - a ação de manutenção pendente a ser aplicada a esse recurso. Valores válidos: + `ENGINE_UPDATE` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` + **--opt-in-type** - um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `IMMEDIATE` não pode ser desfeita. Valores válidos: + `IMMEDIATE` – aplique a ação de manutenção imediatamente. + `NEXT_MAINTENANCE` - Aplique a ação de manutenção durante a próxima janela de manutenção do recurso. + `APPLY_ON`: aplica a ação de manutenção na data de aplicação especificada, independentemente da próxima janela de manutenção do recurso. + `UNDO_OPT_IN`: cancela quaisquer solicitações de inclusão de `NEXT_MAINTENANCE` ou `APPLY_ON` existentes. + **[--apply-on]**: obrigatório se opt-in-type for `APPLY_ON`. Formato: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` (Essa opção usa a hora UTC. A hora de início pode ser a qualquer momento no futuro, a partir de no mínimo 30 minutos e no máximo 14 dias, ou a force/apply data da ação pendente, o que ocorrer primeiro. A janela de horário do início ao fim pode durar no mínimo 30 minutos e no máximo 8 horas.) A saída dessa operação é semelhante ao seguinte (formato JSON): ``` { 'ResourcePendingMaintenanceAction': { 'ResourceArn': 'string-arn', 'PendingMaintenanceActionDetails': [ { 'Action': 'SECURITY_UPDATE', 'AutoAppliedAfterDate': 'string', 'ForcedApplyDate': 'string', 'OptInStatus': 'IMMEDIATE', 'CurrentApplyDate': 'string', 'Description': 'string' }, ] } } ``` Parâmetros: + `ResourceArn`: o nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplica. + `Action`: o tipo de ação de manutenção pendente sendo aplicada ao recurso. Valores válidos: + `ENGINE_UPDATE` + `ENGINE_UPGRADE` + `SECURITY_UPDATE` + `OS_UPDATE` + `MASTER_USER_PASSWORD_UPDATE` + `AutoAppliedAfterDate`: primeira janela de manutenção após essa data. `NEXT_MAINTENANCE OPT_IN` é ignorado nesse caso. + `ForcedApplyDate`: aplicada independentemente da janela de manutenção. `IMMEDIATE OPT_IN` é ignorado nesse caso. + `OptInStatus` - um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `IMMEDIATE` não pode ser desfeita. Valores válidos: + `IMMEDIATE` – aplique a ação de manutenção imediatamente. + `NEXT_MAINTENANCE` - Aplique a ação de manutenção durante a próxima janela de manutenção do recurso. + `APPLY_ON`: aplica a ação de manutenção na data de aplicação especificada, independentemente da próxima janela de manutenção do recurso. + `UNDO_OPT_IN`: cancela quaisquer solicitações de inclusão de `NEXT_MAINTENANCE` ou `APPLY_ON` existentes. + `CurrentApplyDate`—Exibido se opt-in-type for`APPLY_ON`. + `Description`: uma descrição da opção para a ação de manutenção. ### Aplicar datas Cada ação de manutenção tem uma respectiva data de aplicação que você pode encontrar ao descrever as ações de manutenção pendentes. Quando você lê o resultado das ações de manutenção pendentes do AWS CLI, três datas são listadas: + `CurrentApplyDate` - Data em que a ação de manutenção será aplicada imediatamente ou durante a próxima janela de manutenção. Se a manutenção for opcional, esse valor poderá ser nulo. + `ForcedApplyDate` - Data em que a manutenção será aplicada automaticamente, independente de sua janela de manutenção. + `AutoAppliedAfterDate` - Data depois da qual a manutenção será aplicada durante a janela de manutenção do cluster. ### Ações de manutenção criadas pelo usuário Como usuário do DBelastic cluster Amazon Document, você pode iniciar atualizações nas configurações do seu cluster. **Atualização da senha primária do cluster** ``` aws docdb-elastic update-cluster --cluster-arn string-arn [--admin-user-password string] [--auth-type string-enum] [--apply-method string-enum] [--apply-on string-date-range] #... other parameters of the API that follow here are not relevant for this configuration ``` Parâmetros: + **--cluster-arn**: o nome do recurso da Amazon (ARN) do Amazon DocumentDB do recurso ao qual a ação de manutenção pendente se aplicará. + **[--admin-user-password]**: a senha associada ao usuário administrativo. + **[--auth-type]**: o tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são `PLAIN_TEXT` e `SECRET_ARN`. + **[--apply-method]**: um valor que especifica o tipo de método que está sendo aplicado. Os valores permitidos são `IMMEDIATE` e `APPLY_ON`. O padrão é `IMMEDIATE`. + **[--apply-on]**: obrigatório se `apply-method` for `APPLY_ON`. Formato: `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm` (Esta opção utiliza o horário UTC. O horário de início pode ser em qualquer momento no futuro, com um intervalo mínimo de 30 minutos e máximo de 14 dias. O intervalo de tempo entre o início e o término pode ter um mínimo de 30 minutos e um máximo de 8 horas.) A saída dessa operação é semelhante ao seguinte (formato JSON): ``` { 'ResourcePendingMaintenanceAction': { 'ResourceArn': 'string-arn', 'PendingMaintenanceActionDetails': [ { 'Action': 'MASTER_USER_PASSWORD_UPDATE', 'OptInStatus': 'APPLY_ON', 'CurrentApplyDate': 'string', 'Description': 'string' }, ] } } ``` ### Gerenciar suas janelas de manutenção do Amazon DocumentDB A janela de manutenção deve ser definida no horário de menor utilização e, portanto, talvez precise ser alterada de vez em quando. Seu cluster elástico estará indisponível durante esse tempo somente se as alterações do sistema (como uma alteração de operação de armazenamento em escala) estiverem sendo aplicadas e exigirem uma interrupção. Ele estará indisponível apenas pelo intervalo mínimo de tempo necessário para fazer as alterações necessárias. O padrão é uma janela de 30 minutos selecionada aleatoriamente a partir de um bloco de tempo de 8 horas para cada região da Amazon Web Services, ocorrendo em um dia da semana aleatório. Para alterar a janela de manutenção, consulte [Como modificar configurações de clusters elásticos](elastic-managing.md#elastic-modify). ## Atualizações do sistema operacional do cluster elástico Os clusters elásticos do Amazon DocumentDB ocasionalmente exigem atualizações do sistema operacional. O Amazon DocumentDB faz upgrade do sistema operacional para uma versão mais recente para melhorar a performance do banco de dados e o procedimento de segurança geral dos clientes. As atualizações de sistema operacional não alteram a versão do mecanismo do cluster de um cluster elástico do Amazon DocumentDB. A maioria das atualizações do sistema operacional para clusters elásticos do Amazon DocumentDB são opcionais e não têm uma data definida para serem aplicadas. Contudo, se você não aplicar essas atualizações por um tempo, elas poderão eventualmente se tornar necessárias e aplicadas automaticamente durante a janela de manutenção dos seus clusters. Isso ajuda a manter a postura de segurança de seu banco de dados. Para evitar qualquer tempo de inatividade inesperado, recomendamos que você aplique atualizações do sistema operacional aos seus clusters elásticos do Amazon DocumentDB assim que elas estiverem disponíveis e defina a janela de manutenção do seu cluster no momento de sua conveniência, de acordo com as necessidades de sua organização.