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á.

# FailoverGlobalCluster
<a name="API_FailoverGlobalCluster"></a>

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 da solicitação
<a name="API_FailoverGlobalCluster_RequestParameters"></a>

 Para obter informações sobre os parâmetros comuns a todas as ações, consulte [Parâmetros Comuns](CommonParameters.md).

 ** 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 Amazon Resource Name (ARN) como 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
<a name="API_FailoverGlobalCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** GlobalCluster **   
Um tipo de dado que representa um cluster global do Amazon DocumentDB.  
Tipo: objeto [GlobalCluster](API_GlobalCluster.md)

## Erros
<a name="API_FailoverGlobalCluster_Errors"></a>

Para obter informações sobre os erros comuns a todas ações, consulte [Erros comuns](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` não se refere a um cluster existente.   
Código de status HTTP: 404

 ** GlobalClusterNotFoundFault **   
`GlobalClusterIdentifier` nã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
<a name="API_FailoverGlobalCluster_SeeAlso"></a>

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/FailoverGlobalCluster) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster)