Modificar um cluster do Amazon DocumentDB

Para modificar um cluster, o mesmo deve estar no estado disponível. Você não pode modificar um cluster interrompido. Se o cluster for interrompido, primeiro inicie-o, aguarde até que fique disponível e faça as modificações desejadas. Para obter mais informações, consulte Interromper e iniciar um cluster do Amazon DocumentDB.

Using the AWS Management Console

Use o procedimento a seguir para modificar um cluster Amazon DocumentDB específico usando o console.

Para modificar um cluster do Amazon DocumentDB

1. Faça login no e abra AWS Management Console o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.

2. 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 () no canto superior esquerdo da página.

3. Especifique o cluster que você deseja modificar escolhendo o botão à esquerda do nome do cluster.

4. Escolha Ações e, em seguida, Modificar.

5. No painel Modificar cluster: <nome-do-cluster>, faça as alterações desejadas. Você pode fazer alterações nas seguintes áreas:

   • Especificações do cluster — o nome, os grupos de segurança e o gerenciamento de credenciais do cluster.

   • Configuração de armazenamento do cluster — o modo de armazenamento de dados do cluster. Escolha entre a configuração Padrão e Otimizado para E/S.

   • Opções do cluster— a porta e o grupo de parâmetros do cluster.

   • Backup— o período de retenção e a janela de backup do cluster.

   • Exportações de log— habilite ou desabilite exportação dos logs de auditoria ou de profiler.

   • Manutenção— defina a janela de manutenção do cluster.

   • Proteção contra exclusão— habilite ou desabilite a proteção contra exclusão no cluster. Por padrão, a proteção contra exclusão está habilitada.

6. Ao concluir, escolha Continuar para ver um resumo das alterações.

7. Se estiver satisfeito com suas alterações, poderá escolher Modificar cluster para modificar o cluster. Como alternativa, você pode escolher Voltar ou Cancelar para editar ou cancelar as alterações, respectivamente.

Levará alguns minutos para que suas alterações sejam aplicadas. Você pode usar o cluster somente quando seu status for disponível. Você pode monitorar o status do cluster usando o console ou a AWS CLI. Para obter mais informações, consulte Monitoramento do status de um cluster do Amazon DocumentDB.

Using the AWS CLI

Use a operação modify-db-cluster para modificar o cluster especificado usando a AWS CLI. Para mais informações, consulte ModifyDBCluster na Referência de API do Amazon DocumentDB.

Parâmetros

• --db-cluster-identifier—Obrigatório. O identificador do cluster do Amazon DocumentDB que você modificará.

• --backup-retention-period— opcional. O número de dias durante os quais os backups automatizados são retidos. Os valores válidos são 1–35.

• --storage-type— opcional. Configuração de armazenamento do cluster. Os valores válidos são standard (Padrão) ou iopt1 (Otimizado para E/S).

• --db-cluster-parameter-group-name— opcional. O nome do grupo de parâmetros do cluster a ser usado.

• --manage-master-user-password— opcional. O Amazon DocumentDB gera a senha do usuário mestre e a gerencia durante todo o seu ciclo de vida no Secrets Manager.

• --rotate-master-user-password—Opcional. O Secrets Manager gera uma nova versão secreta para o segredo existente. A nova versão do segredo contém a nova senha do usuário principal. O Amazon DocumentDB altera a senha do usuário principal do cluster para que corresponda à senha da nova versão secreta.

  Você deve especificar a --apply-immediately opção ao girar a senha principal.

• --master-user-password—Opcional. A nova senha para o usuário do banco de dados primário.

  Restrições de senha:

  • O comprimento é de [8–100] caracteres ASCII imprimíveis.

  • Pode usar quaisquer caracteres ASCII imprimíveis, exceto:

    • / (barra)

    • " (aspas duplas)

    • @ (arroba)

• --new-db-cluster-identifier— opcional. O novo identificador do cluster durante a renomeação de um cluster. Esse valor é armazenado como uma string em minúsculas.

  Restrições de nomenclatura:

  • O comprimento é de [1 a 63] letras, números ou hifens.

  • O primeiro caractere deve ser uma letra.

  • Não podem terminar com um hífen ou conter dois hífens consecutivos.

  • Deve ser exclusivo para todos os clusters do Amazon RDS, Amazon Neptune e Amazon DocumentDB por região. Conta da AWS

• --preferred-backup-window— opcional. O período diário durante o qual backups automatizados são criados, em formato Tempo Universal Coordenado (UTC).

  • Formato: hh24:mm-hh24:mm

• --preferred-maintenance-window— opcional. O intervalo de tempo semanal durante o qual pode ocorrer manutenção do sistema, em UTC.

  • Formato: ddd:hh24:mm-ddd:hh24:mm

  • Dias válidos: Sun, Mon, Tue, Wed, Thu, Fri e Sat.

• --deletion-protection ou --no-deletion-protection—opcional. Se a proteção contra exclusão deve ser habilitada neste cluster. A proteção contra exclusão impede que um cluster seja excluído acidentalmente até que o cluster seja modificado para desabilitar a proteção contra exclusão. Para obter mais informações, consulte Excluir um cluster do Amazon DocumentDB.

• --apply-immediately ou --no-apply-immediately—use --apply-immediately para aplicar a alteração imediatamente. Use --no-apply-immediately para aplicar a alteração durante a próxima janela de manutenção do cluster.

O código a seguir altera o período de retenção de backup para o cluster sample-cluster.

Para Linux, macOS ou Unix:

aws docdb modify-db-cluster \
       --db-cluster-identifier sample-cluster \
       --apply-immediately \
       --backup-retention-period 7

Para Windows:

aws docdb modify-db-cluster ^
       --db-cluster-identifier sample-cluster ^
       --apply-immediately ^
       --backup-retention-period 7

A saída dessa operação é semelhante à seguinte.

{
    "DBCluster": {
        "BackupRetentionPeriod": 7,
        "DbClusterResourceId": "cluster-VDP53QEWST7YHM36TTXOPJT5YE",
        "Status": "available",
        "DBClusterMembers": [
            {
                "PromotionTier": 1,
                "DBClusterParameterGroupStatus": "in-sync",
                "DBInstanceIdentifier": "sample-cluster-instance",
                "IsClusterWriter": true
            }
        ],
        "ReadReplicaIdentifiers": [],
        "AvailabilityZones": [
            "us-east-1b",
            "us-east-1c",
            "us-east-1a"
        ],
        "ReaderEndpoint": "sample-cluster.cluster-ro-ctevjxdlur57.us-east-1.rds.amazonaws.com",
        "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
        "PreferredMaintenanceWindow": "sat:09:51-sat:10:21",
        "EarliestRestorableTime": "2018-06-17T00:06:19.374Z",
        "StorageEncrypted": false,
        "MultiAZ": false,
        "AssociatedRoles": [],
        "MasterUsername": "<your-master-user-name>",
        "DBClusterIdentifier": "sample-cluster",
        "VpcSecurityGroups": [
            {
                "Status": "active",
                "VpcSecurityGroupId": "sg-77186e0d"
            }
        ],
        "HostedZoneId": "Z2SUY0A1719RZT",
        "LatestRestorableTime": "2018-06-18T21:17:05.737Z",
        "AllocatedStorage": 1,
        "Port": 27017,
        "Engine": "docdb",
        "DBClusterParameterGroup": "default.docdb3.4",
        "Endpoint": "sample-cluster.cluster-ctevjxdlur57.us-east-1.rds.amazonaws.com",
        "DBSubnetGroup": "default",
        "PreferredBackupWindow": "00:00-00:30",
        "EngineVersion": "3.4",
        "ClusterCreateTime": "2018-06-06T19:25:47.991Z",
        "IAMDatabaseAuthenticationEnabled": false
    }
}

Levará alguns minutos para que suas alterações sejam aplicadas. Você pode usar o cluster somente quando seu status for disponível. Você pode monitorar o status do cluster usando o console ou a AWS CLI. Para obter mais informações, consulte Monitoramento do status de um cluster do Amazon DocumentDB.