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`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_nep~failoverdbcluster(
  iv_dbclusteridentifier = |string|
  iv_targetdbinstanceid = |string|
).

This is an example of reading all possible response values

lv_integeroptional = lo_dbcluster->get_allocatedstorage( ).
LOOP AT lo_dbcluster->get_availabilityzones( ) into lo_row.
  lv_string = lo_row_1->get_value( ).
ENDLOOP.
lv_integeroptional = lo_dbcluster->get_backupretentionperiod( ).
lv_string = lo_dbcluster->get_charactersetname( ).
lv_string = lo_dbcluster->get_databasename( ).
lv_string = lo_dbcluster->get_dbclusteridentifier( ).
lv_string = lo_dbcluster->get_dbclusterparametergroup( ).
lv_string = lo_dbcluster->get_dbsubnetgroup( ).
lv_string = lo_dbcluster->get_status( ).
lv_string = lo_dbcluster->get_percentprogress( ).
lv_tstamp = lo_dbcluster->get_earliestrestorabletime( ).
lv_string = lo_dbcluster->get_endpoint( ).
lv_string = lo_dbcluster->get_readerendpoint( ).
lv_boolean = lo_dbcluster->get_multiaz( ).
lv_string = lo_dbcluster->get_engine( ).
lv_string = lo_dbcluster->get_engineversion( ).
lv_tstamp = lo_dbcluster->get_latestrestorabletime( ).
lv_integeroptional = lo_dbcluster->get_port( ).
lv_string = lo_dbcluster->get_masterusername( ).
LOOP AT lo_dbcluster->get_dbclustoptiongrpmember00( ) into lo_row_2.
  lv_string = lo_row_3->get_dbclusteroptiongroupname( ).
  lv_string = lo_row_3->get_status( ).
ENDLOOP.
lv_string = lo_dbcluster->get_preferredbackupwindow( ).
lv_string = lo_dbcluster->get_preferredmaintenancewi00( ).
lv_string = lo_dbcluster->get_replsourceidentifier( ).
LOOP AT lo_dbcluster->get_readreplicaidentifiers( ) into lo_row_4.
  lv_string = lo_row_5->get_value( ).
ENDLOOP.
LOOP AT lo_dbcluster->get_dbclustermembers( ) into lo_row_6.
  lv_string = lo_row_7->get_dbinstanceidentifier( ).
  lv_boolean = lo_row_7->get_isclusterwriter( ).
  lv_string = lo_row_7->get_dbclustparamgroupstatus( ).
  lv_integeroptional = lo_row_7->get_promotiontier( ).
ENDLOOP.
LOOP AT lo_dbcluster->get_vpcsecuritygroups( ) into lo_row_8.
  lv_string = lo_row_9->get_vpcsecuritygroupid( ).
  lv_string = lo_row_9->get_status( ).
ENDLOOP.
lv_string = lo_dbcluster->get_hostedzoneid( ).
lv_boolean = lo_dbcluster->get_storageencrypted( ).
lv_string = lo_dbcluster->get_kmskeyid( ).
lv_string = lo_dbcluster->get_dbclusterresourceid( ).
lv_string = lo_dbcluster->get_dbclusterarn( ).
LOOP AT lo_dbcluster->get_associatedroles( ) into lo_row_10.
  lv_string = lo_row_11->get_rolearn( ).
  lv_string = lo_row_11->get_status( ).
  lv_string = lo_row_11->get_featurename( ).
ENDLOOP.
lv_boolean = lo_dbcluster->get_iamdatabaseauthntctnenbd( ).
lv_string = lo_dbcluster->get_clonegroupid( ).
lv_tstamp = lo_dbcluster->get_clustercreatetime( ).
lv_booleanoptional = lo_dbcluster->get_copytagstosnapshot( ).
LOOP AT lo_dbcluster->get_enabledcloudwatchlogsexp( ) into lo_row_12.
  lv_string = lo_row_13->get_value( ).
ENDLOOP.
LOOP AT lo_pendingcloudwatchlogsex->get_logtypestoenable( ) into lo_row_12.
  lv_string = lo_row_13->get_value( ).
ENDLOOP.
LOOP AT lo_pendingcloudwatchlogsex->get_logtypestodisable( ) into lo_row_12.
  lv_string = lo_row_13->get_value( ).
ENDLOOP.
lv_string = lo_clusterpendingmodifiedv->get_dbclusteridentifier( ).
lv_booleanoptional = lo_clusterpendingmodifiedv->get_iamdatabaseauthntctnenbd( ).
lv_string = lo_clusterpendingmodifiedv->get_engineversion( ).
lv_integeroptional = lo_clusterpendingmodifiedv->get_backupretentionperiod( ).
lv_string = lo_clusterpendingmodifiedv->get_storagetype( ).
lv_integeroptional = lo_clusterpendingmodifiedv->get_allocatedstorage( ).
lv_integeroptional = lo_clusterpendingmodifiedv->get_iops( ).
lv_booleanoptional = lo_dbcluster->get_deletionprotection( ).
lv_booleanoptional = lo_dbcluster->get_crossaccountclone( ).
lv_tstamp = lo_dbcluster->get_automaticrestarttime( ).
lv_doubleoptional = lo_serverlessv2scalingconf->get_mincapacity( ).
lv_doubleoptional = lo_serverlessv2scalingconf->get_maxcapacity( ).
lv_globalclusteridentifier = lo_dbcluster->get_globalclusteridentifier( ).
lv_tstamp = lo_dbcluster->get_iooptimizednextalwedmo00( ).
lv_string = lo_dbcluster->get_storagetype( ).

/AWS1/CL_NEP=>FAILOVERDBCLUSTER()¶