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á.
# Usando clusters elásticos do Amazon DocumentDB
Os clusters elásticos do Amazon DocumentDB oferecem suporte a cargas de trabalho com milhões de reads/writes por segundo e petabytes de capacidade de armazenamento. Os clusters elásticos também simplificam a forma como os desenvolvedores interagem com o Amazon DocumentDB, eliminando a necessidade de escolher, gerenciar ou atualizar instâncias.
**nota**
Os clusters elásticos usam um protocolo de conexão compatível com o MongoDB 5.0. Eles não são compatíveis com a versão 8.0 do mecanismo Amazon DocumentDB e não estão disponíveis nas regiões da China ou. AWS GovCloud
Os clusters elásticos do Amazon DocumentDB foram criados para:
+ Fornecer uma solução para clientes que procuram um banco de dados que ofereça escala praticamente ilimitada com recursos avançados de consulta e compatibilidade com a API MongoDB.
+ Oferecer aos clientes limites de conexão mais altos e reduza o tempo de inatividade causado pela aplicação de patches.
+ Continuar investindo em uma arquitetura nativa de nuvem, elástica e líder de classe para workloads JSON.
**Topics**
+ [Casos de uso do cluster elástico](#elastic-use-cases)
+ [Vantagens dos clusters elásticos](#elastic-advantages)
+ [Região do cluster elástico e disponibilidade da versão](#elastic-region-version)
+ [Limitações](#elastic-limitations)
+ [Clusters elásticos do Amazon DocumentDB: como funcionam](elastic-how-it-works.md)
+ [Como iniciar com clusters elásticos do Amazon DocumentDB](elastic-get-started.md)
+ [Práticas recomendadas para clusters elásticos do Amazon DocumentDB](elastic-best-practices.md)
+ [Gerenciamento de clusters elásticos do Amazon DocumentDB](elastic-managing.md)
+ [Criptografia de dados em repouso para clusters elásticos do Amazon DocumentDB](elastic-encryption.md)
+ [Funções vinculadas ao serviço em clusters elásticos](elastic-service-linked-roles.md)
## Casos de uso do cluster elástico
Os bancos de dados de documentos são úteis para workloads que exigem um esquema flexível para desenvolvimento rápido e iterativo. Por exemplo, casos de uso do Amazon DocumentDB, consulte [Casos de uso do banco de dados de documentos](document-database-use-cases.md).
A seguir estão alguns exemplos de casos de uso para os quais os clusters elásticos podem fornecer vantagens significativas:
### Perfis de usuário
Como os bancos de dados de documentos têm um esquema flexível, eles podem armazenar documentos com atributos e valores de dados diferentes em escala. Os clusters elásticos são uma solução prática para perfis online nos quais usuários diferentes fornecem tipos de informações diferentes. Suponha que suas aplicações ofereçam suporte a centenas de milhões de perfis de usuário. É possível usar clusters elásticos para dar suporte a essas aplicações porque eles podem ser ampliados e reduzidos para dar suporte a milhões de gravações e leituras nesses perfis de usuário. Você também pode reduzir a escala verticalmente fora dos horários de pico para reduzir custos.
### Gerenciamento de conteúdo e registros históricos
Para gerenciar o conteúdo com eficiência, é necessário coletar e agregar o conteúdo de várias fontes e, em seguida, enviá-lo ao cliente. Devido ao esquema flexível, os bancos de dados de documentos são perfeitos para coletar e armazenar qualquer tipo de dados. É possível usá-los para criar e incorporar novos tipos de conteúdo, incluindo conteúdo gerado pelo usuário, como imagens, comentários e vídeos. Com o tempo, seu banco de dados pode exigir mais armazenamento. Com clusters elásticos, é possível distribuir seus dados em mais volumes de armazenamento, permitindo armazenar petabytes de dados em um único cluster.
## Vantagens dos clusters elásticos
### AWS integração de serviços
Os clusters elásticos do Amazon DocumentDB se integram a outros AWS serviços da mesma forma que o Amazon DocumentDB faz:
+ **Migração** — Você pode usar o AWS Database Migration Service (DMS) para migrar do MongoDB e de outros bancos de dados relacionais para os clusters elásticos do Amazon DocumentDB.
+ **Monitoramento** — Você pode monitorar a integridade e o desempenho do seu cluster elástico usando a Amazon CloudWatch.
+ **Segurança** — Você pode configurar a autenticação e a autorização por meio do AWS Identity and Access Management (IAM) para gerenciar seus recursos de cluster elástico, como criar e atualizar um cluster elástico, e usar o Amazon VPC para conexões seguras somente de VPC. Não há suporte para login de autenticação do IAM para clusters elásticos.
+ **Gerenciamento de dados** — Você pode usar AWS Glue para importar e exportar dados from/to outros AWS serviços, como Amazon S3, Amazon Redshift e OpenSearch Amazon Service.
## Região do cluster elástico e disponibilidade da versão
### Disponibilidade regional para clusters elásticos
A tabela a seguir mostra as AWS regiões em que os clusters elásticos do Amazon DocumentDB estão disponíveis atualmente e o endpoint de cada região.
| Nome da região | Região | Zonas de disponibilidade |
| --- | --- | --- |
| Leste dos EUA (Norte da Virgínia) | `us-east-1` | 5 |
| Leste dos EUA (Ohio) | `us-east-2` | 3 |
| Oeste dos EUA (Oregon) | `us-west-2` | 3 |
| Ásia-Pacífico (Hong Kong) | `ap-east-1` | 3 |
| Ásia-Pacífico (Mumbai) | `ap-south-1` | 3 |
| Ásia-Pacífico (Seul) | `ap-northeast-2` | 3 |
| Ásia-Pacífico (Singapura) | `ap-southeast-1` | 3 |
| Ásia-Pacífico (Sydney) | `ap-southeast-2` | 3 |
| Ásia-Pacífico (Tóquio) | `ap-northeast-1` | 3 |
| Canadá (Central) | `ca-central-1` | 3 |
| América do Sul (São Paulo) | `sa-east-1` | 3 |
| Europa (Frankfurt) | `eu-central-1` | 3 |
| Europa (Irlanda) | `eu-west-1` | 3 |
| Europa (Londres) | `eu-west-2` | 3 |
| Europa (Milão) | `eu-south-1` | 3 |
| Europa (Paris) | `eu-west-3` | 3 |
### Disponibilidade da versão
Os clusters elásticos oferecem suporte ao protocolo de conexão compatível com MongoDB 5.0. Para saber as diferenças entre clusters baseados em instâncias do Amazon DocumentDB 4.0 e clusters elásticos, consulte [Diferenças funcionais entre o Amazon DocumentDB 4.0 e clusters elásticos](elastic-how-it-works.md#elastic-functional-differences). Nota: Clusters elásticos não são compatíveis com o Amazon DocumentDB 8.0
## Limitações
### Gerenciamento de clusters elásticos
*Não* há suporte para os recursos e capacidades de gerenciamento de cluster a seguir nesta versão:
+ Porta personalizada (há suporte somente para 27017)
+ Capacidade de usar perfis e usuários do IAM para se autenticar no banco de dados
+ Capacidade de criar clusters globais
+ Eventos do Amazon DocumentDB existentes e como se inscrever neles
+ Fragmentação de alcance
+ Fragmentar a coleção existente
+ Chave de fragmento de vários campos
+ Alterar chave de fragmento
+ Point-in-time restaurar
+ Clonagem
+ Insights de Performance
**nota**
Para obter informações sobre limites elásticos de clusters, consulte [Cotas e limites do Amazon DocumentDB](limits.md).
### Operações de gravação e de consulta
*Não* há suporte para os comandos e recursos de operação de consulta e gravação a seguir nesta versão:
+ Comandos DDL durante operações de escalabilidade
+ Profiler
+ Grupos de parâmetros
+ AWS Config
+ AWS Backup
### Gerenciamento de coleções e índices
*Não* há suporte para os recursos de gerenciamento de coleções e índices a seguir nesta versão:
+ Índices exclusivos
+ Índices parciais
+ Índice de texto
+ Índices de vetores
+ Compactação de documentos
### Administração e diagnóstico
*Não* há suporte para os comandos e recursos de administração e diagnóstico a seguir nesta versão:
+ AWS Secrets Manager
+ Role-based-access-control Funções personalizadas (RBAC).
+ Ao conectar, a preocupação de gravação de 0 não é suportada.
+ Alteração de sub-redes pertencentes a uma VPC que não está atualmente atribuída a um cluster elástico existente.
### Funcionalidades de adesão
*Não* há suporte para os recursos opcionais do Amazon DocumentDB a seguir nesta versão:
+ Transações ACID
+ Auditoria de DDL/DML
+ Change streams
+ Comandos de sessão
# Clusters elásticos do Amazon DocumentDB: como funcionam
Os tópicos desta seção fornecem informações sobre os mecanismos e funções que alimentam os clusteres elásticos do Amazon DocumentDB.
**Topics**
+ [Fragmentação de clusters elásticos do Amazon DocumentDB](#elastic-how-it-works.sharding)
+ [Migração de clusters elásticos](#elastic-how-it-works-migration)
+ [Escalabilidade dos clusters elásticos](#elastic-how-it-works-scaling)
+ [Confiabilidade dos clusters elásticos](#elastic-reliability)
+ [Armazenamento e disponibilidade de clusters elásticos](#how-it-works-storage)
+ [Diferenças funcionais entre o Amazon DocumentDB 4.0 e clusters elásticos](#elastic-functional-differences)
## Fragmentação de clusters elásticos do Amazon DocumentDB
Os clusters elásticos do Amazon DocumentDB usam fragmentação baseada em hash para particionar dados em um sistema de armazenamento distribuído. A fragmentação, também conhecida como particionamento, divide grandes conjuntos de dados em pequenos conjuntos de dados em vários nós, permitindo aumentar a escala horizontalmente do seu banco de dados além dos limites de escala vertical. Os clusters elásticos usam a separação, ou “desacoplamento”, de computação e armazenamento no Amazon DocumentDB, permitindo que você escale independentemente um do outro. Em vez de reparticionar as coleções movendo pequenos pedaços de dados entre os nós de computação, os clusters elásticos copiam os dados de forma eficiente dentro do sistema de armazenamento distribuído.
![\[Um cluster elástico do Amazon DocumentDB contém vários fragmentos para dividir grandes conjuntos de dados em outros menores, permitindo uma melhor escalabilidade do banco de dados.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/shard-architecture.png)
### Definições de fragmentos
Definições da nomenclatura de fragmentos:
+ **Fragmento** — Um fragmento fornece computação para um cluster elástico. Ele terá uma única instância de gravador e de 0 a 15 réplicas de leitura. Por padrão, um fragmento terá duas instâncias: um gravador e uma única réplica de leitura. Você pode configurar no máximo 32 fragmentos e cada instância de fragmento pode ter no máximo 64 v. CPUs
+ **Chave de fragmento** — Uma chave de fragmento é um campo obrigatório em seus documentos JSON em coleções fragmentadas que os clusters elásticos usam para distribuir tráfego de leitura e gravação para o fragmento correspondente.
+ **Coleção fragmentada**: uma coleção fragmentada é uma coleção cujos dados são distribuídos em um cluster elástico em partições de dados.
+ **Partição** — Uma partição é uma parte lógica dos dados fragmentados. Quando você cria uma coleção fragmentada, os dados são organizados em partições dentro de cada fragmento automaticamente com base na chave do fragmento. Cada fragmento tem várias partições.
### Distribuir dados entre fragmentos configurados
Crie uma chave de fragmento que tenha muitos valores exclusivos. Uma boa chave de fragmento particionará uniformemente seus dados entre os fragmentos subjacentes, oferecendo à sua workload a melhor throughput e desempenho. O exemplo a seguir são dados de nome de funcionário que usam uma chave de fragmento chamada “user\$1id”:
![\[Os dados de um conjunto de dados são distribuídos uniformemente em vários fragmentos.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/sharding-detail-1.png)
O DocumentDB usa fragmentação de hash para particionar seus dados em fragmentos subjacentes. Dados adicionais são inseridos e distribuídos da mesma forma:
![\[Os dados de um novo conjunto de dados são distribuídos entre fragmentos por meio de fragmentação de hash.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/sharding-detail-2.png)
Quando você aumentar a escala de seu banco de dados horizontalmente, adicionando fragmentos, o Amazon DocumentDB redistribui automaticamente os dados:
![\[Os dados de um conjunto de dados são redistribuídos quando fragmentos adicionais são adicionados ao banco de dados.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/sharding-detail-3.png)
## Migração de clusters elásticos
O Amazon DocumentDB oferece suporte à migração de dados fragmentados do MongoDB para clusters elásticos. Há suporte para métodos de migração offline, online e híbrida. Para obter mais informações, consulte [Migrar para o Amazon DocumentDB](docdb-migration.md).
## Escalabilidade dos clusters elásticos
Os clusters elásticos do Amazon DocumentDB oferecem a capacidade de aumentar o número de fragmentos (escalabilidade horizontal) em seu cluster elástico e o número de v CPUs aplicado a cada fragmento (escalabilidade para cima). Você também pode reduzir o número de fragmentos e a capacidade computacional (vCPUs) conforme necessário.
Para obter as melhores práticas de escalabilidade, consulte [Escalar clusters elásticos](elastic-best-practices.md#scaling).
**nota**
O escalonamento em nível de cluster também está disponível. Para obter mais informações, consulte [Escalar clusters do Amazon DocumentDB](db-cluster-manage-performance.md).
## Confiabilidade dos clusters elásticos
O Amazon DocumentDB foi projetado para ser confiável, durável e tolerante a falhas. Para melhorar a disponibilidade, os clusters elásticos implantam dois nós por fragmento colocados em diferentes zonas de disponibilidade. O Amazon DocumentDB inclui vários recursos automáticos que o tornam uma solução de banco de dados confiável. Para obter mais informações, consulte [Confiabilidade do Amazon DocumentDB](how-it-works.md#how-it-works.reliability).
## Armazenamento e disponibilidade de clusters elásticos
Os dados do Amazon DocumentDB são armazenados em um volume de cluster, que é um único volume virtual que usa unidades de estado sólido ()SSDs. Um volume de cluster consiste em seis cópias de seus dados, que são replicadas automaticamente em várias zonas de disponibilidade em uma única AWS região. Essa replicação ajuda a garantir que seus dados sejam resilientes, com menor possibilidade de perda de dados. Isso também ajuda a garantir que o cluster esteja mais disponível durante um failover, pois as cópias dos dados já existem em outras zonas de disponibilidade. Para obter mais detalhes sobre armazenamento, alta disponibilidade e replicação, consulte [Amazon DocumentDB: como funciona](how-it-works.md).
## Diferenças funcionais entre o Amazon DocumentDB 4.0 e clusters elásticos
As seguintes diferenças funcionais existem entre o Amazon DocumentDB 4.0 e os clusters elásticos.
+ Os resultados de `top` e `collStats` são particionados por fragmentos. Para coleções fragmentadas, os dados são distribuídos entre várias partições e `collStats` informa `collScans` agregados a partir das partições.
+ As estatísticas de `top` e `collStats` para coleções fragmentadas são redefinidas quando a contagem de fragmentos do cluster é alterada.
+ A função integrada de backup agora é compatível com `serverStatus`. Ação: desenvolvedores e aplicações com função de backup podem coletar estatísticas sobre o estado do cluster Amazon DocumentDB.
+ O campo `SecondaryDelaySecs` substitui `slaveDelay` na saída `replSetGetConfig`.
+ O comando `hello` substitui `isMaster` - `hello` retorna um documento que descreve a função do cluster elástico.
+ O operador `$elemMatch` em clusters elásticos só corresponde aos documentos no primeiro nível de aninhamento de uma matriz. No Amazon DocumentDB 4.0, o operador percorre todos os níveis antes de devolver os documentos correspondentes. Por exemplo:
```
db.foo.insert(
[
{a: {b: 5}},
{a: {b: [5]}},
{a: {b: [3, 7]}},
{a: [{b: 5}]},
{a: [{b: 3}, {b: 7}]},
{a: [{b: [5]}]},
{a: [{b: [3, 7]}]},
{a: [[{b: 5}]]},
{a: [[{b: 3}, {b: 7}]]},
{a: [[{b: [5]}]]},
{a: [[{b: [3, 7]}]]}
]);
// Elastic clusters
> db.foo.find({a: {$elemMatch: {b: {$elemMatch: {$lt: 6, $gt: 4}}}}}, {_id: 0})
{ "a" : [ { "b" : [ 5 ] } ] }
// Docdb 4.0: traverse more than one level deep
> db.foo.find({a: {$elemMatch: {b: {$elemMatch: {$lt: 6, $gt: 4}}}}}, {_id: 0})
{ "a" : [ { "b" : [ 5 ] } ] }
{ "a" : [ [ { "b" : [ 5 ] } ] ] }
```
+ A projeção “\$1” no Amazon DocumentDB 4.0 retorna todos os documentos com todos os campos. Com clusters elásticos, o comando `find` com uma projeção “\$1” retorna documentos que correspondem ao parâmetro de consulta contendo somente o campo que corresponde à projeção “\$1”.
+ Em clusters elásticos, os comandos `find` com parâmetros de consulta `$regex` e `$options` retornam um erro: “Não é possível definir opções em \$1regex e \$1options”.
+ Com clusters elásticos, `$indexOfCP` agora retorna “-1" quando:
+ a substring não foi encontrada no `string expression`, ou
+ `start` é um número maior que `end`, ou
+ `start` é um número maior que o comprimento do byte da string.
No Amazon DocumentDB 4.0, `$indexOfCP` retorna “0" quando a posição `start` é um número maior que `end` ou o comprimento do byte da string.
+ Com clusters elásticos, as operações de projeção em `_id fields`, por exemplo, `{"_id.nestedField" : 1}`, retornam documentos que incluem apenas o campo projetado. Já no Amazon DocumentDB 4.0, os comandos de projeção de campo aninhados não filtram nenhum documento.
# Como iniciar com clusters elásticos do Amazon DocumentDB
Esta seção de introdução explica como é possível criar e consultar seu primeiro cluster elástico.
Há muitas formas de se conectar e começar a usar o Amazon DocumentDB. O procedimento a seguir é a maneira mais rápida, simples e fácil para os usuários começarem a usar nosso poderoso banco de dados de documentos. Este guia usa [AWS CloudShell](https://docs.aws.amazon.com/cloudshell/latest/userguide/welcome.html) para se conectar e consultar seu cluster do Amazon DocumentDB diretamente a partir do Console de gerenciamento da AWS. Novos clientes qualificados para o nível AWS gratuito podem usar o Amazon DocumentDB CloudShell gratuitamente. Se seu AWS CloudShell ambiente ou cluster elástico do Amazon DocumentDB fizer uso de recursos além do nível gratuito, você pagará as AWS taxas normais desses recursos. Este guia ajudará você a começar a usar o Amazon DocumentDB em menos de 5 minutos.
**Topics**
+ [Pré-requisitos](#elastic-clusters-prerequisites)
+ [Etapa 1: Criar um cluster do ElastiCache](#elastic-get-started-clusters)
+ [Etapa 2: conectar a seu cluster elástico](#ec-gs-connect)
+ [Etapa 3: fragmentar sua coleção; inserir e consultar dados](#elastic-get-started-shard)
+ [Etapa 4: explorar](#ec-gs-congrats)
## Pré-requisitos
Antes de criar o primeiro cluster do Amazon DocumentDB, você deve fazer o seguinte:
**Crie uma conta (AWS) da Amazon Web Services**
Antes de começar a usar o Amazon DocumentDB, você deve ter uma conta da Amazon Web Services (AWS). A AWS conta é gratuita. Você paga apenas pelos serviços e recursos usados.
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).
**Configure as permissões necessárias AWS Identity and Access Management (IAM).**
O acesso para gerenciar recursos do Amazon DocumentDB, como clusters, instâncias e grupos de parâmetros de cluster, requer credenciais que AWS possam ser usadas para autenticar suas solicitações. Para obter mais informações, consulte [Gerenciamento de identidade e Gerenciamento de acesso para o Amazon DocumentDB](security-iam.md).
1. Na barra de pesquisa do Console de gerenciamento da AWS, digite IAM e selecione **IAM** no menu suspenso.
1. Depois de chegar ao console do IAM, selecione **Usuários** no painel de navegação.
1. Selecione o nome de usuário.
1. Clique em **Add permissions** (Adicionar permissões).
1. Selecione **Anexar políticas diretamente**.
1. Digite `AmazonDocDBElasticFullAccess` na barra de pesquisa e selecione-a quando ela aparecer nos resultados da pesquisa.
1. Clique em **Next**.
1. Clique em **Add permissions** (Adicionar permissões).
****
Sua AWS conta inclui uma VPC padrão em cada região. Se você optar por usar uma Amazon VPC, conclua as etapas no tópico [Criação de uma Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc.html) no *Guia do usuário da Amazon VPC*.
## Etapa 1: Criar um cluster do ElastiCache
Nesta seção, explicamos como criar um novo 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 uma configuração de cluster elástico 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. No **Console de gerenciamento do Amazon DocumentDB**, em **Clusters**, escolha **Criar**.
![\[Tabela de clusters elásticos mostrando nenhum cluster como ponto de partida.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-start.png)
1. Na página **Criar cluster do Amazon DocumentDB**, na seção **Tipo de cluster**, escolha **Cluster elástico**.
![\[Caixa de diálogo Tipo de cluster do cluster elástico exibindo uma opção de clusters baseados em instância e clusters elásticos.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-type.png)
1. Na seção **Configuração**, configure o seguinte:
1. No campo **Nome do cluster**, insira um identificador de cluster exclusivo (seguindo os requisitos de nomenclatura abaixo do campo).
1. No campo **Contagem de fragmentos**, insira o número de fragmentos que você deseja em seu cluster. O número máximo de fragmentos por cluster é 32.
**nota**
Dois nós serão implantados para cada fragmento. Ambos os nós terão a mesma capacidade de fragmentos.
1. No campo **Contagem de instâncias de fragmento**, escolha o número de instâncias de réplica que você deseja associar a cada fragmento. O número máximo de instâncias de fragmento é 16, em incrementos de 1. Todas as instâncias de réplica têm a mesma capacidade de fragmentos, conforme definido no campo a seguir. Para fins de teste, o valor padrão de 2 deve ser suficiente.
**nota**
O número de instâncias de réplica se aplica a todos os fragmentos no cluster elástico. O valor 1 de contagem de instâncias de fragmento significa que há uma instância gravadora, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade. Para fins de teste, o valor padrão de 2 deve ser suficiente.
1. No campo **Capacidade do fragmento**, escolha o número de virtuais CPUs (vCPUs) que você deseja associar a cada instância do fragmento. O número máximo de v CPUs por instância de fragmento é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64. Para fins de teste, o valor padrão de 2 deve ser suficiente.
1. No campo **Nuvem Privada Virtual (VPC)**, escolha uma VPC na 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** (o mínimo é um).
![\[Caixa de diálogo de configuração do cluster elástico exibindo campos configuráveis.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-configuration.png)
1. Na seção **Autenticação**, insira uma string que identifique o nome de login do usuário principal no campo **Nome de usuário**.
No campo **Senha**, insira uma senha exclusiva que esteja em conformidade com as instruções e, em seguida, confirme-a.
![\[Seção de autenticação, que inclui campos de entrada para nome de usuário e senha.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-authentication.png)
1. Na seção **Criptografia**, mantenha a configuração padrão (**Chave padrão**).
Opcionalmente, você pode inserir um AWS KMS key ARN que você criou. Para obter mais informações, consulte [Criptografia de dados em repouso para clusters elásticos do Amazon DocumentDB](elastic-encryption.md).
**Importante**
A criptografia deve ser habilitada para clusters elásticos.
1. Na seção **Backup**, edite os campos de acordo com os requisitos do seu backup. Para fins de teste, é possível manter as configurações padrão.
![\[Captura de tela da caixa de diálogo Backup, mostrando as etapas para configurar a janela de backup do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-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. Na seção **Manutenção**, escolha o dia, a hora e a duração em que as modificações ou os patches serão aplicados ao seu cluster. Para fins de teste, é possível manter as configurações padrão.
![\[Seção de manutenção, mostrando as opções da janela de manutenção.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-maintenance.png)
1. Selecione **Criar cluster**.
Agora, seu cluster elástico está sendo provisionado. Esse processo pode levar até alguns minutos. É possível se conectar ao seu cluster quando o status do cluster elástico for exibido como **Disponível** na lista **Clusters**.
------
#### [ Using the AWS CLI ]
Para criar um cluster elástico usando o AWS CLI, use a `create-cluster` operação com os seguintes parâmetros:
+ **--cluster-name**—Obrigatório. O nome atual do cluster elástico de escala, conforme inserido durante a criação ou a última modificação.
+ **--shard-capacity**—Obrigatório. 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**—Obrigatório. 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.
+ **--admin-user-name**—Obrigatório. O nome de usuário associado ao usuário administrativo.
+ **--admin-user-password**—Obrigatório. A senha associada ao usuário administrativo.
+ **--auth-type**—Obrigatório. 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`.
+ **--vpc-security-group-ids**—Opcional. Configure uma lista de grupos de segurança da VPC do EC2 a serem associados 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.
+ **--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.
+ **--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
+ **--backup-retention-period**— opcional. O número de dias durante os quais os backups automatizados são retidos. O valor padrão é 1.
+ **--storage-encrypted**—Opcional. Configura se o cluster é criptografado ou não.
`--no-storage-encrypted` Especifica se o cluster é criptografado.
+ **--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.
**nota**
Os exemplos a seguir incluem a criação de uma chave KMS específica. Para usar a chave KMS padrão, não inclua o parâmetro `--kms-key-id`.
Para Linux, macOS ou Unix:
```
aws docdb-elastic create-cluster \
--cluster-name sample-cluster-123 \
--shard-capacity 8 \
--shard-count 4 \
--shard-instance-count 3 \
--auth-type PLAIN_TEXT \
--admin-user-name testadmin \
--admin-user-password testPassword \
--vpc-security-group-ids 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 \
--preferred-backup-window 18:00-18:30 \
--backup-retention-period 7
```
Para Windows:
```
aws docdb-elastic create-cluster ^
--cluster-name sample-cluster-123 ^
--shard-capacity 8 ^
--shard-count 4 ^
--shard-instance-count 3 ^
--auth-type PLAIN_TEXT ^
--admin-user-name testadmin ^
--admin-user-password testPassword ^
--vpc-security-group-ids 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 \
--preferred-backup-window 18:00-18:30 \
--backup-retention-period 7
```
------
## Etapa 2: conectar a seu cluster elástico
Conecte-se ao seu cluster elástico Amazon DocumentDB usando. AWS CloudShell
1. No console de gerenciamento do Amazon DocumentDB, em **Clusters**, localize o cluster elástico que você criou. Escolha o cluster clicando na caixa de seleção ao lado dele.
![\[Interface de gerenciamento de clusters do Amazon DocumentDB mostrando um cluster elástico\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-cluster-new.png)
1. Clique em **Conectar-se ao cluster** (que fica ao lado do menu suspenso **Ações**). Esse botão será habilitado somente depois que você clicar na caixa de seleção ao lado do seu cluster e o status do cluster for exibido como **Disponível**. A tela de **comando CloudShell Executar** é exibida.
1. No campo **Nome do novo ambiente**, insira um nome exclusivo, como "teste" e clique em **Criar e executar**. Os detalhes do ambiente da VPC são configurados automaticamente para o banco de dados do Amazon DocumentDB.
![\[Elastic Cluster CloudShell Execute a tela de comando solicitando o novo nome do ambiente\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-run-command.png)
1. Quando solicitado, insira a senha que você criou na Etapa 1: criação de um cluster elástico Amazon DocumentDB (subetapa 5).
![\[CloudShell Tela de cluster elástica solicitando a senha do usuário\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/ec-gs-cs-password.png)
Depois de você inserir sua senha e seu prompt se tornar `direct: mongos] >`, a conexão ao seu cluster do Amazon DocumentDB será concluída com êxito.
**nota**
Para obter mais informações sobre solução de problemas, consulte [Solução de problemas do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/troubleshooting.html).
## Etapa 3: fragmentar sua coleção; inserir e consultar dados
Clusters elásticos adicionam suporte para fragmentação no Amazon DocumentDB. Agora que você está conectado ao seu cluster, é possível fragmentar o cluster, inserir dados e executar algumas consultas.
1. Para fragmentar uma coleção, digite o seguinte:
```
sh.shardCollection("db.Employee1" , { "Employeeid" : "hashed" })
```
1. Para inserir um único documento, digite o seguinte:
```
db.Employee1.insertOne({"Employeeid":1, "Name":"Joe", "LastName": "Bruin", "level": 1 })
```
A seguinte saída é exibida:
```
WriteResult({ "nInserted" : 1 })
```
1. Para ler o documento que você escreveu, insira o comando `findOne()` (ele retorna apenas um único documento):
```
db.Employee1.findOne()
```
A seguinte saída é exibida:
```
{
"_id" : ObjectId("61f344e0594fe1a1685a8151"),
"EmployeeID" : 1,
"Name" : "Joe",
"LastName" : "Bruin",
"level" : 1
}
```
1. Para realizar mais algumas consultas, considere um caso de uso de perfil de jogo. Primeiro, insira algumas entradas em uma coleção intitulada "Funcionário”. Insira o seguinte:
```
db.profiles.insertMany([ { "_id": 1, "name": "Matt", "status": "active", "level": 12, "score": 202 },
{ "_id": 2, "name": "Frank", "status": "inactive", "level": 2, "score": 9 },
{ "_id": 3, "name": "Karen", "status": "active", "level": 7, "score": 87 },
{ "_id": 4, "name": "Katie", "status": "active", "level": 3, "score": 27 }
])
```
A seguinte saída é exibida:
```
{ acknowledged: true,
insertedIds: {
'0': ObjectId('679d02cd6b5a0581be78bcbd'),
'1': ObjectId('679d02cd6b5a0581be78bcbe'),
'2': ObjectId('679d02cd6b5a0581be78bcbf'),
'3': ObjectId('679d02cd6b5a0581be78bcc0')
}
}
```
1. Para retornar todos os documentos na coleção de perfis, insira o comando `find`():
```
db.Employee.find()
```
Os dados inseridos na etapa 4 são exibidos.
1. Para consultar um único documento, inclua um filtro (por exemplo: "Katie"). Insira o seguinte:
```
db.Employee.find({name: "Katie"})
```
A seguinte saída é exibida:
```
[
{
_id: ObjectId('679d02cd6b5a0581be78bcc0'),
Employeeid: 4,
name: 'Katie',
lastname: 'Schaper',
level: 3
}
]
```
1. Para encontrar um perfil e modificá-lo, digite o comando `findAndModify`. Neste exemplo, o funcionário "Matt" recebe um nível mais alto de "14":
```
db.Employee.findAndModify({
query: { "Employeeid" : 1, "name" : "Matt"},
update: { "Employeeid" : 1, "name" : "Matt", "lastname" : "Winkle", "level" : 14 }
})
```
A seguinte saída é exibida (observe que o nível ainda não foi alterado):
```
{
_id: ObjectId('679d02cd6b5a0581be78bcbd'),
Employeeid: 1,
name: 'Matt',
lastname: 'Winkle',
level: 12
}
```
1. Para verificar o aumento do nível, insira a seguinte consulta:
```
db.Employee.find({name: "Matt"})
```
A seguinte saída é exibida:
```
[
{
_id: ObjectId('679d02cd6b5a0581be78bcbd'),
Employeeid: 1,
name: 'Matt',
lastname: 'Winkle',
level: 14
}
]
```
## Etapa 4: explorar
Parabéns\$1 Você concluiu com êxito o procedimento Conceitos básicos dos clusters elásticos do Amazon DocumentDB.
E depois? Saiba como aproveitar ao máximo esse banco de dados com alguns de seus atributos populares:
+ [Práticas recomendadas para clusters elásticos do Amazon DocumentDB](elastic-best-practices.md)
+ [Gerenciamento de clusters elásticos do Amazon DocumentDB](elastic-managing.md)
**nota**
O cluster elástico que você criou a partir desse procedimento introdutório continuará gerando custos, a menos que seja excluído. Para obter instruções, consulte [Como excluir um cluster elástico](elastic-managing.md#elastic-delete).
# Práticas recomendadas para clusters elásticos do Amazon DocumentDB
Conheça as práticas recomendadas para trabalhar com clusters elásticos do Amazon DocumentDB. Todas as [práticas recomendadas para clusters Amazon DocumentDB baseados em instâncias](https://docs.aws.amazon.com/documentdb/latest/developerguide/best_practices.html) também se aplicam a clusters elásticos. Essa seção é continuamente atualizada conforme novas melhores práticas são identificadas.
**Topics**
+ [Selecionar chaves de fragmento](#choosing-shard-keys)
+ [Gerenciamento de conexões](#connection-management)
+ [Coleções não fragmentadas](#unsharded-collections)
+ [Escalar clusters elásticos](#scaling)
+ [Monitoramento de clusters elásticos](#monitoring-elastic-clusters)
## Selecionar chaves de fragmento
A lista a seguir descreve as diretrizes para criar chaves de fragmento.
+ Use uma chave de hash distribuída uniformemente para distribuir seus dados em todos os fragmentos do seu cluster (evite teclas de atalho).
+ Use sua chave de fragmento em todas as solicitações de leitura/atualização/exclusão para evitar dispersar as consultas de coleta.
+ Evite chaves de fragmento aninhadas ao realizar operações de leitura/atualização/exclusão.
+ Ao fazer operações em lote, defina `ordered` como falso para que todos os fragmentos possam ser executados paralelamente e melhorar as latências.
## Gerenciamento de conexões
A lista a seguir descreve as diretrizes para gerenciar as conexões com seu banco de dados.
+ Monitore suas contagens de conexões e a frequência com que novas conexões são abertas e fechadas.
+ Distribua suas conexões em todas as sub-redes na configuração da sua aplicação. Se seu cluster estiver configurado em várias sub-redes, mas você utilizar apenas um subconjunto das sub-redes, é possível sofrer um gargalo em suas conexões máximas.
## Coleções não fragmentadas
A seguir, é descrita uma diretriz para coleções não fragmentadas.
+ Ao trabalhar com coleções não fragmentadas no momento da distribuição da carga, tente manter coleções não fragmentadas altamente utilizadas em bancos de dados diferentes. Os clusters elásticos do Amazon DocumentDB colocam bancos de dados em diferentes fragmentos e co-localizam coleções não fragmentadas para o mesmo banco de dados no mesmo fragmento.
## Escalar clusters elásticos
A lista abaixo descreve as diretrizes para escalar seus clusters elásticos.
+ As operações de escalamento podem causar um breve período de erros intermitentes no banco de dados e na rede. Quando possível, evite escalar durante os horários de pico. Tente escalar durante as janelas de manutenção.
+ É preferível aumentar e diminuir a capacidade do fragmento (alterando a contagem de vCPU por fragmento) para aumentar a computação em vez de aumentar ou diminuir a contagem de fragmentos, pois é mais rápido e tem uma duração menor de erros intermitentes do banco de dados e rede.
+ Ao antecipar o crescimento, prefira aumentar a contagem de fragmentos em vez de aumentar a capacidade dos mesmos. Assim você pode escalar seu cluster aumentando a capacidade de fragmentação para cenários em que você precisa escalar rapidamente.
+ Monitore suas políticas de repetição do lado do cliente e tente novamente com recuo exponencial e instabilidade para evitar sobrecarregar seu banco de dados ao receber erros enquanto estiver escalando.
## Monitoramento de clusters elásticos
A lista abaixo descreve as diretrizes para monitorar seus clusters elásticos.
+ Acompanhe a proporção entre pico e média das suas métricas por fragmento para determinar se você está gerando tráfego irregular (tenha uma tecla de atalho ou ponto de acesso). As métricas-chave para monitorar os índices de pico em relação à média são:
+ `PrimaryInstanceCPUUtilization`
+ Pode ser monitorado em nível por fragmento.
+ Em nível do cluster, você pode monitorar a média de inclinação de p99.
+ `PrimaryInstanceFreeableMemory`
+ Pode ser monitorado em nível por fragmento.
+ Em nível do cluster, você pode monitorar a média de inclinação de p99.
+ `DatabaseCursorsMax`
+ Deve ser monitorado no nível por fragmento para determinar a inclinação.
+ `Documents-Inserted/Updated/Returned/Deleted`
+ Deve ser monitorado no nível por fragmento para determinar a inclinação.
# 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.
# Criptografia de dados em repouso para clusters elásticos do Amazon DocumentDB
Os tópicos a seguir ajudam você a aprender, criar e monitorar chaves de AWS Key Management Service criptografia para clusters elásticos do Amazon DocumentDB:
**Topics**
+ [Como os clusters elásticos do Amazon DocumentDB usam concessões em AWS KMS](#ec-encrypt-grants)
+ [Criar uma chave gerenciada pelo cliente](#ec-encrypt-create)
+ [Monitorar suas chaves de criptografia para clusters elásticos do Amazon DocumentDB](#ec-encrypt-monitor)
+ [Saiba mais](#ec-encrypt-learn)
Os clusters elásticos do Amazon DocumentDB se integram automaticamente com AWS Key Management Service (AWS KMS) para gerenciamento de chaves e usam um método conhecido como criptografia de envelope para proteger seus dados. Para ter mais informações sobre a criptografia de envelope, consulte [Criptografia de envelope](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping) no *Guia do desenvolvedor do AWS Key Management Service *.
An AWS KMS key é uma representação lógica de uma chave. A chave do KMS inclui metadados, como o ID da chave, a data de criação, a descrição e o estado da chave. A chave do KMS também contém o material de chave usado para criptografar e descriptografar dados. Para obter mais informações sobre as chaves do KMS, consulte [AWS KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys) no *Guia do desenvolvedor do AWS Key Management Service *.
Os clusters elásticos do Amazon DocumentDB oferecem suporte à criptografia com dois tipos de chaves:
+ **AWS chaves próprias —** os clusters elásticos do Amazon DocumentDB usam essas chaves por padrão para criptografar automaticamente dados de identificação pessoal. Você não pode visualizar, gerenciar ou usar chaves AWS de propriedade, nem auditar seu uso. No entanto, não é necessário tomar nenhuma medida nem alterar qualquer programa para proteger as chaves que criptografam seus dados. Para obter mais informações, consulte chaves de propriedade da [AWS no ](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk)Guia do desenvolvedor do *AWS Key Management Service *.
+ **Chaves gerenciadas pelo cliente —** simétricas AWS KMS keys que você cria, possui e gerencia. Como você tem controle total dessa camada de criptografia, você pode realizar tarefas como:
+ Estabelecer e manter as políticas de chave
+ Estabelecer e manter subsídios e IAM policies
+ Habilitar e desabilitar políticas de chaves
+ Alternar os materiais de criptografia de chave
+ Adicionar etiquetas
+ Criar réplicas de chaves
+ Chaves de agendamento para exclusão
Para obter mais informações, consulte [Customer managed keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) no *Guia do desenvolvedor do AWS Key Management Service *.
**Importante**
Você deve usar uma chave do KMS de criptografia simétrica para criptografar seu cluster, pois o Amazon DocumentDB só oferece suporte a chaves KMS de criptografia simétrica. Não use uma chave KMS assimétrica para tentar criptografar os dados nos clusters elásticos do Amazon DocumentDB. Para obter mais informações, consulte [Chaves assimétricas no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) no *Guia do desenvolvedor do AWS Key Management Service *.
Se o Amazon DocumentDB não puder mais obter acesso à chave de criptografia de um cluster por exemplo, quando o acesso a uma chave for revogado o cluster criptografado entrará em um estado de terminal. Nesse caso, só é possível restaurar o cluster a partir de um backup. Para o Amazon DocumentDB, os backups estão sempre habilitados para 1 dia. Além disso, se você desativar a chave para um cluster criptografado do Amazon DocumentDB, acabará perdendo o acesso de leitura e gravação a esse cluster. Quando o Amazon DocumentDB encontra um cluster que é criptografado por uma chave à qual ele não tem acesso, ele coloca o cluster em um estado terminal. Nesse estado, o cluster deixa de estar disponível e o estado atual do banco de dados não pode ser recuperado. Para restaurar o cluster, você deve reativar o acesso à chave de criptografia para o Amazon DocumentDB e, depois, restaurar o cluster a partir de um backup.
**Importante**
Não é possível alterar a chave KMS para um cluster criptografado depois de já tê-lo criado. Certifique-se de determinar seus requisitos de chave de criptografia antes de criar seu cluster elástico criptografado.
## Como os clusters elásticos do Amazon DocumentDB usam concessões em AWS KMS
Os clusters elásticos do Amazon DocumentDB exigem uma [concessão](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) para usar sua chave gerenciada pelo cliente.
Quando você cria um cluster criptografado com uma chave gerenciada pelo cliente, os clusters elásticos do Amazon DocumentDB criam uma concessão em seu nome enviando uma `CreateGrant` solicitação para. AWS KMS As concessões AWS KMS são usadas para dar aos clusters elásticos do Amazon DocumentDB acesso a uma chave KMS em uma conta de cliente.
Os clusters elásticos do Amazon DocumentDB exigem a concessão para usar sua chave gerenciada pelo cliente para as seguintes operações internas:
+ Envie `DescribeKey` solicitações AWS KMS para verificar se o ID simétrico da chave KMS gerenciada pelo cliente, inserido ao criar um rastreador ou uma coleção de cercas geográficas, é válido.
+ Envie `GenerateDataKey` solicitações AWS KMS para gerar chaves de dados criptografadas pela chave gerenciada pelo cliente.
+ Envie `Decrypt` solicitações AWS KMS para descriptografar as chaves de dados criptografadas para que elas possam ser usadas para criptografar seus dados.
+ É possível revogar o acesso à concessão, ou remover o acesso do serviço à chave gerenciada pelo cliente a qualquer momento. Se você fizer isso, os clusters elásticos do Amazon DocumentDB não poderão acessar nenhum dos dados criptografados com a chave gerenciada pelo cliente, o que afetará as operações que dependerem desses dados.
## Criar uma chave gerenciada pelo cliente
Você pode criar uma chave simétrica gerenciada pelo cliente usando a Console de gerenciamento da AWS ou a AWS KMS API.
**Criação das chaves simétricas gerenciadas pelo cliente**
Siga as etapas de [Criar uma chave simétrica gerenciada pelo cliente](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) no *Guia do desenvolvedor do AWS Key Management Service *.
**Política de chave**
As políticas de chaves controlam o acesso à chave gerenciada pelo cliente. Cada chave gerenciada pelo cliente deve ter exatamente uma política de chaves, que contém declarações que determinam quem pode usar a chave e como pode usá-la. Ao criar a chave gerenciada pelo cliente, é possível especificar uma política de chaves. Para obter mais informações, consulte as informações de acesso à chave KMS localizadas na [Visão geral do AWS Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/overview.html) no *Guia do desenvolvedor do AWS Key Management Service *.
Para usar sua chave gerenciada pelo cliente com recursos de cluster elástico do Amazon DocumentDB, as seguintes operações de API devem ser permitidas na política de chaves:
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html): Adiciona uma concessão a uma chave gerenciada pelo cliente. Concede acesso de controle a uma chave KMS especificada, que permite o acesso às operações de concessão exigidas pelo Amazon Location Service. Para obter mais informações sobre o uso de concessões, consulte [Concessões no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) no *Guia do desenvolvedor do AWS Key Management Service *.
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html): fornece os principais detalhes gerenciados pelo cliente para permitir que o Docdb Elastic valide a chave.
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html): permite que o Docdb Elastic use a chave de dados criptografada armazenada para acesse os dados criptografados.
+ [https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html) : permite que o Docdb Elastic gere uma chave de dados criptografada e a armazene, porque a chave de dados não é usada imediatamente para criptografar.
Para obter mais informações, consulte [Permissões para AWS serviços nas principais políticas](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-services.html) e [Solução de problemas de acesso por chave](https://docs.aws.amazon.com/kms/latest/developerguide/policy-evaluation.html) no *Guia do AWS Key Management Service desenvolvedor*.
**Restringir o acesso à chave gerenciada pelo cliente por meio de políticas do IAM**
Além das políticas de chaves KMS, você também pode restringir as permissões da chave KMS em uma política do IAM.
É possível tornar a política do IAM mais rígida de várias maneiras. Por exemplo, para permitir que a chave gerenciada pelo cliente só seja usada para solicitações provenientes do cluster elástico do Amazon DocumentDB, é possível utilizar a [chave de condição `kms:ViaService`](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-via-service) com o valor `docdb-elastic..amazonaws.com`.
Para obter mais informações, consulte [Como permitir que usuários em outras contas usem uma chave do KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) no *Guia do desenvolvedor do AWS Key Management Service *.
## Monitorar suas chaves de criptografia para clusters elásticos do Amazon DocumentDB
Ao usar uma chave gerenciada pelo AWS KMS key cliente com seus recursos do Docdb Elastic, você pode usar AWS CloudTrail o Amazon CloudWatch Logs para rastrear as solicitações para as quais o Docdb Elastic envia. AWS KMS
Os exemplos a seguir são AWS CloudTrail eventos para`CreateGrant`, `GenerateDataKeyWithoutPlainText``Decrypt`, e `DescribeKey` para monitorar AWS KMS key operações chamadas pelos clusters elásticos do Amazon DocumentDB para acessar dados criptografados pela chave gerenciada pelo cliente:
------
#### [ CreateGrant ]
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
"arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AROAIGDTESTANDEXAMPLE",
"arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"userName": "Sampleuser01"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2023-05-09T23:04:20Z",
"mfaAuthenticated": "false"
}
},
"invokedBy": "docdb-elastic.amazonaws.com"
},
"eventTime": "2023-05-09T23:55:48Z",
"eventSource": "kms.amazonaws.com",
"eventName": "CreateGrant",
"awsRegion": "us-east-1",
"sourceIPAddress": "docdb-elastic.amazonaws.com",
"userAgent": "docdb-elastic.amazonaws.com",
"requestParameters": {
"retiringPrincipal": "docdb-elastic.us-east-1.amazonaws.com",
"granteePrincipal": "docdb-elastic.us-east-1.amazonaws.com",
"operations": [
"Decrypt",
"Encrypt",
"GenerateDataKey",
"GenerateDataKeyWithoutPlaintext",
"ReEncryptFrom",
"ReEncryptTo",
"CreateGrant",
"RetireGrant",
"DescribeKey"
],
"keyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
},
"responseElements": {
"grantId": "0ab0ac0d0b000f00ea00cc0a0e00fc00bce000c000f0000000c0bc0a0000aaafSAMPLE",
"keyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
},
"requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"readOnly": false,
"resources": [
{
"accountId": "AWS Internal",
"type": "AWS::KMS::Key",
"ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
}
],
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
```
------
#### [ GenerateDataKey ]
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
"arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AROAIGDTESTANDEXAMPLE",
"arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"userName": "Sampleuser01"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2023-05-10T18:02:59Z",
"mfaAuthenticated": "false"
}
},
"invokedBy": "docdb-elastic.amazonaws.com"
},
"eventTime": "2023-05-10T18:03:25Z",
"eventSource": "kms.amazonaws.com",
"eventName": "GenerateDataKey",
"awsRegion": "us-east-1",
"sourceIPAddress": "docdb-elastic.amazonaws.com",
"userAgent": "docdb-elastic.amazonaws.com",
"requestParameters": {
"keySpec": "AES_256",
"keyId": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
},
"responseElements": null,
"requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"readOnly": true,
"resources": [
{
"accountId": "AWS Internal",
"type": "AWS::KMS::Key",
"ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
}
],
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
```
------
#### [ Decrypt ]
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
"arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AROAIGDTESTANDEXAMPLE",
"arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"userName": "Sampleuser01"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2023-05-10T18:05:49Z",
"mfaAuthenticated": "false"
}
},
"invokedBy": "docdb-elastic.amazonaws.com"
},
"eventTime": "2023-05-10T18:06:19Z",
"eventSource": "kms.amazonaws.com",
"eventName": "Decrypt",
"awsRegion": "us-east-1",
"sourceIPAddress": "docdb-elastic.amazonaws.com",
"userAgent": "docdb-elastic.amazonaws.com",
"requestParameters": {
"encryptionAlgorithm": "SYMMETRIC_DEFAULT"
},
"responseElements": null,
"requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"readOnly": true,
"resources": [
{
"accountId": "AWS Internal",
"type": "AWS::KMS::Key",
"ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
}
],
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
```
------
#### [ DescribeKey ]
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AROAIGDTESTANDEXAMPLE:Sampleuser01",
"arn": "arn:aws:sts::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE3",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AROAIGDTESTANDEXAMPLE",
"arn": "arn:aws:iam::111122223333:assumed-role/Admin/Sampleuser01",
"accountId": "111122223333",
"userName": "Sampleuser01"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2023-05-09T23:04:20Z",
"mfaAuthenticated": "false"
}
},
"invokedBy": "docdb-elastic.amazonaws.com"
},
"eventTime": "2023-05-09T23:55:48Z",
"eventSource": "kms.amazonaws.com",
"eventName": "DescribeKey",
"awsRegion": "us-east-1",
"sourceIPAddress": "docdb-elastic.amazonaws.com",
"userAgent": "docdb-elastic.amazonaws.com",
"requestParameters": {
"keyId": "alias/SampleKmsKey"
},
"responseElements": null,
"requestID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"eventID": "ff000af-00eb-00ce-0e00-ea000fb0fba0SAMPLE",
"readOnly": true,
"resources": [
{
"accountId": "AWS Internal",
"type": "AWS::KMS::Key",
"ARN": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-123456SAMPLE"
}
],
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
```
------
## Saiba mais
Os recursos a seguir fornecem mais informações sobre a criptografia de dados em pausa:
+ Para obter mais informações sobre AWS KMS conceitos, consulte [os conceitos AWS Key Management Service básicos](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html) no *Guia do AWS Key Management Service desenvolvedor*.
+ Para obter mais informações sobre AWS KMS segurança, consulte [as melhores práticas de segurança AWS Key Management Service](https://docs.aws.amazon.com/kms/latest/developerguide/best-practices.html) no *Guia do AWS Key Management Service desenvolvedor*.
# Funções vinculadas ao serviço em clusters elásticos
Os clusters elásticos do Amazon DocumentDB usam funções vinculadas a [serviços AWS Identity and Access Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role) (IAM). A função vinculada ao serviço é um tipo exclusivo de perfil do IAM vinculada diretamente aos clusters elásticos do Amazon DocumentDB. As funções vinculadas ao serviço são predefinidas pelos clusters elásticos do Amazon DocumentDB e incluem todas as permissões que o serviço exige para chamar outros AWS serviços em seu nome.
Uma função vinculada ao serviço facilita a utilização dos clusters elásticos do Amazon DocumentDB, já que não é preciso adicionar as permissões necessárias manualmente. Os clusters elásticos do Amazon DocumentDB definem as permissões dos perfis vinculados ao serviço e, a não ser que esteja definido de outra forma, somente os clusters elásticos do Amazon DocumentDB poderão assumir os perfis. As permissões definidas incluem a política de confiança e a política de permissões, que não pode ser anexada a nenhuma outra entidade do IAM. É possível excluir as funções somente depois de primeiro excluir seus recursos relacionados. Isso protege seus recursos dos clusters elásticos do Amazon DocumentDB, pois você não pode remover por engano as permissões necessárias para acessar os recursos.
Para obter informações sobre outros serviços que ofereçam suporte a perfis vinculados a serviços, consulte [serviços da AWS que funcionam com o IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) e procure por serviços marcados com **Sim** na coluna **Perfil vinculado a serviços**. Escolha um Sim com um link para visualizar a documentação do perfil vinculado para esse serviço.
## Permissões de função vinculadas ao serviço para clusters elásticos
Os clusters elásticos do Amazon DocumentDB usam a função vinculada ao serviço nomeada `AWS ServiceRoleForDocDB-Elastic` para permitir que os clusters elásticos do Amazon DocumentDB chamem AWS serviços em nome dos seus clusters.
Essa função vinculada a serviços tem uma política de permissões anexada a ela, chamada `AmazonDocDB-ElasticServiceRolePolicy`, que concede permissões para operar na conta. A política de permissões de função permite que os clusters elásticos do Amazon DocumentDB concluam as seguintes ações nos recursos especificados:
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"cloudwatch:PutMetricData"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"cloudwatch:namespace": [
"AWS/DocDB-Elastic"
]
}
}
}
]
}
```
------
**nota**
É necessário configurar as permissões para permitir que uma entidade do IAM (como um usuário, grupo ou perfil) crie, edite ou exclua uma função vinculada ao serviço. Se encontrar a seguinte mensagem de erro: **“Não foi possível criar o recurso. Você se você tem permissão para criar o perfil vinculado ao serviço. Caso contrário, aguarde e tente novamente mais tarde.”** , verifique se você tem as seguintes permissões ativadas:
```
{
"Action": "iam:CreateServiceLinkedRole",
"Effect": "Allow",
"Resource": "arn:aws:iam::*:role/aws-service-role/docdb-elastic.amazonaws.com/AWSServiceRoleForDocDB-Elastic",
"Condition": {
"StringLike": {
"iam:AWSServiceName":"docdb-elastic.amazonaws.com"
}
}
}
```
Para obter mais informações, consulte [Permissões de funções vinculadas a serviços](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#service-linked-role-permissions) no *Guia de usuário de gerenciamento de acesso e identidade AWS *.
### Criação de uma função vinculada ao serviço para clusters elásticos do Amazon DocumentDB
Não é necessário criar manualmente um perfil vinculado ao serviço. Quando você cria uma instância de BD, o Amazon DocumentDB elastic clusters cria a função vinculada ao serviço para você.
### Editar um perfil vinculado ao serviço para clusters elásticos do Amazon DocumentDB
Os clusters elásticos do Amazon DocumentDB não permitem que você edite a função vinculada ao serviço `AWS ServiceRoleForDocDB-Elastic`. Depois de criar uma função vinculada a um serviço, você não poderá alterar o nome da função porque várias entidades poderão fazer referência a ela. No entanto, será possível editar a descrição do perfil usando o IAM. Para obter mais informações, consulte [Editar uma função vinculada a serviço](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#edit-service-linked-role) no *Guia do usuário de gerenciamento de acesso e identidade AWS *.
#### Exclusão de uma função vinculada ao serviço para clusters elásticos do Amazon DocumentDB
Se você não precisar mais usar um atributo ou serviço que exija uma função vinculada a um serviço, recomendamos que você exclua essa função. Dessa forma, você não terá uma entidade não utilizada que não seja ativamente monitorada ou mantida. No entanto, você deve excluir todos os clusters antes de excluir a função vinculada ao serviço.
##### Limpar uma função vinculada ao serviço
Antes de usar o IAM para excluir uma função vinculada a um serviço, você deve primeiro confirmar que a função não tem sessões ativas e remover todos os recursos usados por ela.
Para verificar se a função vinculada ao serviço tem uma sessão ativa no console do IAM:
1. Faça login no [Console de gerenciamento da AWS](https://console.aws.amazon.com/iam/) e abra o console do IAM.
1. No painel de navegação do console do IAM, escolha **Funções**. A seguir, selecione o nome (não a caixa de seleção) da função `AWS ServiceRoleForDocDB-Elastic`.
1. Na página **Resumo** do perfil escolhido, escolha a guia **Consultor de acesso**.
**nota**
Se não tiver certeza se os clusters elásticos do Amazon DocumentDB estão usando a função `AWS ServiceRoleForDocDB-Elastic`, é possível tentar excluir a função. Se o serviço estiver usando a função, a exclusão falhará e você poderá ver Regiões da AWS onde a função está sendo usada. Se a função está sendo usada, você deve aguardar a sessão final antes de excluir a função. Não é possível revogar a sessão de uma função vinculada a um serviço.
Se quiser remover a função `AWS ServiceRoleForDocDB-Elastic`, você deve primeiro excluir todos os clusters.
##### Exclusão de todos os Clusters
Para excluir um cluster no console do Amazon DocumentDB:
1. Faça login [Console de gerenciamento da AWS](https://console.aws.amazon.com/docdb) e abra o console do Amazon DocumentDB.
1. No painel de navegação, escolha **Clusters**.
1. Escolha o cluster que você deseja excluir.
1. Em **Ações**, escolha **Excluir**.
1. Se for exibido **Criar snapshot final?**, escolha **Sim** ou **Não**.
1. Se você escolher **Sim** na etapa anterior, em **Nome do snapshot final**, digite o nome do snapshot final.
1. Escolha **Excluir**.
**nota**
É possível usar o console do IAM, a CLI do IAM ou a API do IAM para excluir a função vinculada ao serviço `AWS ServiceRoleForDocDB-Elastic`. Para obter mais informações, consulte [Excluir uma função vinculada a serviço](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role) no *Guia de usuário de gerenciamento de acesso e identidade AWS *.