failover_global_cluster ¶

def failover_global_cluster(
    self,
    *,
    config_overrides: Optional[NeptuneClientConfig] = None,
    global_cluster_identifier: Optional[
        "capo_neptune.types.global_cluster_identifier.GlobalClusterIdentifier"
    ] = None,
    target_db_cluster_identifier: Optional[
        "capo_neptune.types.string.String"
    ] = None,
    allow_data_loss: Optional[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ] = None,
    switchover: Optional[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ] = None,
) -> (
    "capo_neptune.types.failover_global_cluster_result.FailoverGlobalClusterResult"
):
    """<p>Initiates the failover process for a Neptune global database.</p> <p>A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.</p> <note> <p>This action applies <b>only</b> to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.</p> </note>

    Args:
        global_cluster_identifier: <p>Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.</p> <p>Constraints: Must match the identifier of an existing Neptune global database.</p>
        target_db_cluster_identifier: <p>The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.</p>
        allow_data_loss: <p>Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.</p> <p>If you don't specify <code>AllowDataLoss</code>, the global database cluster operation defaults to a switchover.</p> <p>Constraints: Can't be specified together with the <code>Switchover</code> parameter.</p>
        switchover: <p>Specifies whether to switch over this global database cluster.</p> <p>Constraints: Can't be specified together with the <code>AllowDataLoss</code> parameter.</p>

    Raises:
        capo_neptune.errors.db_cluster_not_found_fault.DBClusterNotFoundFault: <p> <i>DBClusterIdentifier</i> does not refer to an existing DB cluster.</p>
        capo_neptune.errors.global_cluster_not_found_fault.GlobalClusterNotFoundFault: <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster. </p>
        capo_neptune.errors.invalid_db_cluster_state_fault.InvalidDBClusterStateFault: <p>The DB cluster is not in a valid state.</p>
        capo_neptune.errors.invalid_global_cluster_state_fault.InvalidGlobalClusterStateFault: <p>The global cluster is in an invalid state and can't perform the requested operation. </p>
        capo_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_neptune.types.failover_global_cluster_message.FailoverGlobalClusterMessage]",
    ) -> OperationResponse[
        "capo_neptune.types.failover_global_cluster_result.FailoverGlobalClusterResult"
    ]:
        import capo_neptune._operations.amazon_rd_sv19.failover_global_cluster

        output, http_response = (
            capo_neptune._operations.amazon_rd_sv19.failover_global_cluster.failover_global_cluster(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("FailoverGlobalCluster")
    )
    input_: capo_neptune.types.failover_global_cluster_message.FailoverGlobalClusterMessage = {}
    if global_cluster_identifier is not None:
        input_["global_cluster_identifier"] = global_cluster_identifier
    if target_db_cluster_identifier is not None:
        input_["target_db_cluster_identifier"] = target_db_cluster_identifier
    if allow_data_loss is not None:
        input_["allow_data_loss"] = allow_data_loss
    if switchover is not None:
        input_["switchover"] = switchover

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output