FailoverGlobalCluster - Amazon DocumentDB

FailoverGlobalCluster

Hace que el clúster de base de datos secundario especificado sea el clúster de base de datos principal del clúster global cuando se produce una conmutación por error en un clúster global.

Utilice esta operación para responder a un suceso no planificado, como un desastre regional en la región principal. La conmutación por error puede provocar la pérdida de datos de transacciones de escritura que no se replicaron en el clúster secundario elegido antes de que se produjera el evento de conmutación por error. Sin embargo, el proceso de recuperación que promueve una instancia de base de datos del clúster de base de datos secundario elegido a instancia de base de datos principal de escritura garantiza que el estado de los datos sea coherente desde el punto de vista de las transacciones.

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

GlobalClusterIdentifier

El identificador del clúster global de Amazon DocumentDB para aplicar esta operación. El identificador es la clave única asignada por el usuario cuando se creó el clúster. Dicho de otro modo, es el nombre del clúster global.

Restricciones:

  • Debe coincidir con el identificador de un clúster existente.

  • Longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: [A-Za-z][0-9A-Za-z-:._]*

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: [A-Za-z][0-9A-Za-z-:._]*

Obligatorio: sí

TargetDbClusterIdentifier

El identificador del clúster secundario de Amazon DocumentDB que desea promover para que sea el principal del clúster global. Utilice el Nombre de recurso de Amazon (ARN) para el identificador de modo que Amazon DocumentDB pueda localizar el clúster en su región de AWS.

Restricciones:

  • Debe coincidir con el identificador de un clúster secundario existente.

  • Longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: [A-Za-z][0-9A-Za-z-:._]*

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: [A-Za-z][0-9A-Za-z-:._]*

Obligatorio: sí

AllowDataLoss

Especifica si se debe permitir la pérdida de datos para esta operación de clúster global. Al permitir la pérdida de datos, se desencadena una operación de conmutación por error global.

Si no especifica AllowDataLoss, la operación del clúster global se establece de forma predeterminada en una transición.

Restricciones:

  • No se puede especificar junto con el parámetro Switchover.

Tipo: Booleano

Requerido: no

Switchover

Especifica si se debe hacer la transición de este clúster de base de datos global.

Restricciones:

  • No se puede especificar junto con el parámetro AllowDataLoss.

Tipo: Booleano

Requerido: no

Elementos de respuesta

El servicio devuelve el siguiente elemento.

GlobalCluster

Tipo de datos que representa un clúster global de Amazon DocumentDB.

Tipo: objeto GlobalCluster

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

DBClusterNotFoundFault

DBClusterIdentifier no hace referencia a un clúster existente.

Código de estado HTTP: 404

GlobalClusterNotFoundFault

GlobalClusterIdentifier no hace referencia a un clúster global 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

InvalidGlobalClusterStateFault

La operación solicitada no se puede realizar mientras el clúster esté en este estado.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte: