Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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

Force le basculement d'un cluster.

En cas de basculement d'un cluster, l'une des répliques Amazon DocumentDB (instances en lecture seule) du cluster devient l'instance principale (le rédacteur du cluster).

En cas de défaillance de l'instance principale, Amazon DocumentDB bascule automatiquement vers une réplique Amazon DocumentDB, le cas échéant. Vous pouvez forcer un basculement lorsque vous souhaitez simuler un échec d'une instance principale à des fins de test.

## Paramètres de demande
<a name="API_FailoverDBCluster_RequestParameters"></a>

 Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).

 ** DBClusterIdentifier **   
Identifiant de cluster pour lequel forcer un basculement. Ce paramètre n'est pas sensible à la casse.  
Contraintes:  
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : chaîne  
Obligatoire : non

 ** TargetDBInstanceIdentifier **   
Nom de l'instance à promouvoir en instance principale.  
Vous devez spécifier l'identifiant d'instance pour une réplique Amazon DocumentDB dans le cluster. Par exemple, `mydbcluster-replica1`.  
Type : chaîne  
Obligatoire : non

## Éléments de réponse
<a name="API_FailoverDBCluster_ResponseElements"></a>

L'élément suivant est renvoyé par le service.

 ** DBCluster **   
Informations détaillées sur un cluster.   
Type : objet [DBCluster](API_DBCluster.md)

## Erreurs
<a name="API_FailoverDBCluster_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier`ne fait pas référence à un cluster existant.   
Code d’état HTTP :404

 ** InvalidDBClusterStateFault **   
Le cluster n'est pas dans un état valide.  
Code d’état HTTP : 400

 ** InvalidDBInstanceState **   
 L'instance spécifiée n'est pas dans l'état *disponible*.   
Code d’état HTTP : 400

## Voir aussi
<a name="API_FailoverDBCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster)