Como gerenciar snapshots de cluster elástico - Amazon DocumentDB
Como criar um snapshot manual de clusterComo visualizar um snapshot de cluster elásticoComo restaurar um cluster usando um snapshotCopiar um snapshot de cluster elásticoComo excluir um snapshot de cluster elásticoGerenciar um backup automático de snapshot de cluster elástico

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á.

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.

Como criar um snapshot manual de cluster

Nesta seção, explicamos como criar um snapshot manual de cluster elástico usando AWS Management Console ou AWS CLI com as instruções a seguir.

Using the AWS Management Console

Para criar um snapshot manual de cluster elástico usando o AWS Management Console:

  1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB.

  2. 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.

  3. Na página Snapshots, selecione Criar.

  4. 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
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 um cluster usando a AWS CLI, use a operação create-cluster-snapshot 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 espaço reservado para entrada do usuário 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 snapshot de cluster elástico usando o AWS Management Console ou AWS CLI com as instruções a seguir.

Using the AWS Management Console

Para visualizar informações sobre um snapshot de cluster elástico específico usando o AWS Management Console:

  1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB.

  2. 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.

  3. Na página Snapshots, escolha seu snapshot na lista clicando no nome na coluna Identificador do snapshot.

  4. Visualize as informações do seu snapshot em Detalhes.

    Diagrama: snapshot de visualização do cluster elástico
Using the AWS CLI

Para visualizar informações sobre um snapshot de cluster elástico específico usando o AWS CLI, use a operação get-cluster-snapshot 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 espaço reservado para entrada do usuário 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 operação get-cluster-snapshot 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 espaço reservado para entrada do usuário 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 operação list-cluster-snapshots 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 – Retorna todos os snapshots de cluster que o Amazon DocumentDB criou automaticamente para sua conta da AWS.

    • manual - Retorna todos os snapshots de cluster que você criou manualmente para sua conta da AWS.

    • shared - Retorna todos os snapshots manuais de cluster que foram compartilhados com sua conta da AWS.

    • 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)(marcador) 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 espaço reservado para entrada do usuário 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 o AWS Management Console ou AWS CLI com as instruções a seguir.

Using the AWS Management Console

Para restaurar de um snapshot de cluster usando a AWS Management Console:

  1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB.

  2. 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.

  3. Escolha o botão à esquerda do snapshot que você quer usar para restaurar um cluster, na coluna Identificador de snapshot.

  4. Em Ações, escolha Restaurar.

    Diagrama: restauração de cluster elástico a partir de um snapshot

  5. 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.

  6. No campo Nuvem Privada Virtual (VPC), escolha uma VPC da lista suspensa.

  7. 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).

  8. 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 de um snapshot usando a AWS CLI, use a operação restore-cluster-from-snapshot com os parâmetros a seguir:

  • --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 KMS da chave é o nome do recurso da Amazon (ARN) para a chave de criptografia do AWS KMS. 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 a chave de criptografia não for especificada no KmsKeyId e se o parâmetro for StorageEncrypted verdadeiro, o Amazon DocumentDB usará a chave de criptografia padrão.

  • --subnet-ids—Opcional. IDs de sub-rede da rede.

No exemplo a seguir, substitua cada espaço reservado para entrada do usuário 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 AWS Management Console ou a AWS CLI.

Using the AWS Management Console

Para copiar um snapshot de cluster elástico usando o AWS Management Console:

  1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB.

  2. 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.

  3. Escolha o botão à esquerda do snapshot que você quer copiar na coluna Identificador de snapshot.

  4. Escolha Ações e Copiar.

    Diagrama: snapshot de cópia de cluster elástico

  5. Em Identificador do novo snapshot, insira o nome do novo snapshot.

  6. 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.

  7. Em Criptografia, escolha uma chave padrão do AWS KMS 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.

  8. Escolha Copiar snapshot ao concluir.

Using the AWS CLI

Para copiar um snapshot de cluster elástico usando a AWS CLI, use a operação copy-cluster-snapshot com os parâmetros a seguir:

  • ‐‐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. Ao copiar o snapshot para outra Região da AWS, esse identificador deve estar no formato ARN da Região da AWS de origem. 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 podem terminar com um hífen ou conter dois hífens consecutivos.

No exemplo a seguir, substitua cada espaço reservado para entrada do usuário por suas próprias informações.

Para Linux, macOS ou Unix:

aws docdb-elastic copy-cluster-snapshot \
     ‐‐source-cluster-snapshot-arn <sample ARN> \
     ‐‐target-cluster-snapshot-name my-target-copied-snapshot

Para Windows:

aws docdb-elastic copy-cluster-snapshot ^
     ‐‐source-cluster-snapshot-arn <sample 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 AWS Management Console ou a AWS CLI.

Using the AWS Management Console

Para restaurar de um snapshot de cluster usando a AWS Management Console:

  1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB.

  2. 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.

  3. Escolha o botão à esquerda do snapshot que você quer usar para restaurar um cluster, na coluna Identificador de snapshot.

  4. Escolha Ações e Excluir.

    Diagrama: exclusão de snapshot de cluster elástico

  5. 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 a AWS CLI, use a operação delete-cluster-snapshot com os parâmetros a seguir:

  • --snapshot-arn—Obrigatório. O identificador ARN do snapshot que está sendo usado para restaurar o cluster.

No exemplo a seguir, substitua cada espaço reservado para entrada do usuário 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. Você pode 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 AWS Management Console ou a AWS CLI.

Using the AWS Management Console

Para definir um backup automático para um novo snapshot de cluster elástico usando o AWS Management Console:

  1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB.

  2. 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.

  3. Escolha o botão à esquerda do cluster no qual você quer alterar as configurações de backup, na coluna Identificador de cluster.

  4. Selecione Ações e Modificar.

  5. 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.

    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.

    2. 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.

      2. Escolha Sem preferência se quiser que o Amazon DocumentDB escolha a hora e a duração em que os backups são criados.

  6. 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 a AWS CLI, use a operação create-cluster-snapshot com os parâmetros a seguir:

  • --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 tempo de 8 horas para cada 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 espaço reservado para entrada do usuário por suas próprias informações.

O exemplo create-cluster a seguir cria o cluster sample-cluster elástico do Amazon DocumentDB 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