FailoverGlobalCluster
Promove o cluster de banco de dados secundário especificado a cluster de banco de dados primário no cluster global quando ocorre o failover de um cluster global.
Use essa operação para responder a um evento não planejado, como um desastre regional na região primária. O failover pode ocasionar a perda dos dados da transação de gravação que não foram replicados para o secundário escolhido antes da ocorrência do evento de failover. No entanto, o processo de recuperação que promove uma instância de banco de dados no cluster de banco de dados principal escolhido para ser a instância de banco de dados primário do gravador garante que os dados estejam em um estado transacionalmente consistente.
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 do Amazon DocumentDB para aplicar essa operação. O identificador é a chave exclusiva atribuída pelo usuário quando o cluster é criado. Em outras palavras, é o nome do cluster global.
Restrições:
-
Deve ser o identificador de um cluster existente.
-
Tamanho mínimo de 1. Comprimento máximo de 255.
Padrão:
[A-Za-z][0-9A-Za-z-:._]*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
-
- TargetDbClusterIdentifier
-
O identificador do cluster do Amazon DocumentDB que você deseja promover a primário para o cluster global. Use o nome do recurso da Amazon (ARN) para o identificador para que o Amazon DocumentDB possa localizar o cluster em sua região AWS.
Restrições:
-
Deve ser o identificador de um cluster secundário existente.
-
Tamanho mínimo de 1. Comprimento máximo de 255.
Padrão:
[A-Za-z][0-9A-Za-z-:._]*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
-
- AllowDataLoss
-
Especifica se a perda de dados deve ser permitida para essa operação de cluster global. Permitir a perda de dados aciona uma operação de failover global.
Se você não especificar
AllowDataLoss, a operação do cluster global assumirá como padrão uma transição.Restrições:
-
Não pode ser especificado junto com o parâmetro
Switchover.
Tipo: Booliano
Obrigatório: Não
-
- Switchover
-
Especifica se é necessário fazer a transição desse cluster de banco de dados global.
Restrições:
-
Não pode ser especificado junto com o parâmetro
AllowDataLoss.
Tipo: booliano
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 ações, consulte Erros comuns.
- DBClusterNotFoundFault
-
DBClusterIdentifiernão se refere a um cluster existente.Código de Status HTTP: 404
- GlobalClusterNotFoundFault
-
GlobalClusterIdentifiernão se refere a um cluster global existente.Código de Status HTTP: 404
- InvalidDBClusterStateFault
-
O cluster não está em um estado válido.
Código de Status HTTP: 400
- 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:
