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á.
# ModifyDBCluster
Modifica uma configuração de um cluster do Amazon DocumentDB. É possível alterar um ou mais parâmetros de configuração do banco de dados especificando esses parâmetros e os novos valores na solicitação.
## Parâmetros de solicitação
Para obter informações sobre os parâmetros comuns que todas as ações utilizam, consulte [Parâmetros comuns](CommonParameters.md).
** DBClusterIdentifier **
O identificador do cluster que está sendo modificado. Esse parâmetro não diferencia maiúsculas de minúsculas.
Restrições:
+ Deve corresponder ao identificador de um `DBCluster` existente.
Tipo: String
Obrigatório: Sim
** AllowMajorVersionUpgrade **
Um valor que indica se as atualizações de versões principais são permitidas.
Restrições:
+ As atualizações de versões principais devem ser permitidas ao especificar um valor para o parâmetro `EngineVersion` que é uma versão principal diferente da versão atual do cluster.
+ Como alguns parâmetros são específicos da versão, alterá-los requer a execução de uma nova chamada da API `ModifyDBCluster` após a conclusão da MVU local.
A execução de uma MVU afeta diretamente os parâmetros a seguir:
+ `MasterUserPassword`
+ `NewDBClusterIdentifier`
+ `VpcSecurityGroupIds`
+ `Port`
Tipo: booliano
Obrigatório: não
** ApplyImmediately **
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
** BackupRetentionPeriod **
O número de dias durante os quais os backups automatizados são retidos. É necessário especificar o valor mínimo de 1.
Padrão: 1
Restrições:
+ Deve ser um valor de 1 a 35.
Tipo: inteiro
Obrigatório: não
** CloudwatchLogsExportConfiguration **
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](API_CloudwatchLogsExportConfiguration.md)
Obrigatório: não
** DBClusterParameterGroupName **
O nome do grupo de parâmetros do cluster a ser usado.
Tipo: string
Obrigatório: não
** DeletionProtection **
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
** EngineVersion **
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
** ManageMasterUserPassword **
Especifica se a senha do usuário principal deve ser gerenciada com o Amazon Web Services Secrets Manager. Se o cluster não gerenciar a senha do usuário principal com o Amazon Web Services Secrets Manager, será possível ativar esse gerenciamento. Nesse caso, você não pode especificar `MasterUserPassword`. Se o cluster já gerencia a senha do usuário principal com o Amazon Web Services Secrets Manager e você especifica que a senha do usuário principal não é gerenciada com o Amazon Web Services Secrets Manager, então você deve especificar `MasterUserPassword`. Nesse caso, o Amazon DocumentDB exclui o segredo e usa a nova senha para o usuário principal especificada por `MasterUserPassword`
Tipo: booliano
Obrigatório: não
** MasterUserPassword **
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
** MasterUserSecretKmsKeyId **
O identificador de chave do 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 caso ambas as condições a seguir sejam atendidas:
+ O cluster não gerencia a senha do usuário principal no Amazon Web Services Secrets Manager. Se o cluster já estiver gerenciando a senha do usuário principal no Amazon Web Services Secrets Manager, não será possível alterar a chave do KMS usada para criptografar o segredo.
+ Você está habilitando `ManageMasterUserPassword` para gerenciar a senha do usuário principal no Amazon Web Services Secrets Manager. Se você estiver ativando `ManageMasterUserPassword` e não especificar `MasterUserSecretKmsKeyId`, a chave do `aws/secretsmanager` KMS será usada para criptografar o segredo. Se o segredo estiver em uma conta da Amazon Web Services diferente, você não poderá usar a chave do `aws/secretsmanager` KMS para criptografar o segredo e deverá usar uma chave do KMS gerenciada pelo cliente.
O identificador de chave do Amazon Web Services KMS é o ARN da chave, o ID da chave, o ARN do alias ou o nome do alias da chave do KMS. Para usar uma chave do KMS em outra da Amazon Web Services, é necessário usar o ARN da chave ou o ARN do alias.
Há uma chave KMS padrão para sua conta do Amazon Web Services. Sua conta do Amazon Web Services tem uma chave KMS padrão diferente para cada região do Amazon Web Services.
Tipo: String
Obrigatório: não
** NetworkType **
O tipo de rede do cluster.
O tipo de rede é determinado usando o `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](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.
Valores válidos: `IPV4` \$1 `DUAL`
Tipo: string
Obrigatório: não
** NewDBClusterIdentifier **
O novo identificador do cluster durante a renomeação de um cluster. Esse valor é armazenado como uma string em minúsculas.
Restrições:
+ Deve conter de 1 a 63 caracteres, incluindo 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.
Exemplo: `my-cluster2`
Tipo: string
Obrigatório: não
** Port **
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
** PreferredBackupWindow **
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:
+ 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.
Tipo: string
Obrigatório: não
** PreferredMaintenanceWindow **
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
** RotateMasterUserPassword **
Especifica se o segredo gerenciado pelo Amazon Web Services Secrets Manager para a senha do usuário principal deve ser alternado.
Essa configuração é válida somente se a senha do usuário principal for gerenciada pelo Amazon DocumentDB no Amazon Web Services Secrets Manager para o cluster. O valor do segredo contém a senha atualizada.
Restrição: você deve aplicar a alteração imediatamente ao alternar a senha do usuário principal.
Tipo: booliano
Obrigatório: não
** ServerlessV2ScalingConfiguration **
Contém a configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.
Tipo: objeto [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
Obrigatório: não
** StorageType **
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
**VpcSecurityGroupIds. VpcSecurityGroupIdN.**
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
## Elementos de Resposta
O elemento a seguir é retornado pelo serviço.
** DBCluster **
Informações detalhadas sobre um cluster.
Tipo: objeto [DBCluster](API_DBCluster.md)
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Você já tem um cluster com o identificador determinado.
Código de status HTTP: 400
** DBClusterNotFoundFault **
`DBClusterIdentifier` não se refere a um cluster existente.
Código de status HTTP: 404
** DBClusterParameterGroupNotFound **
`DBClusterParameterGroupName` não se refere a um grupo de parâmetros de cluster existente.
Código de status HTTP: 404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName` não se refere a um grupo de sub-redes existente.
Código de status HTTP: 404
** InvalidDBClusterStateFault **
O cluster não está em um estado válido.
Código de Status HTTP: 400
** InvalidDBInstanceState **
A instância especificada não está no estado *disponível*.
Código de Status HTTP: 400
** InvalidDBSecurityGroupState **
O estado do grupo de segurança não permite a exclusão.
Código de status HTTP: 400
** InvalidDBSubnetGroupStateFault **
O grupo de sub-redes não pode ser excluído porque está em uso.
Código de status HTTP: 400
** InvalidSubnet **
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
** InvalidVPCNetworkStateFault **
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
** NetworkTypeNotSupported **
Não há suporte para o tipo de rede em nenhuma das versões do `DBSubnetGroup` ou do mecanismo de banco de dados.
Código de status HTTP: 400
** StorageQuotaExceeded **
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
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster)