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á.
# Ciclo de vida do cluster do Amazon DocumentDB
O ciclo de vida de um cluster do Amazon DocumentDB inclui a criação, a descrição, a modificação e a exclusão do cluster. Esta seção fornece informações sobre como concluir esses processos.
**Topics**
+ [Criação de um cluster](db-cluster-create.md)
+ [Descrever clusters](db-cluster-view-details.md)
+ [Modificar um cluster](db-cluster-modify.md)
+ [Determinar manutenção pendente](db-cluster-determine-pending-maintenance.md)
+ [Atualizar patch da versão do mecanismo de um cluster](db-cluster-version-upgrade.md)
+ [Interromper e iniciar um cluster](db-cluster-stop-start.md)
+ [Excluir um cluster](db-cluster-delete.md)
# Criar um cluster do Amazon DocumentDB
Um cluster do Amazon DocumentDB consiste em instâncias e em um volume de cluster que representa os dados para o mesmo. O volume do cluster é replicado de seis maneiras em três Zonas de Disponibilidade, como volume único e virtual. O cluster contém uma instância principal e, como opção, até 15 instâncias de réplica.
As seções a seguir mostram como criar um cluster Amazon DocumentDB usando o Console de gerenciamento da AWS ou o. AWS CLI Em seguida, você pode adicionar instâncias de réplica adicionais para esse cluster. Quando o console é usado para criar o cluster do Amazon DocumentDB, uma instância primária é criada automaticamente ao mesmo tempo. Se você usar o AWS CLI para criar seu cluster Amazon DocumentDB, depois que o status do cluster estiver *disponível*, você deverá criar a instância primária para esse cluster.
## Pré-requisitos
Veja a seguir os pré-requisitos para a criação de um cluster do Amazon DocumentDB.
Se você não tiver um Conta da AWS, conclua as etapas a seguir para criar um.
**Para se inscrever em um Conta da AWS**
1. Abra a [https://portal.aws.amazon.com/billing/inscrição.](https://portal.aws.amazon.com/billing/signup)
1. Siga as instruções online.
Parte do procedimento de inscrição envolve receber uma chamada telefônica ou uma mensagem de texto e inserir um código de verificação pelo teclado do telefone.
Quando você se inscreve em um Conta da AWS, um *Usuário raiz da conta da AWS*é criado. O usuário-raiz tem acesso a todos os Serviços da AWS e recursos na conta. Como prática recomendada de segurança, atribua o acesso administrativo a um usuário e use somente o usuário-raiz para executar [tarefas que exigem acesso de usuário-raiz](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#root-user-tasks).
### Pré-requisitos da VPC
É possível criar apenas um cluster do Amazon DocumentDB em uma Amazon Virtual Private Cloud (Amazon VPC). Seu Amazon VPC deve ter no mínimo uma sub-rede em pelo menos duas Zonas de Disponibilidade para que você possa usá-la com um cluster de banco de dados do Amazon DocumentDB. Ao distribuir suas instâncias de cluster por Zonas de Disponibilidade, você garante que as instâncias estejam disponíveis em seu cluster no improvável caso de ocorrer uma falha na Zona de Disponibilidade.
### Pré-requisitos de sub-rede
Ao criar um cluster do Amazon DocumentDB, você deve escolher uma VPC e um grupo de sub-rede correspondente dentro dessa VPC para iniciar o seu cluster. Sub-redes determinam a Zona de Disponibilidade e o intervalo de IP dentro dela para executar uma instância. Para essa discussão, usaremos os termos *sub-rede* e *Zona de Disponibilidade* alternadamente. Um grupo de sub-redes é um conjunto nomeado de sub-redes (ou Zonas de Disponibilidade). Um grupo de sub-redes permite que você especifique as Zonas de Disponibilidade que deseja usar para executar instâncias do Amazon DocumentDB. Por exemplo, em um cluster com três instâncias, a fim de manter a disponibilidade alta, é recomendável que cada uma dessas instâncias seja provisionada em Zonas de Disponibilidade separadas. Dessa forma, se uma única Zona de Disponibilidade falhar, ela só afetará uma única instância.
As instâncias do Amazon DocumentDB podem ser provisionadas atualmente em até três Zonas de Disponibilidade. Mesmo que um grupo tenha mais de três sub-redes, você só pode usar três dessas sub-redes para criar um cluster do Amazon DocumentDB. Como resultado, é recomendável que, ao criar um grupo de sub-redes, você escolha somente as três sub-redes nas quais deseja implantar suas instâncias. No Leste dos EUA (Norte da Virgínia), seu grupo de sua sub-rede pode ter seis sub-redes (ou Zonas de Disponibilidade). No entanto, quando um cluster do Amazon DocumentDB é fornecido, o Amazon DocumentDB escolhe três dessas Zonas de Disponibilidade e as utiliza para fornecer instâncias.
Por exemplo, suponha que, ao criar um cluster, o Amazon DocumentDB escolhe as Zonas de Disponibilidade \$11A, 1B e 1C\$1. Se você tentar criar uma instância na Zona de Disponibilidade \$11D\$1, a chamada de API não será bem-sucedida. Porém, se você optar por criar uma instância sem especificar uma Zona de Disponibilidade específica, o Amazon DocumentDB escolherá uma Zona de Disponibilidade em seu nome. O Amazon DocumentDB usa um algoritmo para balancear a carga das instâncias em todas as Zonas de Disponibilidade, para ajudar a alcançar alta disponibilidade. Por exemplo, se três instâncias forem fornecidas, por padrão, todas serão fornecidas em três Zonas de Disponibilidade, não em uma única Zona de Disponibilidade.
**Recomendações:**
+ A menos que você tenha um motivo específico, sempre crie um grupo de sub-rede com três sub-redes. Isso ajuda a garantir que clusters com três ou mais instâncias alcancem maior disponibilidade, pois as instâncias são provisionadas em três Zonas de Disponibilidade.
+ Sempre distribua instâncias em várias Zonas de Disponibilidade para obter alta disponibilidade. Nunca coloque todas as instâncias de um cluster em uma única Zona de Disponibilidade.
+ Como eventos de failover podem acontecer a qualquer momento, você não deve presumir que uma instância primária ou de réplica estará sempre em uma determinada Zona de Disponibilidade.
### Pré-requisitos adicionais
Veja a seguir alguns pré-requisitos adicionais para criar um cluster do Amazon DocumentDB:
+ Se você estiver se conectando AWS usando credenciais AWS Identity and Access Management (IAM), sua conta do IAM deve ter políticas do IAM que concedam as permissões necessárias para realizar operações do Amazon DocumentDB.
Se você estiver usando uma conta do IAM para acessar o console do Amazon DocumentDB, primeiro faça login Console de gerenciamento da AWS com sua conta do IAM. [Em seguida, acesse o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
+ Se quiser personalizar os parâmetros de configuração do seu cluster, você deverá especificar um grupo de parâmetros do cluster e um grupo de parâmetros com as configurações de parâmetro obrigatórias. Para obter informações sobre como criar ou modificar um grupo de parâmetros de cluster ou um grupo de parâmetros, consulte [Gerenciando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups.md).
+ Você deve determinar o número da TCP/IP porta que deseja especificar para seu cluster. Em algumas empresas, os firewalls bloqueiam conexões com as portas padrão do Amazon DocumentDB. Se o firewall da sua empresa bloquear a porta padrão, escolha outra porta para o cluster. Todas as instâncias em um cluster usam a mesma porta.
## Criação de um cluster e de uma instância primária usando o Console de gerenciamento da AWS
Os procedimentos a seguir descrevem como usar o console para iniciar um cluster do Amazon DocumentDB com uma ou mais instâncias.
### Criar um cluster: uso das configurações padrão
**Para criar um cluster com instâncias usando as configurações padrão usando o Console de gerenciamento da AWS**
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. Se você quiser criar seu cluster em Região da AWS outra região que não seja o Leste dos EUA (Norte da Virgínia), escolha a Região na lista na seção superior direita do console.
1. No painel de navegação, selecione **Clusters** e, em seguida, **Criar**.
**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 página **Criar cluster Amazon DocumentDB**, complete o painel **Configuração**.
1. **Identificador de cluster:** aceite o nome fornecido pelo Amazon DocumentDB ou insira um nome para o seu cluster, como, por exemplo, **sample-cluster**.
Restrições de nomeação de cluster:
+ 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.
+ Deve ser exclusivo para todos os clusters no Amazon RDS, Neptune e Amazon DocumentDB por região. Conta da AWS
1. **Versão do mecanismo** — aceite a versão padrão do mecanismo 5.0.0 ou, opcionalmente, escolha 8.0.0, 4.0.0 ou 3.6.0.
1. **Classe da instância:** aceite o padrão `db.r5.large` ou escolha a classe da instância que deseja usar na lista.
1. **Número de instâncias**— na lista, escolha o número de instâncias que você deseja criar com esse cluster. A primeira instância é a instância primária e todas as outras instâncias são instâncias de réplica somente leitura. É possível adicionar e excluir instâncias posteriormente, se necessário. Por padrão, um cluster do Amazon DocumentDB é iniciado com três instâncias (uma primária e duas réplicas).
1. Preencha a seção **Configuração de armazenamento do cluster**.
Escolha **Amazon DocumentDB Padrão** ou **Amazon DocumentDB Otimizado para E/S**. Para obter mais informações, consulte [Configurações de armazenamento de cluster do Amazon DocumentDB](db-cluster-storage-configs.md).
1. Complete o painel **Autenticação**.
1. **Nome de usuário**: insira um nome para o usuário principal. Para fazer login no cluster, você deve usar o nome do usuário principal.
Restrições de nomenclatura de usuário principal:
+ O comprimento é de [1–63] caracteres alfanuméricos.
+ O primeiro caractere deve ser uma letra.
+ Não pode ser uma palavra reservada pelo mecanismo de banco de dados.
1. Escolha uma das opções de senha a seguir:
+ **Gerenciado em AWS Secrets Manager** —Escolha essa opção se quiser AWS Secrets Manager gerenciar automaticamente sua senha de usuário principal.
Se você escolher essa opção, configure a chave do KMS criando sua própria chave ou usando uma chave criada pelo Secrets Manager.
+ **Autogerenciado**: escolha essa opção se quiser autogerenciar sua senha de usuário principal. Se você escolher essa opção, insira uma senha para o usuário principal e, em seguida, confirme-a. Para fazer login no cluster, você deve usar a senha do usuário principal.
Restrições de senha:
+ O comprimento é de [8–100] caracteres ASCII imprimíveis.
+ Pode usar quaisquer caracteres ASCII imprimíveis, exceto:
+ **/** (barra)
+ **"** (aspas duplas)
+ **@** (arroba)
1. Na parte inferior da tela, escolha uma das seguintes opções:
+ Para criar o cluster agora, escolha **Criar cluster**.
+ Para não criar o cluster, escolha **Cancelar**.
+ Para continuar a configurar o cluster antes de criá-lo, escolha **Mostrar configurações adicionais** e, em seguida, [Criar um cluster: configurações adicionais](#db-cluster-create-con-additional-configs).
As configurações incluídas na seção **Configurações adicionais** são as seguintes:
+ **Configurações de rede**— o padrão é usar o grupo de segurança da VPC `default`.
+ **Opções do cluster**— o padrão é utilizar a porta 27017 e o grupo parâmetro padrão.
+ **Criptografia**— o padrão é habilitar a criptografia usando a chave `(default) aws/rds`.
**Importante**
Depois que um cluster é criptografado, ele não pode ser descriptografado.
+ **Backup**— o padrão é reter os backups por 1 dia e permitir que o Amazon DocumentDB selecione a janela de backup.
+ **Exportações de registros** — o padrão é não exportar registros de auditoria para o CloudWatch Logs.
+ **Manutenção**— o padrão é permitir que o Amazon DocumentDB selecione a janela de manutenção.
+ **Proteção contra exclusão**— protege o seu cluster contra a exclusão acidental. O padrão para cluster criado usando o console é *habilitado*.
Se você aceitar os configurações padrão agora, poderá alterar a maioria delas posteriormente modificando o cluster.
1. Habilite a conexão de entrada para o grupo de segurança do cluster.
Se não alterou as configurações padrão do seu cluster, você criou um cluster usando o grupo de segurança padrão para a VPC padrão na região determinada. Para conectar-se ao Amazon DocumentDB, você deve habilitar conexões de entrada na porta 27017 (ou na porta de sua escolha) para o grupo de segurança do cluster.
**Para adicionar uma conexão de entrada ao seu grupo de segurança do cluster**
1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon EC2 em. [https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/)
1. Na seção **Recursos** da janela principal, escolha **Grupos de segurança**.
![\[Imagem: lista de recursos destacando a opção de link Grupos de Segurança.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-ec2-security-groups.png)
1. Na lista de grupos de segurança, localize o grupo de segurança que você usou ao criar o cluster (é mais provável o grupo de segurança *padrão*) e escolha a caixa à esquerda do nome do grupo de segurança.
![\[Imagem: lista de grupos de segurança destacando um grupo de segurança com a caixa selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-ec2-default-sg.png)
1. No menu **Ações**, escolha **Editar regras de entrada** e, em seguida, escolha ou insira as restrições de regras.
1. **Tipo**— na lista, escolha o protocolo para abrir para o tráfego de rede.
1. **Protocolo**— na lista, escolha o tipo de protocolo.
1. **Intervalo de porta**— para uma regra personalizada, insira um número ou um intervalo de porta. Certifique-se de que o número ou o intervalo de porta inclui a porta que você especificou quando criou o cluster (padrão: 27017).
1. **Origem**— especifica o tráfego que pode alcançar sua instância. Na lista, escolha a origem do tráfego. Se você escolher **Personalizado**, especifique um único endereço IP ou um intervalo de endereços IP em notação CIDR (por exemplo, 203.0.113.5/32).
1. **Descrição**— insira uma descrição para essa regra.
1. Quando terminar de criar a regra, escolha **Salvar**.
### Criar um cluster: configurações adicionais
Se você deseja aceitar as configurações padrão para o seu cluster, pode ignorar as etapas a seguir e escolher **Criar cluster**.
1. Conclua o painel **Configurações de rede**.
![\[Captura de tela mostrando o painel de configurações de rede e as etapas para definir as configurações de rede.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/create-db-cluster-console-network-settings.png)
1. **Nuvem privada virtual (VPC)**— na lista, escolha a nuvem privada virtual Amazon que deseja iniciar nesse cluster.
1. **Grupo de sub-rede**— na lista, escolha o grupo de sub-rede que deseja usar para esse cluster.
1. **Grupos de segurança da VPC**— na lista, escolha o grupo de segurança da VPC para esse cluster.
1. Conclua o painel **Opções do cluster**.
![\[Captura de tela mostrando o painel de opções do cluster com as etapas para definir as configurações do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/create-db-cluster-console-cluster-options.png)
1. **Porta do banco de dados** — Use as setas para cima e para baixo para definir a TCP/IP porta que os aplicativos usarão para se conectar à sua instância.
1. **Grupo de parâmetros do cluster**— na lista de grupos de parâmetros, escolha o grupo de parâmetros para esse cluster.
1. Preencha o painel **Criptografia**.
![\[Captura de tela do painel de criptografia mostrando as etapas para configurar a criptografia do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/encrypt-at-rest.png)
1. **E ncryption-at-rest** — Escolha uma das seguintes opções:
+ **Habilitar criptografia**— padrão. Todos os dados em repouso são criptografados. Se optar por criptografar seus dados, você não poderá desfazer essa ação.
+ **Desabilitar criptografia**— seus dados não estão criptografados.
1. **AWS Chave KMS** — Isso só está disponível se você estiver criptografando seus dados. Na lista, escolha a chave que você deseja usar para criptografar os dados desse cluster. O padrão é `(default) aws/rds`.
Se você escolher **Inserir o ARN da chave**, deverá inserir o nome do recurso da Amazon (ARN) da chave.
1. Preencha o painel **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/create-db-cluster-console-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. **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.
1. **Duração**— na lista, selecione a quantidade de horas a serem alocadas na criação de backups automáticos.
1. Preencha o painel **Exportações de registros** selecionando os tipos de registros que você deseja exportar para o CloudWatch Logs.
![\[Captura de tela do painel Exportações de log mostrando as etapas para configurar o registro em log do DML do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/create-db-cluster-console-log-exports.png)
+ **Registros de auditoria** — Selecione essa opção para permitir a exportação de registros de auditoria para o Amazon CloudWatch Logs. Se você selecionar **Logs de auditoria**, deverá habilitar `audit_logs` no grupo de parâmetros personalizado do cluster. Para obter mais informações, consulte [Auditar eventos do Amazon DocumentDB](event-auditing.md).
+ **Registros do profiler** — Selecione essa opção para permitir a exportação dos logs do profiler da operação para o Amazon Logs. CloudWatch Se você selecionar **Logs do profiler**, deverá também modificar os seguintes parâmetros no grupo de parâmetros personalizado do cluster:
+ `profiler`— defina como `enabled`.
+ `profiler_threshold_ms`— defina como um valor `[0-INT_MAX]` para configurar o limite para operações de criação de perfil.
+ `profiler_sampling_rate`— defina como um valor `[0.0-1.0]` para configurar o percentual de operações lentas para perfilar.
Para obter mais informações, consulte [Definir o perfil das operações do Amazon DocumentDB](profiling.md).
1. Complete o painel **Manutenção**.
![\[Captura de tela do painel Manutenção mostrando as etapas para configurar a janela de manutenção do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/create-db-cluster-console-maintenance.png)
1. Selecione uma das seguintes opções
+ **Selecionar janela**— você pode especificar o dia da semana, a hora de início em UTC e a duração do Amazon DocumentDB para executar a manutenção do seu cluster.
1. **Dia de início**— na lista, escolha o dia da semana para início da manutenção do cluster.
1. **Hora de início**: nas listas, escolha a hora e minuto (UTC) para iniciar a manutenção.
1. **Duração**— na lista, escolha quanto tempo alocar para a manutenção do cluster. Se a manutenção não puder ser concluída no horário especificado, o processo de manutenção continuará após o horário especificado, até que seja concluída.
+ **Sem preferência**— o Amazon DocumentDB seleciona o dia da semana, o horário de início e a duração para executar a manutenção.
1. Se quiser adicionar uma ou mais tags a esse cluster, preencha o painel **Tags**.
![\[Captura de tela da caixa de seleção Habilitar proteção contra exclusão, que está selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/create-db-cluster-console-tags.png)
Para cada tag que quiser adicionar ao cluster, repita as etapas a seguir. É possível ter até 10 em um cluster.
1. Selecione **Adicionar tags**.
1. Digite a **Chave** da tag.
1. Opcionalmente, digite o **Valor** da tag.
Para remover uma tag, selecione **Remover tag**.
1. **Proteção contra exclusão** está habilitada por padrão ao criar um cluster usando o console. Para desabilitar a proteção contra exclusão, desmarque **Habilitar proteção contra exclusão**. Quando habilitada, a proteção contra exclusão impede que um cluster seja excluído. Para excluir um cluster protegido contra a exclusão, primeiro é necessário modificar o cluster para desabilitar a proteção contra exclusão.
![\[Captura de tela da caixa de seleção Habilitar proteção contra exclusão, que está selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/create-db-cluster-console-deletion-protection.png)
Para obter mais informações sobre a proteção contra exclusão, consulte [Excluir um cluster do Amazon DocumentDB](db-cluster-delete.md).
1. Para criar o cluster, escolha **Criar cluster**. Caso contrário, escolha **Cancelar**.
## Criando um cluster usando o AWS CLI
Os procedimentos a seguir descrevem como usar o AWS CLI para iniciar um cluster do Amazon DocumentDB e criar uma réplica do Amazon DocumentDB.
**Parâmetros**
+ **--db-cluster-identifier**—Obrigatório. Uma string com letras minúsculas que identifica esse cluster.
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/db-cluster-create.html)
+ **--engine**—Obrigatório. Deve ser **docdb**.
+ **--deletion-protection \$1 --no-deletion-protection**— opcional. Quando a proteção contra exclusão estiver habilitada, ela impede que um cluster seja excluído. Quando você usa o AWS CLI, a configuração padrão é ter a proteção contra exclusão desativada.
Para obter mais informações sobre a proteção contra exclusão, consulte [Excluir um cluster do Amazon DocumentDB](db-cluster-delete.md).
+ **--storage-type standard \$1 iopt1**—Opcional. Padrão: **standard**. Configuração de armazenamento do cluster. Os valores válidos são `standard` (Padrão) ou `iopt1` (Otimizado para E/S).
+ **--master-username**—Obrigatório. O nome do usuário usado para autenticar o usuário.
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/db-cluster-create.html)
+ **--master-user-password**—Opcional. A senha do usuário usada para autenticar o usuário.
[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/db-cluster-create.html)
+ **--manage-master-user-password**— opcional. O Amazon DocumentDB gera a senha do usuário principal e a gerencia durante todo o ciclo de vida no Secrets Manager.
Para ver parâmetros adicionais, consulte [CreateDBCluster](API_CreateDBCluster.md).
**Para iniciar um cluster do Amazon DocumentDB usando o AWS CLI**
Para criar um cluster Amazon DocumentDB, chame o. `create-db-cluster` AWS CLI O AWS CLI comando a seguir cria um cluster Amazon DocumentDB chamado `sample-cluster` com a proteção contra exclusão ativada. Para obter mais informações sobre a proteção contra exclusão, consulte [Excluir um cluster do Amazon DocumentDB](db-cluster-delete.md).
Além disso, `--engine-version` é um parâmetro opcional padrão para a versão mais recente do mecanismo principal. A versão padrão atual do mecanismo é 5.0.0 (observação: o Amazon DocumentDB 8.0 está disponível, mas deve ser explicitamente especificado). Quando novas versões principais do mecanismo forem lançadas, a versão padrão `--engine-version` será atualizada para refletir a última versão principal do mecanismo. Como resultado, para cargas de trabalho de produção, especialmente aquelas que dependem de scripts, automação ou CloudFormation modelos, recomendamos que você especifique explicitamente a `--engine-version` para a versão principal pretendida.
**nota**
Se um `db-subnet-group-name` ou `vpc-security-group-id` não forem especificados, o Amazon DocumentDB usará o grupo de sub-rede padrão e o grupo de segurança do Amazon VPC para a região em questão.
Para Linux, macOS ou Unix:
```
aws docdb create-db-cluster \
--db-cluster-identifier sample-cluster \
--engine docdb \
--engine-version 5.0.0 \
--deletion-protection \
--master-username masteruser \
--master-user-password password
```
Para Windows:
```
aws docdb create-db-cluster ^
--db-cluster-identifier sample-cluster ^
--engine docdb ^
--engine-version 5.0.0 ^
--deletion-protection ^
--master-username masteruser ^
--master-user-password password
```
A saída dessa operação é semelhante ao seguinte (formato JSON).
```
{
"DBCluster": {
"StorageEncrypted": false,
"DBClusterMembers": [],
"Engine": "docdb",
"DeletionProtection" : "enabled",
"ClusterCreateTime": "2018-11-26T17:15:19.885Z",
"DBSubnetGroup": "default",
"EngineVersion": "5.0.0",
"MasterUsername": "masteruser",
"BackupRetentionPeriod": 1,
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"DBClusterIdentifier": "sample-cluster",
"MultiAZ": false,
"DBClusterParameterGroup": "default.docdb5.0",
"PreferredBackupWindow": "09:12-09:42",
"DbClusterResourceId": "cluster-KQSGI4MHU4NTDDRVNLNTU7XVAY",
"PreferredMaintenanceWindow": "tue:04:17-tue:04:47",
"Port": 27017,
"Status": "creating",
"ReaderEndpoint": "sample-cluster.cluster-ro-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com",
"AssociatedRoles": [],
"HostedZoneId": "ZNKXTT8WH85VW",
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-77186e0d",
"Status": "active"
}
],
"AvailabilityZones": [
"us-east-1a",
"us-east-1c",
"us-east-1e"
],
"Endpoint": "sample-cluster.cluster-sfcrlcjcoroz.us-east-1.docdb.amazonaws.com"
}
}
```
Leva alguns minutos para criar o cluster. Você pode usar o Console de gerenciamento da AWS ou AWS CLI para monitorar o status do seu cluster. Para obter mais informações, consulte [Monitoramento do status de um cluster do Amazon DocumentDB](monitoring_docdb-cluster_status.md).
**Importante**
Quando você usa o AWS CLI para criar um cluster Amazon DocumentDB, nenhuma instância é criada. Consequentemente, é necessário criar explicitamente uma instância principal e qualquer instância de réplica de que precise. Você pode usar o console ou AWS CLI criar as instâncias. Para obter mais informações, consulte [Adicionar uma instância do Amazon DocumentDB a um cluster](db-instance-add.md).
Para mais informações, consulte [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html) na *Referência de API do Amazon DocumentDB*.
# Descrever Clusters do Amazon DocumentDB
Você pode usar o Amazon DocumentDB Management Console ou o AWS CLI para ver detalhes como endpoints de conexão, grupos de segurança e grupos de parâmetros relacionados aos seus clusters do Amazon DocumentDB. VPCs
Para saber mais, consulte:
+ [Monitoramento do status de um cluster do Amazon DocumentDB](monitoring_docdb-cluster_status.md)
+ [Localizar os endpoints de um cluster](db-cluster-endpoints-find.md)
------
#### [ Using the Console de gerenciamento da AWS ]
Use o procedimento a seguir para visualizar os detalhes de um cluster especificado do Amazon DocumentDB usando o console.
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 nome do cluster do qual você deseja ver os detalhes. As informações sobre o cluster estão organizadas nos seguintes agrupamentos:
+ **Resumo** — informações gerais sobre o cluster, incluindo a versão do mecanismo, o status do cluster, a manutenção pendente e o status do grupo de parâmetros.
+ **Conectividade e Segurança**: a seção **Conectar** lista os endpoints de conexão para conectar-se a este cluster, com o shell do mongo ou uma aplicação. A seção **Grupos de segurança** lista os grupos de segurança associados a esse cluster, suas descrições e ID da VPC.
+ **Configuração**: a seção **Detalhes do cluster** lista detalhes sobre o cluster, como nome do recurso da Amazon (ARN), o endpoint e o grupo de parâmetros do cluster. Ela também lista as informações de backup do cluster, os detalhes de manutenção e as configurações de segurança e de rede. A seção **Instâncias de cluster** lista as instâncias que pertencem a esse cluster com a função de cada instância e o status do grupo de parâmetros do cluster.
+ **Monitoramento** — As métricas do Amazon CloudWatch Logs para esse cluster. Para obter mais informações, consulte [Monitorando o Amazon DocumentDB com CloudWatch](cloud_watch.md).
+ **Eventos e tags** — a seção **Eventos recentes** lista os eventos recentes desse cluster. O Amazon DocumentDB mantém um registro de eventos que se relacionam a seus clusters, instâncias, capturas de tela, grupos de segurança e grupos de parâmetros do cluster. Essas informações incluem a data, a hora e a mensagem associadas a cada evento. A seção **Tags** lista as tags anexadas a este cluster.
------
#### [ Using the AWS CLI ]
Para visualizar os detalhes dos seus clusters do Amazon DocumentDB usando o AWS CLI, use o `describe-db-clusters` comando conforme mostrado nos exemplos abaixo. Para obter mais informações, consulte [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html) na *Referência de API para gerenciamento de recursos do Amazon DocumentDB*.
**nota**
Para determinados atributos de gerenciamento, como o gerenciamento do ciclo de vida de cluster e instâncias, o Amazon DocumentDB aproveita a tecnologia operacional compartilhada com o Amazon RDS. O filtro `filterName=engine,Values=docdb` retorna somente clusters do Amazon DocumentDB.
**Example**
**Exemplo 1: listar todos os clusters do Amazon DocumentDB**
O AWS CLI código a seguir lista os detalhes de todos os clusters do Amazon DocumentDB em uma região.
```
aws docdb describe-db-clusters --filter Name=engine,Values=docdb
```
A saída dessa operação é semelhante a seguinte.
```
{
"DBClusters": [
{
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster-1",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
...
},
{
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster-2",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
...
},
{
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster-3",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
...
}
]
}
```
**Example**
**Exemplo 2: listar todos os detalhes de um cluster especificado do Amazon DocumentDB**
O AWS CLI código a seguir lista os detalhes do cluster`sample-cluster`.
Para Linux, macOS ou Unix:
```
aws docdb describe-db-clusters \
--filter Name=engine,Values=docdb \
--db-cluster-identifier sample-cluster
```
Para Windows:
```
aws docdb describe-db-clusters ^
--filter Name=engine,Values=docdb ^
--db-cluster-identifier sample-cluster
```
A saída dessa operação é semelhante à seguinte.
```
{
"DBClusters": [
{
"AllocatedStorage": 1,
"AvailabilityZones": [
"us-east-1c",
"us-east-1a",
"us-east-1d"
],
"BackupRetentionPeriod": 2,
"DBClusterIdentifier": "sample-cluster",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
"EarliestRestorableTime": "2023-11-07T22:34:08.148000+00:00",
"Endpoint": "sample-cluster.node.us-east-1.amazon.com",
"ReaderEndpoint": "sample-cluster.node.us-east-1.amazon.com",
"MultiAZ": false,
"Engine": "docdb",
"EngineVersion": "5.0.0",
"LatestRestorableTime": "2023-11-10T07:21:16.772000+00:00",
"Port": 27017,
"MasterUsername": "chimeraAdmin",
"PreferredBackupWindow": "22:22-22:52",
"PreferredMaintenanceWindow": "sun:03:01-sun:03:31",
"ReadReplicaIdentifiers": [],
"DBClusterMembers": [
{
"DBInstanceIdentifier": "sample-instance-1",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
{
"DBInstanceIdentifier": "sample-instance-2",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-9084c2ec",
"Status": "active"
}
],
"HostedZoneId": "Z06853723JYKYBXTJ49RB",
"StorageEncrypted": false,
"DbClusterResourceId": "cluster-T4LGLANHVAPGQYYULWUDKLVQL4",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"AssociatedRoles": [],
"IAMDatabaseAuthenticationEnabled": false,
"ClusterCreateTime": "2023-11-06T18:05:41.568000+00:00",
"EngineMode": "provisioned",
"DeletionProtection": false,
"HttpEndpointEnabled": false,
"CopyTagsToSnapshot": false,
"CrossAccountClone": false,
"DomainMemberships": [],
"TagList": [],
"StorageType": "iopt1",
"AutoMinorVersionUpgrade": false,
"NetworkType": "IPV4",
"IOOptimizedNextAllowedModificationTime": "2023-12-07T18:05:41.580000+00:00"
}
]
}
```
**Example**
**Exemplo 3: listar os detalhes específicos de um cluster Amazon DocumentDB**
Para listar um subconjunto dos detalhes dos clusters usando o AWS CLI, adicione um `--query` que especifique quais membros do cluster a `describe-db-clusters` operação deve listar. O parâmetro `--db-cluster-identifier` é o identificador do cluster específico do qual você deseja exibir os detalhes. Para obter mais informações, consulte [Como Filtrar a Saída com a Opção `--query`](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-output.html#controlling-output-filter) no * Guia de Usuário AWS Command Line Interface *.
O exemplo a seguir lista as instâncias em um cluster do Amazon DocumentDB.
Para Linux, macOS ou Unix:
```
aws docdb describe-db-clusters \
--filter Name=engine,Values=docdb \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterMembers]'
```
Para Windows:
```
aws docdb describe-db-clusters ^
--filter Name=engine,Values=docdb ^
--db-cluster-identifier sample-cluster ^
--query 'DBClusters[*].[DBClusterMembers]'
```
A saída dessa operação é semelhante à seguinte.
```
[
[
[
{
"DBInstanceIdentifier": "sample-instance-1",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
{
"DBInstanceIdentifier": "sample-instance-2",
"IsClusterWriter": false,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
}
]
]
]
```
------
# Modificar um cluster do Amazon DocumentDB
Para modificar um cluster, o mesmo deve estar no estado *disponível*. Você não pode modificar um cluster interrompido. Se o cluster for interrompido, primeiro inicie-o, aguarde até que fique *disponível* e faça as modificações desejadas. Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](db-cluster-stop-start.md).
------
#### [ Using the Console de gerenciamento da AWS ]
Use o procedimento a seguir para modificar um cluster Amazon DocumentDB específico usando o console.
**Para modificar um cluster 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. Especifique o cluster que você deseja modificar escolhendo o botão à esquerda do nome do cluster.
1. Escolha **Ações** e, em seguida, **Modificar**.
1. No painel **Modificar cluster: **, faça as alterações desejadas. É possível fazer alterações nas seguintes áreas:
+ **Especificações do cluster**: o nome, os grupos de segurança e o gerenciamento de credenciais do cluster.
+ **Configuração de armazenamento do cluster** — o modo de armazenamento de dados do cluster. Escolha entre a configuração Padrão e Otimizado para E/S.
+ **Opções do cluster**— a porta e o grupo de parâmetros do cluster.
+ **Backup**— o período de retenção e a janela de backup do cluster.
+ **Exportações de log**— habilite ou desabilite exportação dos logs de auditoria ou de profiler.
+ **Manutenção**— defina a janela de manutenção do cluster.
+ **Proteção contra exclusão**— habilite ou desabilite a proteção contra exclusão no cluster. Por padrão, a proteção contra exclusão está habilitada.
1. Ao concluir, escolha **Continuar** para ver um resumo das alterações.
1. Se estiver satisfeito com suas alterações, poderá escolher **Modificar cluster** para modificar o cluster. Como alternativa, você pode escolher **Voltar** ou **Cancelar** para editar ou cancelar as alterações, respectivamente.
Levará alguns minutos para que suas alterações sejam aplicadas. É possível usar o cluster somente quando seu status for *disponível*. É possível monitorar o status do cluster usando o console ou a AWS CLI. Para obter mais informações, consulte [Monitoramento do status de um cluster do Amazon DocumentDB](monitoring_docdb-cluster_status.md).
------
#### [ Using the AWS CLI ]
Use a operação `modify-db-cluster` para modificar o cluster especificado usando a AWS CLI. Para mais informações, consulte [https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html) na *Referência de API do Amazon DocumentDB*.
**Parâmetros**
+ **--db-cluster-identifier**—Obrigatório. O identificador do cluster do Amazon DocumentDB que você modificará.
+ **--backup-retention-period**— opcional. O número de dias durante os quais os backups automatizados são retidos. Os valores válidos são 1–35.
+ **--storage-type**— opcional. Configuração de armazenamento do cluster. Os valores válidos são `standard` (Padrão) ou `iopt1` (Otimizado para E/S).
+ **--db-cluster-parameter-group-name**— opcional. O nome do grupo de parâmetros do cluster a ser usado.
+ **--manage-master-user-password**— opcional. O Amazon DocumentDB gera a senha do usuário principal e a gerencia durante todo o ciclo de vida no Secrets Manager.
+ **--rotate-master-user-password**—Opcional. O Secrets Manager gera uma nova versão secreta para o segredo existente. A nova versão do segredo contém a nova senha do usuário principal. O Amazon DocumentDB altera a senha do usuário principal do cluster para corresponder à senha para a nova versão do segredo.
É necessário especificar a opção **--apply-immediately** ao alternar a senha principal.
+ **--master-user-password**—Opcional. A nova senha para o usuário do banco de dados primário.
Restrições de senha:
+ O comprimento é de [8–100] caracteres ASCII imprimíveis.
+ Pode usar quaisquer caracteres ASCII imprimíveis, exceto:
+ **/** (barra)
+ **"** (aspas duplas)
+ **@** (arroba)
+ **--new-db-cluster-identifier**— opcional. O novo identificador do cluster durante a renomeação de um cluster. Esse valor é armazenado como uma string em minúsculas.
Restrições de nomenclatura:
+ O comprimento é de [1 a 63] letras, números ou hifens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
+ Deve ser exclusivo para todos os clusters do Amazon RDS, Amazon Neptune e Amazon DocumentDB por região. Conta da AWS
+ **--preferred-backup-window**— opcional. O período diário durante o qual backups automatizados são criados, em formato Tempo Universal Coordenado (UTC).
+ Formato: `hh24:mm-hh24:mm`.
+ **--preferred-maintenance-window**— opcional. O intervalo de tempo semanal durante o qual pode ocorrer manutenção do sistema, em UTC.
+ Formato: `ddd:hh24:mm-ddd:hh24:mm`.
+ Dias válidos: `Sun`, `Mon`, `Tue`, `Wed`, `Thu`, `Fri` e `Sat`.
+ **--deletion-protection** ou **--no-deletion-protection**—opcional. Se a proteção contra exclusão deve ser habilitada neste cluster. A proteção contra exclusão impede que um cluster seja excluído acidentalmente até que o cluster seja modificado para desabilitar a proteção contra exclusão. Para obter mais informações, consulte [Excluir um cluster do Amazon DocumentDB](db-cluster-delete.md).
+ **--apply-immediately** ou **--no-apply-immediately**—use `--apply-immediately` para aplicar a alteração imediatamente. Use `--no-apply-immediately` para aplicar a alteração durante a próxima janela de manutenção do cluster.
**Example**
O código a seguir altera o período de retenção de backup para o cluster `sample-cluster`.
Para Linux, macOS ou Unix:
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--apply-immediately \
--backup-retention-period 7
```
Para Windows:
```
aws docdb modify-db-cluster ^
--db-cluster-identifier sample-cluster ^
--apply-immediately ^
--backup-retention-period 7
```
A saída dessa operação é semelhante à seguinte.
```
{
"DBCluster": {
"BackupRetentionPeriod": 7,
"DbClusterResourceId": "cluster-VDP53QEWST7YHM36TTXOPJT5YE",
"Status": "available",
"DBClusterMembers": [
{
"PromotionTier": 1,
"DBClusterParameterGroupStatus": "in-sync",
"DBInstanceIdentifier": "sample-cluster-instance",
"IsClusterWriter": true
}
],
"ReadReplicaIdentifiers": [],
"AvailabilityZones": [
"us-east-1b",
"us-east-1c",
"us-east-1a"
],
"ReaderEndpoint": "sample-cluster.cluster-ro-ctevjxdlur57.us-east-1.rds.amazonaws.com",
"DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"PreferredMaintenanceWindow": "sat:09:51-sat:10:21",
"EarliestRestorableTime": "2018-06-17T00:06:19.374Z",
"StorageEncrypted": false,
"MultiAZ": false,
"AssociatedRoles": [],
"MasterUsername": "",
"DBClusterIdentifier": "sample-cluster",
"VpcSecurityGroups": [
{
"Status": "active",
"VpcSecurityGroupId": "sg-77186e0d"
}
],
"HostedZoneId": "Z2SUY0A1719RZT",
"LatestRestorableTime": "2018-06-18T21:17:05.737Z",
"AllocatedStorage": 1,
"Port": 27017,
"Engine": "docdb",
"DBClusterParameterGroup": "default.docdb3.4",
"Endpoint": "sample-cluster.cluster-ctevjxdlur57.us-east-1.rds.amazonaws.com",
"DBSubnetGroup": "default",
"PreferredBackupWindow": "00:00-00:30",
"EngineVersion": "3.4",
"ClusterCreateTime": "2018-06-06T19:25:47.991Z",
"IAMDatabaseAuthenticationEnabled": false
}
}
```
Levará alguns minutos para que suas alterações sejam aplicadas. É possível usar o cluster somente quando seu status for *disponível*. É possível monitorar o status do cluster usando o console ou a AWS CLI. Para obter mais informações, consulte [Monitoramento do status de um cluster do Amazon DocumentDB](monitoring_docdb-cluster_status.md).
------
# Determinar manutenção pendente
É possível determinar se você tem a versão mais recente do mecanismo do Amazon DocumentDB determinando se tem manutenção de cluster pendente.
------
#### [ Using the Console de gerenciamento da AWS ]
Você pode usar o Console de gerenciamento da AWS para determinar se um cluster tem manutenção pendente.
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. Localize a coluna **Manutenção** para determinar se um cluster tem manutenção pendente.
![\[Snapshot do console mostrando o campo de manutenção do cluster do Amazon DocumentDB.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-cluster-pending-maintenance.png)
**Nenhum** indica que o cluster está executando a versão mais recente do mecanismo. **Disponível** indica que o cluster tem manutenção pendente, o que pode significar que é necessária uma atualização do mecanismo.
1. Se o seu cluster tiver a manutenção pendente, prossiga para as etapas em [Executar uma atualização de patch para a versão do mecanismo de um cluster](db-cluster-version-upgrade.md).
------
#### [ Using the AWS CLI ]
Você pode usar o AWS CLI para determinar se um cluster tem a versão mais recente do mecanismo usando a `describe-pending-maintenance-actions` operação com os parâmetros a seguir.
**Parâmetros**
+ **--resource-identifier**— opcional. O ARN do recurso (cluster). Se esse parâmetro for omitido, ações de manutenção pendentes para todos os clusters serão listadas.
+ **--region**— opcional. A Região da AWS na qual você deseja executar essa operação, por exemplo, `us-east-1`.
**Example**
Para Linux, macOS ou Unix:
```
aws docdb describe-pending-maintenance-actions \
--resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster \
--region us-east-1
```
Para Windows:
```
aws docdb describe-pending-maintenance-actions ^
--resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster ^
--region us-east-1
```
A saída dessa operação é semelhante à seguinte.
```
{
"PendingMaintenanceActions": [
{
"ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
"PendingMaintenanceActionDetails": [
{
"Description": "New feature",
"Action": "db-upgrade",
"ForcedApplyDate": "2019-02-25T21:46:00Z",
"AutoAppliedAfterDate": "2019-02-25T07:41:00Z",
"CurrentApplyDate": "2019-02-25T07:41:00Z"
}
]
}
]
}
```
Se o seu cluster tiver a manutenção pendente, prossiga para as etapas em [Executar uma atualização de patch para a versão do mecanismo de um cluster](db-cluster-version-upgrade.md).
------
# Executar uma atualização de patch para a versão do mecanismo de um cluster
Nesta seção, explicaremos como implantar uma atualização de patch usando Console de gerenciamento da AWS o. ou AWS CLI o. Uma atualização de patch é uma atualização dentro da mesma versão do mecanismo (por exemplo, uma versão do mecanismo 3.6 para uma versão mais recente). É possível atualizá-la imediatamente ou durante a próxima janela de manutenção do cluster. Para determinar se seu mecanismo precisa de uma atualização, consulte [Determinar manutenção pendente](db-cluster-determine-pending-maintenance.md). Observe que, ao aplicar a atualização, seu cluster passará por um tempo de inatividade.
**nota**
Se você estiver tentando atualizar a partir de uma versão principal do mecanismo para outra, como 3.6 para 5.0, consulte [Atualização da versão principal implementada do Amazon DocumentDB no local](docdb-mvu.md) ou [Atualizando seu cluster Amazon DocumentDB usando AWS Database Migration Service](docdb-migration.versions.md). Uma atualização local da versão principal oferece suporte apenas ao docdb 5.0 como versão do mecanismo de destino.
Há dois requisitos de configuração para obter as atualizações de patch mais recentes para a versão do mecanismo de um cluster:
+ O status do cluster precisa ser *disponível*.
+ O cluster deve estar executando uma versão de mecanismo mais antiga.
------
#### [ Using the Console de gerenciamento da AWS ]
O procedimento a seguir atualiza a versão de mecanismo do seu cluster para uma versão mais recente usando o console. Você tem a opção de atualizar imediatamente ou durante a próxima janela de manutenção do cluster.
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**. Na lista de clusters, escolha o botão à esquerda do cluster que você deseja atualizar. O status do cluster precisa ser *disponível*.
**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. No menu **Ações**, escolha uma das opções a seguir. Essas opções de menu são selecionáveis somente se o cluster que você escolheu não está executando a versão mais recente do mecanismo.
![\[Imagem: ações de atualização do Amazon DocumentDB\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-upgrade-action.png)
+ **Atualizar agora**— inicia imediatamente o processo de atualização. Seu cluster ficará offline por um momento, enquanto é atualizado para a versão mais recente do mecanismo.
+ **Atualizar na próxima janela**— inicia o processo de atualização durante a próxima janela de manutenção do cluster. O cluster ficará offline por um momento, enquanto é atualizado para a versão mais recente do mecanismo.
1. Quando a janela de confirmação for aberta, escolha uma das seguintes opções:
+ **Atualizar**— para atualizar seu cluster para a versão mais recente do mecanismo, de acordo com a programação escolhida na etapa anterior.
+ **Cancelar**— para cancelar a atualização do mecanismo do cluster e continuar com a versão atual.
------
#### [ Using the AWS CLI ]
Você pode aplicar atualizações de patch ao seu cluster usando a `apply-pending-maintenance-action` operação AWS CLI e a com os parâmetros a seguir.
**Parâmetros**
+ **--resource-identifier**—Obrigatório. O ARN do cluster do Amazon DocumentDB que você vai atualizar.
+ **--apply-action**—Obrigatório. Os valores a seguir são permitidos. Para atualizar a versão de mecanismo do cluster, use `db-upgrade`.
+ **db-upgrade**
+ **system-update**
+ **--opt-in-type**—Obrigatório. Os valores a seguir são permitidos.
+ `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.
+ `undo-opt-in`— cancele quaisquer solicitações de inclusão `next-maintenance` existentes.
**Example**
O exemplo a seguir atualiza a versão do mecanismo `sample-cluster` para a versão 4.0.0.
Para Linux, macOS ou Unix:
```
aws docdb apply-pending-maintenance-action \
--resource-identifier arn:aws:rds:us-east-1:123456789012\:cluster:sample-cluster \
--apply-action db-upgrade \
--opt-in-type immediate
```
Para Windows:
```
aws docdb apply-pending-maintenance-action ^
--resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster ^
--apply-action db-upgrade ^
--opt-in-type immediate
```
A saída dessa operação é semelhante à seguinte.
```
{
"ResourcePendingMaintenanceActions": {
"ResourceIdentifier": "arn:aws:rds:us-east-1:444455556666:cluster:docdb-2019-01-09-23-55-38",
"PendingMaintenanceActionDetails": [
{
"CurrentApplyDate": "2019-02-20T20:57:06.904Z",
"Description": "Bug fixes",
"ForcedApplyDate": "2019-02-25T21:46:00Z",
"OptInStatus": "immediate",
"Action": "db-upgrade",
"AutoAppliedAfterDate": "2019-02-25T07:41:00Z"
}
]
}
}
```
------
# Interromper e iniciar um cluster do Amazon DocumentDB
Interromper e iniciar os clusters do Amazon DocumentDB pode ajudar a gerenciar os custos dos ambientes de teste e desenvolvimento. Em vez de criar e excluir clusters e instâncias toda vez que você usar o Amazon DocumentDB, você pode interromper temporariamente todas as instâncias em seu cluster quando elas não forem necessárias. Depois, é possível iniciá-las novamente, ao retomar os testes.
**Topics**
+ [Visão geral de como interromper e iniciar um cluster](#db-cluster-stop-start-overview)
+ [Operações que você pode realizar em um cluster interrompido](#db-cluster-stopped-operations)
## Visão geral de como interromper e iniciar um cluster
Durante os períodos nos quais não precisar de um cluster do Amazon DocumentDB, você pode interromper todas as instâncias nesse cluster de uma só vez. 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 usados em desenvolvimento, teste ou atividades afins que não exijam disponibilidade contínua. Você pode parar e iniciar um cluster usando o Console de gerenciamento da AWS ou o AWS CLI com uma única ação, independentemente de quantas instâncias estejam no cluster.
Enquanto o cluster estiver interrompido, o volume de armazenamento do cluster permanece 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. Não haverá cobrança por horas de instância. O Amazon DocumentDB iniciará automaticamente seu cluster 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ê será cobrado pelas instâncias novamente. Enquanto o cluster é interrompido, não é possível consultar o volume de armazenamento porque a consulta requer que as instâncias estejam no estado disponível.
Quando um cluster do Amazon DocumentDB é interrompido, nem o cluster nem suas instâncias podem ser modificados, de maneira alguma. Isso inclui adicionar ou remover instâncias, ou excluir o cluster.
------
#### [ Using the Console de gerenciamento da AWS ]
O procedimento a seguir mostra como interromper um cluster com uma ou mais instâncias no estado disponível ou iniciar um cluster interrompido.
**Para interromper ou iniciar um cluster 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.
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**.
![\[Imagem: interromper um cluster\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/db-cluster-stop.png)
Para evitar a ativação do mecanismo de failover, a operação de interrupção interrompe primeiro as instâncias de réplica e, depois, a instância primária.
1. Na caixa de diálogo de confirmação, confirme se deseja interromper o cluster, escolhendo **Interromper cluster** ou, para manter o cluster em execução, escolha **Cancelar**.
![\[Imagem: Iniciar um cluster\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/db-cluster-stop-confirm.png)
+ Se quiser iniciar o cluster e o cluster estiver interrompido, escolha **Iniciar**.
![\[Imagem: Iniciar um cluster\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/db-cluster-start.png)
1. Monitore o status do cluster e suas instâncias. Se você iniciou o cluster, poderá retomar o uso do cluster quando ele e suas instâncias estiverem *disponíveis*. Para obter mais informações, consulte [Determinar o status de um cluster](db-cluster-status.md).
![\[Imagem: status de clusters em interrupção e início\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/db-cluster-stop-start-status.png)
------
#### [ Using the AWS CLI ]
Os exemplos de código a seguir mostram como interromper um cluster com uma ou mais instâncias no estado disponível ou iniciar um cluster interrompido.
Para interromper um cluster com uma ou mais instâncias disponíveis usando o AWS CLI, use a `stop-db-cluster` operação. Para iniciar um cluster interrompido, use a operação `start-db-cluster`. Ambas as operações usam o parâmetro `--db-cluster-identifier`.
**Parâmetro**
+ **--db-cluster-identifier**—Obrigatório. O nome do cluster a ser interrompido ou iniciado.
**Example — Para interromper um cluster usando o AWS CLI**
O código a seguir interrompe o cluster `sample-cluster`. O cluster deve ter uma ou mais instâncias no estado disponível.
Para Linux, macOS ou Unix:
```
aws docdb stop-db-cluster \
--db-cluster-identifier sample-cluster
```
Para Windows:
```
aws docdb stop-db-cluster ^
--db-cluster-identifier sample-cluster
```
**Example — Para iniciar um cluster usando o AWS CLI**
O código a seguir inicia o cluster `sample-cluster`. O cluster deve estar interrompido no momento.
Para Linux, macOS ou Unix:
```
aws docdb start-db-cluster \
--db-cluster-identifier sample-cluster
```
Para Windows:
```
aws docdb start-db-cluster ^
--db-cluster-identifier sample-cluster
```
------
## Operações que você pode realizar em um cluster interrompido
Enquanto um cluster do Amazon DocumentDB está parado, você pode fazer uma point-in-time restauração em qualquer ponto dentro da janela de retenção automática de backup especificada. Para obter detalhes sobre como fazer uma point-in-time restauração, consulte[Restauração para um ponto no tempo](backup_restore-point_in_time_recovery.md).
Não é possível modificar a configuração de um cluster do Amazon DocumentDB, ou de qualquer uma de suas instâncias, enquanto o cluster estiver interrompido. Também não é possível adicionar ou remover instâncias do cluster ou excluir o cluster, caso ainda tenha alguma instância associada. 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 interrompido somente depois que for reiniciado. Após sete dias, o Amazon DocumentDB inicia automaticamente um cluster interrompido, para que não fique muito atrasado em seu status de manutenção. Quando o cluster for reiniciado, você começará a ser cobrado pelas instâncias no cluster novamente.
Enquanto um cluster estiver interrompido, o Amazon DocumentDB não executa quaisquer backups automatizados, nem estende o período de retenção de backup.
# Excluir um cluster do Amazon DocumentDB
Você pode excluir um cluster do Amazon DocumentDB usando o Console de gerenciamento da AWS ou o. AWS CLI Para excluir um cluster, o cluster deve estar no estado *disponível* e não deve ter nenhuma instância associada a ele. Se o cluster foi interrompido, primeiro inicie-o, aguarde até que fique *disponível* e então, exclua-o. Para obter mais informações, consulte [Interromper e iniciar um cluster do Amazon DocumentDB](db-cluster-stop-start.md).
## Deletion protection (Proteção contra exclusão)
Para proteger seu cluster contra a exclusão acidental, você pode habilitar a *proteção contra exclusão*. A proteção contra exclusão está habilitada por padrão ao criar um cluster usando o console. No entanto, a proteção contra exclusão será desabilitada por padrão, se você criar um cluster usando a AWS CLI.
O Amazon DocumentDB aplicará a proteção contra exclusão para um cluster se você executar a operação de exclusão usando o console ou AWS CLI. Se a proteção contra exclusão estiver habilitada, não será possível excluir um cluster. Para excluir um cluster com a projeção contra exclusão habilitada, primeiro é necessário modificar o cluster e desabilitar a proteção contra exclusão.
Ao usar o console com a proteção contra exclusão habilitada em um cluster, não será possível excluir a última instância do cluster, pois isso também excluirá o cluster. É possível excluir a última instância de um cluster protegido contra exclusão usando a AWS CLI. No entanto, o cluster em si ainda existirá e seus dados serão preservados. É possível acessar os dados criando novas instâncias para o cluster. Para obter mais informações sobre como habilitar e desabilitar a proteção contra exclusão, consulte:
+ [Criar um cluster do Amazon DocumentDB](db-cluster-create.md)
+ [Modificar um cluster do Amazon DocumentDB](db-cluster-modify.md)
------
#### [ Using the Console de gerenciamento da AWS ]
Para excluir um cluster usando o Console de gerenciamento da AWS, a proteção contra exclusão deve estar desativada.
**Para determinar se um cluster está com a proteção contra exclusão habilitada:**
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. Observe que, na caixa de navegação Clusters, a coluna **Identificador do cluster** mostra tanto os clusters quanto as instâncias. Suas instâncias estão listadas em clusters, semelhante ao snapshot abaixo.
![\[Imagem: a caixa de navegação Clusters mostrando uma lista dos links de cluster existentes e seus links de instância correspondentes.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/clusters.png)
1. Escolha o nome do cluster e selecione a guia **Configuração**. Na seção **Detalhes do cluster**, localize **Proteção contra exclusão**. Se a proteção contra exclusão estiver habilitada, modifique o cluster para desabilitar a proteção contra exclusão. Para obter informações sobre como modificar um cluster, consulte [Modificar um cluster do Amazon DocumentDB](db-cluster-modify.md).
Após desabilitar a **Proteção contra exclusão**, você estará pronto para excluir o cluster.
**Para excluir um cluster:**
1. No painel de navegação, escolha **Clusters**.
1. Determine se o cluster tem instâncias verificando a coluna **Identificador do cluster** para as instâncias lidas abaixo dele. Antes de excluir um cluster, é necessário excluir todas as instâncias. Para obter mais informações, consulte [Excluir uma instância do Amazon DocumentDB](db-instance-delete.md).
1. Dependendo de o cluster ter ou não instâncias, realize uma das seguintes etapas.
+ Se o cluster não tiver instâncias, selecione o botão à esquerda do nome do cluster e escolha **Ações**. No menu suspenso, escolha **Excluir**. Preencha a caixa de diálogo **Excluir ** e escolha **Excluir**.
+ Se o cluster tiver uma ou mais instâncias, faça o seguinte:
1. No painel de navegação, escolha **Clusters**.
1. Exclua cada uma das instâncias do cluster escolhendo a caixa de seleção à esquerda do nome do cluster. Selecione **Ações** e escolha **Excluir**. Preencha a caixa de diálogo **Excluir ** e escolha **Excluir**.
Ao excluir a última instância, o cluster também será excluído. Para obter informações sobre a exclusão de instâncias, consulte [Excluir uma instância do Amazon DocumentDB](db-instance-delete.md).
A exclusão do cluster demora alguns minutos. Para monitorar o status do cluster, consulte [Monitoramento do status de um cluster do Amazon DocumentDB](monitoring_docdb-cluster_status.md).
------
#### [ Using the AWS CLI ]
Não é possível excluir um cluster que tenha instâncias associadas a ele. Para determinar quais instâncias estão associadas ao cluster, execute o comando `describe-db-clusters` e exclua todas as instâncias do cluster. Depois, se necessário, desabilite a proteção contra exclusão no cluster e, finalmente, exclua o cluster.
1. **Primeiro, exclua todas as instâncias do cluster.**
Para determinar quais instâncias você precisa excluir, execute o comando a seguir.
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]'
```
A saída dessa operação é semelhante ao seguinte (formato JSON).
```
[
[
"sample-cluster",
[
"sample-instance-1",
"sample-instance-2"
]
]
]
```
Se o cluster que você deseja excluir tiver instâncias, exclua-as conforme abaixo.
```
aws docdb delete-db-instance \
--db-instance-identifier sample-instance
```
1. **Em segundo lugar, desabilite a proteção contra exclusão**.
Usar o AWS CLI para excluir todas as instâncias de um cluster não exclui o cluster. Também é necessário excluir o cluster, mas isso só poderá ser feito se a proteção contra exclusão estiver desabilitada.
Para determinar se o cluster está com a proteção contra exclusão habilitada, execute o comando a seguir.
**dica**
Para ver o status da proteção contra exclusão de todos os clusters do Amazon DocumentDB, omita o parâmetro `--db-cluster-identifier`.
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,DeletionProtection]'
```
A saída dessa operação é semelhante à seguinte.
```
[
[
"sample-cluster",
"true"
]
]
```
Se o cluster estiver com a proteção contra exclusão habilitada, modifique o cluster e desabilite a proteção contra exclusão. Para desabilitar a proteção contra exclusão no cluster, use o comando a seguir.
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--no-deletion-protection \
--apply-immediately
```
1. **Para finalizar, exclua o cluster.**
Após desabilitar a proteção contra exclusão, você estará pronto para excluir o cluster. Para excluir um cluster, use a operação `delete-db-cluster` com os parâmetros a seguir.
+ **--db-cluster-identifier**—Obrigatório. O identificador do cluster que deseja excluir.
+ **--final-db-snapshot-identifier**— opcional. Se você quiser uma captura de tela final, inclua esse parâmetro com um nome para a captura de tela final. É necessário incluir `--final-db-snapshot-identifier` ou `--skip-final-snapshot`.
Restrições de nomenclatura:
+ O comprimento é de [1 a 63] letras, números ou hifens.
+ O primeiro caractere deve ser uma letra.
+ Não pode terminar com um hífen ou conter dois hifens consecutivos.
+ Deve ser exclusivo para todos os clusters do Amazon RDS, Amazon Neptune e Amazon DocumentDB por região. Conta da AWS
+ **--skip-final-snapshot**— opcional. Use esse parâmetro somente se não quiser obter um captura de tela final antes de excluir seu cluster. A configuração padrão é obter uma captura de tela final. É necessário incluir `--final-db-snapshot-identifier` ou `--skip-final-snapshot`.
O AWS CLI código a seguir exclui o cluster `sample-cluster` com um instantâneo final. A operação falhará se houver instâncias associadas ao cluster ou se a proteção contra exclusão estiver desabilitada.
**Example**
Para Linux, macOS ou Unix:
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--final-db-snapshot-identifier sample-cluster-final-snapshot
```
Para Windows:
```
aws docdb delete-db-cluster ^
--db-cluster-identifier sample-cluster ^
--final-db-snapshot-identifier sample-cluster-final-snapshot
```
**Example**
O AWS CLI código a seguir exclui o cluster `sample-cluster` sem tirar um instantâneo final.
Para Linux, macOS ou Unix:
```
aws docdb delete-db-cluster \
--db-cluster-identifier sample-cluster \
--skip-final-snapshot
```
Para Windows:
```
aws docdb delete-db-cluster ^
--db-cluster-identifier sample-cluster ^
--skip-final-snapshot
```
A saída da operação `delete-db-cluster` é o cluster que você está excluindo.
A exclusão do cluster demora alguns minutos. Para monitorar o status do cluster, consulte [Monitorar o status de um cluster](monitoring_docdb-cluster_status.md).
------