ModifyDBInstance - Amazon DocumentDB

ModifyDBInstance

Modifica as configurações de uma instância. Você pode 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 que são comuns a todas as ações, consulte Parâmetros comuns.

DBInstanceIdentifier

O identificador da instância. Esse valor é armazenado como uma string em minúsculas.

Restrições:

  • Deve corresponder ao identificador de um DBInstance existente.

Tipo: String

Obrigatório: Sim

ApplyImmediately

Especifica se as modificações feitas nessa solicitação e todas as modificações pendentes serão aplicadas de maneira assíncrona logo que possível, independentemente da configuração PreferredMaintenanceWindow da instância de banco de dados.

Caso esse parâmetro seja definido como false, as alterações feitas na instância de banco de dados serão aplicadas durante a próxima janela de manutenção. Algumas alterações de parâmetro podem causar uma interrupção e serão aplicadas na próxima reinicialização.

Padrão: false

Tipo: Booliano

Obrigatório: Não

AutoMinorVersionUpgrade

Esse parâmetro não é aplicável ao Amazon DocumentDB. O Amazon DocumentDB não faz atualizações de versões inferiores, independente do valor definido.

Tipo: Booliano

Obrigatório: Não

CACertificateIdentifier

Indica o certificado que deve ser associado à instância.

Tipo: String

Obrigatório: Não

CertificateRotationRestart

Especifica se a instância de banco de dados é reiniciada quando você alterna seu certificado SSL/TLS.

Por padrão, a instância de banco de dados é reiniciada quando você alterna seu certificado SSL/TLS. O certificado não é atualizado até que a instância de banco de dados seja reiniciada.

Importante

Defina esse parâmetro somente se não estiver usando SSL/TLS para se conectar à instância do banco de dados.

Se você estiver usando SSL/TLS para se conectar à instância de banco de dados, consulte Atualizando seus certificados TLS do Amazon DocumentDB e Criptografando dados no Transit no Guia de desenvolvedor do Amazon DocumentDB.

Tipo: Booliano

Obrigatório: Não

CopyTagsToSnapshot

Um valor que indica se todas as tags da instância de BD devem ser copiadas para snapshots da instância de BD. Por padrão, as tags não são copiadas.

Tipo: Booliano

Obrigatório: Não

DBInstanceClass

A nova capacidade de computação e memória da instância. Por exemplo, db.r5.large. Nem todas as classes de instância estão disponíveis em todos os Regiões da AWS.

Se você modificar a classe da instância, ocorrerá uma interrupção durante a alteração. A alteração será aplicada durante a próxima janela de manutenção, a menos que ApplyImmediately seja especificado como true para essa solicitação.

Padrão: Usa a configuração existente

Tipo: String

Obrigatório: Não

EnablePerformanceInsights

Um valor que indica se deve ser ativado o Performance Insights para a instância de BD. Para obter mais informações, consulte Usando insights de desempenho da Amazon.

Tipo: Booliano

Obrigatório: Não

NewDBInstanceIdentifier

O novo identificador da instância de banco de dados durante a renomeação de uma instância de banco de dados. Quando você altera o identificador da instância, a reinicialização da instância ocorre imediatamente se você definir Apply Immediately para true. Isso ocorrerá durante a próxima janela de manutenção se você definir Apply Immediately para false. 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 podem terminar com um hífen ou conter dois hífens consecutivos.

Exemplo: mydbinstance

Tipo: string

Obrigatório: Não

PerformanceInsightsKMSKeyId

O identificador de chave do AWS KMS para criptografia de dados de Insights de Performance.

O identificador de chave AWS KMS do KMS é o ARN da chave, o ID da chave, o ARN do apelido ou o nome do apelido da chave do KMS.

Se você não especificar um valor para PerformanceInsightsKMSKeyId, o Amazon DocumentDB usará sua chave KMS padrão. 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

PreferredMaintenanceWindow

O período semanal (em UTC) durante o qual pode ocorrer a manutenção do sistema, o que pode resultar em uma interrupção. A alteração desse parâmetro não resultará em uma interrupção, exceto na situação a seguir, e a alteração será aplicada de maneira assíncrona logo que possível. Se houver ações pendentes que causem uma reinicialização e a janela de manutenção for alterada para incluir a hora atual, a alteração desse parâmetro causará uma reinicialização da instância. Se essa janela for mudada para a hora atual, deverá haver pelo menos 30 minutos entre a hora atual e o final da janela para garantir que as alterações pendentes sejam aplicadas.

Padrão: Usa a configuração existente

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

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

Restrições: Deve ser, pelo menos, 30 minutos

Tipo: String

Obrigatório: Não

PromotionTier

Um valor que especifica a ordem em que uma réplica do Amazon DocumentDB é promovida para a instância primária após uma falha da instância primária existente.

Padrão: 1

Valores válidos: 0 a 15

Tipo: Inteiro

Obrigatório: Não

Elementos de Resposta

O elemento a seguir é retornado pelo serviço.

DBInstance

Informações detalhadas sobre uma instância.

Tipo: objeto DBInstance

Erros

Para obter informações sobre os erros comuns que todas as ações retornam, consulte Erros comuns.

AuthorizationNotFound

O IP CIDR ou o grupo de segurança do Amazon EC2 especificado não está autorizado para o grupo de segurança especificado.

O Amazon DocumentDB também pode não estar autorizado a executar as ações necessárias em seu nome usando o IAM.

Código de Status HTTP: 404

CertificateNotFound

CertificateIdentifier não se refere a um certificado existente.

Código de Status HTTP: 404

DBInstanceAlreadyExists

Você já tem uma instância com o identificador informado.

Código de Status HTTP: 400

DBInstanceNotFound

DBInstanceIdentifier não se refere a uma instância existente.

Código de Status HTTP: 404

DBParameterGroupNotFound

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

Código de Status HTTP: 404

DBSecurityGroupNotFound

DBSecurityGroupName não se refere a um grupo de segurança existente.

Código de Status HTTP: 404

DBUpgradeDependencyFailure

O upgrade falhou porque um recurso do qual ele depende não pode ser modificado.

Código de Status HTTP: 400

InsufficientDBInstanceCapacity

A classe de instância especificada não está disponível na Zona de Disponibilidade especificada.

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

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

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

StorageTypeNotSupported

O armazenamento do StorageType especificado não pode ser associado à instância do banco de dados.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: