Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Fuerza una conmutación por error para un clúster.

Una conmutación por error de un clúster promueve una de las réplicas de Amazon DocumentDB (instancias de solo lectura) del clúster a instancia principal (la instancia de escritura del clúster).

Si se produce un error en la instancia principal, Amazon DocumentDB conmuta automáticamente a una réplica de Amazon DocumentDB, si existe. Puede forzar una conmutación por error cuando desee simular un error en una instancia principal para realizar pruebas.

## Parámetros de la solicitud
<a name="API_FailoverDBCluster_RequestParameters"></a>

 Para obtener información sobre los parámetros comunes a todas las acciones, consulte [Parámetros comunes](CommonParameters.md).

 ** DBClusterIdentifier **   
Un identificador del clúster para forzar una conmutación por error. Este parámetro no distingue entre mayúsculas y minúsculas.  
Restricciones:  
+ Debe coincidir con el identificador de un `DBCluster` existente.
Tipo: cadena  
Requerido: no

 ** TargetDBInstanceIdentifier **   
El nombre de la instancia que se va a promover a instancia principal.  
Debe especificar el identificador de instancias para una réplica de Amazon DocumentDB en el clúster. Por ejemplo, `mydbcluster-replica1`.  
Tipo: cadena  
Requerido: no

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

El servicio devuelve el siguiente elemento.

 ** DBCluster **   
Información detallada sobre un clúster.   
Tipo: objeto [DBCluster](API_DBCluster.md)

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

Para obtener información acerca de los errores comunes a todas las acciones, consulte [Errores comunes](CommonErrors.md).

 ** DBClusterNotFoundFault **   
 `DBClusterIdentifier` no hace referencia a un clúster existente.   
Código de estado HTTP: 404

 ** InvalidDBClusterStateFault **   
El clúster no se encuentra en un estado válido.  
Código de estado HTTP: 400

 ** InvalidDBInstanceState **   
 La instancia especificada no se encuentra en el estado *disponible*.   
Código de estado HTTP: 400

## Véase también
<a name="API_FailoverDBCluster_SeeAlso"></a>

Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+  [AWS Interfaz de línea de comandos 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)