ModifyDBCluster

O identificador do cluster que está sendo modificado. Esse parâmetro não diferencia maiúsculas de minúsculas.

Restrições:

Tipo: String

Obrigatório: Sim

Um valor que indica se as atualizações de versões principais são permitidas.

Restrições:

Tipo: booliano

Obrigatório: não

Um valor que especifica se as alterações feitas nesta solicitação e todas as alterações pendentes serão aplicadas de maneira assíncrona assim que possível, independentemente da configuração PreferredMaintenanceWindow do cluster. Caso esse parâmetro seja definido como false, as alterações feitas no cluster serão aplicadas durante a próxima janela de manutenção.

O parâmetro ApplyImmediately afeta somente os valores NewDBClusterIdentifier e MasterUserPassword. Se você definir o valor do parâmetro como false, as alterações nos valores NewDBClusterIdentifier e MasterUserPassword serão aplicados durante a próxima janela de manutenção. Todas as demais alterações serão aplicadas de imediato, independentemente do valor do parâmetro ApplyImmediately.

Padrão: false

Tipo: booliano

Obrigatório: não

O número de dias durante os quais os backups automatizados são retidos. Você deve especificar o valor mínimo de 1.

Padrão: 1

Restrições:

Tipo: inteiro

Obrigatório: não

A configuração dos tipos de log a serem habilitados para exportação para o Amazon CloudWatch Logs para uma instância ou cluster específico. As DisableLogTypes matrizes EnableLogTypes e determinam quais registros são exportados (ou não exportados) para o Logs. CloudWatch

Tipo: objeto CloudwatchLogsExportConfiguration

Obrigatório: Não

O nome do grupo de parâmetros do cluster a ser usado.

Tipo: String

Obrigatório: Não

Especifica se esse cluster pode ser excluído. Se DeletionProtection estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e DeletionProtection esteja desabilitado. DeletionProtection protege clusters contra exclusão acidental.

Tipo: booliano

Obrigatório: não

O número da versão do mecanismo de banco de dados para o qual você deseja atualizar. Alterar esse parâmetro resulta em uma interrupção. A alteração será aplicada durante a próxima janela de manutenção, a menos que ApplyImmediately seja definido.

Para listar todas as versões do mecanismo disponíveis para o Amazon DocumentDB, use o seguinte comando:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

Tipo: String

Obrigatório: Não

Especifica se a senha do usuário mestre deve ser gerenciada com o Amazon Web Services Secrets Manager. Se o cluster não gerenciar a senha do usuário mestre com o Amazon Web Services Secrets Manager, você poderá ativar esse gerenciamento. Nesse caso, você não pode especificarMasterUserPassword. Se o cluster já gerencia a senha do usuário mestre com o Amazon Web Services Secrets Manager e você especifica que a senha do usuário mestre não é gerenciada com o Amazon Web Services Secrets Manager, então você deve especificarMasterUserPassword. Nesse caso, o Amazon DocumentDB exclui o segredo e usa a nova senha para o usuário mestre especificada por. MasterUserPassword

Tipo: booliano

Obrigatório: não

A senha para o usuário do banco de dados principal. Ela pode conter qualquer caractere ASCII imprimível, exceto barra (/), aspas duplas (") ou arroba ("@").

Restrições: deve conter de 8 a 100 caracteres.

Tipo: String

Obrigatório: Não

O identificador de chave KMS do Amazon Web Services para criptografar um segredo que é gerado e gerenciado automaticamente no Amazon Web Services Secrets Manager.

Essa configuração é válida somente se as duas condições a seguir forem atendidas:

O identificador de chave KMS da Amazon Web Services é o ARN da chave, o ID da chave, o ARN do alias ou o nome do alias da chave KMS. Para usar uma chave KMS em uma conta diferente da Amazon Web Services, especifique o ARN da chave ou o alias ARN.

Há uma chave KMS padrão para sua conta do Amazon Web Services. Sua conta da Amazon Web Services tem uma chave KMS padrão diferente para cada região da Amazon Web Services.

Tipo: String

Obrigatório: Não

O tipo de rede do cluster.

O tipo de rede é determinado pelo DBSubnetGroup especificado para o cluster. A DBSubnetGroup pode suportar somente o IPv4 protocolo ou o IPv4 e os IPv6 protocolos (DUAL).

Para obter mais informações, consulte clusters do DocumentDB em uma VPC no Guia do desenvolvedor do Amazon DocumentDB.

Valores válidos: IPV4 | DUAL

Tipo: String

Obrigatório: Não

O novo identificador do cluster durante a renomeação de um cluster. Esse valor é armazenado como uma string em minúsculas.

Restrições:

Exemplo: my-cluster2

Tipo: string

Obrigatório: Não

O número da porta na qual o cluster aceita conexões.

Restrições: deve ser um valor entre 1150 e 65535.

Padrão: a mesma porta que a do cluster original.

Tipo: inteiro

Obrigatório: não

O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles forem habilitados com o parâmetro BackupRetentionPeriod.

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:

Tipo: String

Obrigatório: não

O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).

Formato: ddd:hh24:mi-ddd:hh24:mi

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, ocorrendo em um dia aleatório da semana.

Dias válidos: Seg, Ter, Qua, Qui, Sex, Sáb, Dom

Restrições: janela mínima de 30 minutos.

Tipo: String

Obrigatório: Não

Especifica se o segredo gerenciado pelo Amazon Web Services Secrets Manager deve ser alternado para a senha do usuário mestre.

Essa configuração é válida somente se a senha do usuário mestre for gerenciada pelo Amazon DocumentDB no Amazon Web Services Secrets Manager para o cluster. O valor secreto contém a senha atualizada.

Restrição: você deve aplicar a alteração imediatamente ao girar a senha do usuário mestre.

Tipo: booliano

Obrigatório: não

Contém a configuração de escalabilidade de um cluster Amazon DocumentDB Serverless.

Tipo: objeto ServerlessV2ScalingConfiguration

Obrigatório: Não

O tipo de armazenamento a ser associado ao cluster de banco de dados.

Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento do cluster no Guia do desenvolvedor do Amazon DocumentDB.

Valores válidos para o tipo de armazenamento - standard | iopt1

O valor padrão é standard .

Tipo: String

Obrigatório: Não

Uma lista de grupos de segurança da nuvem privada virtual (VPC) a serem associados ao cluster.

Tipo: matriz de strings

Obrigatório: Não

Informações detalhadas sobre um cluster.

Tipo: objeto DBCluster

Você já tem um cluster com o identificador determinado.

Código de status HTTP: 400

DBClusterIdentifier não se refere a um cluster existente.

Código de status HTTP: 404

DBClusterParameterGroupName não se refere a um grupo de parâmetros de cluster existente.

Código de status HTTP: 404

DBSubnetGroupName não se refere a um grupo de sub-redes existente.

Código de status HTTP: 404

O cluster não está em um estado válido.

Código de Status HTTP: 400

A instância especificada não está no estado disponível.

Código de Status HTTP: 400

O estado do grupo de segurança não permite a exclusão.

Código de status HTTP: 400

O grupo de sub-redes não pode ser excluído porque está em uso.

Código de status HTTP: 400

A sub-rede solicitada é inválida ou foram solicitadas várias sub-redes que não estão em uma nuvem privada virtual (VPC) comum.

Código de status HTTP: 400

O grupo de sub-rede não cobre todas as zonas de disponibilidade depois de ter sido criado devido às alterações feitas.

Código de status HTTP: 400

O tipo de rede não é suportado por nenhuma das DBSubnetGroup versões do mecanismo de banco de dados.

Código de status HTTP: 400

A solicitação faria com que você excedesse a quantidade permitida de armazenamento disponível em todas as instâncias.

Código de Status HTTP: 400