Skip to content

/AWS1/CL_NEP=>FAILOVERDBCLUSTER()

About FailoverDBCluster

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

Method Signature

IMPORTING

Optional arguments:

IV_DBCLUSTERIDENTIFIER TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

IV_TARGETDBINSTANCEID TYPE /AWS1/NEPSTRING /AWS1/NEPSTRING

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_NEPFAILOVERDBCLSTRS /AWS1/CL_NEPFAILOVERDBCLSTRS