ModifyGlobalCluster - Amazon DocumentDB
Parâmetros de SolicitaçãoElementos de RespostaErrosConsulte Também

ModifyGlobalCluster

Modificar uma configuração de um cluster do Amazon DocumentDB global. Você pode alterar um ou mais parâmetros de configuração (por exemplo: proteção contra exclusão) ou o identificador global do cluster especificando esses parâmetros e os novos valores na solicitação.

nota

Essa ação se aplica somente aos clusters do Amazon DocumentDB.

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.

GlobalClusterIdentifier

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

Restrições:

  • Deve ser o identificador de um cluster existente.

Tipo: string

Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.

Padrão: [A-Za-z][0-9A-Za-z-:._]*

Obrigatório: Sim

DeletionProtection

Indica se o cluster global tem a proteção contra exclusão habilitada. O cluster global não pode ser excluído quando a proteção contra exclusão estiver habilitada.

Tipo: booleano

Obrigatório: Não

NewGlobalClusterIdentifier

O novo identificador de um cluster global quando você modifica um cluster global. Esse valor é armazenado como uma string em minúsculas.

  • 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 nem conter dois hifens consecutivos

Exemplo: my-cluster2

Tipo: string

Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.

Padrão: [A-Za-z][0-9A-Za-z-:._]*

Obrigatório: Não

Elementos de Resposta

O elemento a seguir é retornado pelo serviço.

GlobalCluster

Um tipo de dado que representa um cluster global do Amazon DocumentDB.

Tipo: objeto GlobalCluster

Erros

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

GlobalClusterNotFoundFault

GlobalClusterIdentifier não se refere a um cluster global existente.

Código de Status HTTP: 404

InvalidGlobalClusterStateFault

A operação solicitada não pode ser executada enquanto o cluster estiver nesse estado.

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: