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

# FailoverDBCluster
<a name="API_FailoverDBCluster"></a>

Força um failover para um cluster de banco de dados.

Um failover para um cluster promove uma das réplicas do Amazon DocumentDB (instâncias somente leitura) no cluster para ser a instância primária (o gravador do cluster).

Se a instância primária falhar, o Amazon DocumentDB fará o failover automaticamente para uma réplica do Amazon DocumentDB, se houver uma. É possível forçar um failover quando quiser simular uma falha de uma instância principal para testes.

## Parâmetros de Solicitação
<a name="API_FailoverDBCluster_RequestParameters"></a>

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

 ** DBClusterIdentifier **   
Um identificador de cluster para forçar um failover. 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: Não

 ** TargetDBInstanceIdentifier **   
O nome da instância a ser promovida a instância principal.  
É necessário especificar o identificador da instância para uma réplica de leitura do Amazon DocumentDB no cluster. Por exemplo, .`mydbcluster-replica1`  
Tipo: String  
Obrigatório: Não

## Elementos de Resposta
<a name="API_FailoverDBCluster_ResponseElements"></a>

O elemento a seguir é retornado pelo serviço.

 ** DBCluster **   
Informações detalhadas sobre um cluster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

## Erros
<a name="API_FailoverDBCluster_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

 ** 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

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