FAILOVERGLOBALCLUSTER()`¶

About FailoverGlobalCluster¶

Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.

Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

Method Signature¶

METHODS /AWS1/IF_DOD~FAILOVERGLOBALCLUSTER
  IMPORTING
    !IV_GLOBALCLUSTERIDENTIFIER TYPE /AWS1/DODGLOBALCLUSTERID OPTIONAL
    !IV_TARGETDBCLUSTERIDENTIFIER TYPE /AWS1/DODDBCLUSTERIDENTIFIER OPTIONAL
    !IV_ALLOWDATALOSS TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
    !IV_SWITCHOVER TYPE /AWS1/DODBOOLEANOPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dodfailoverglbclstrs
  RAISING
    /AWS1/CX_DODDBCLUSTNOTFNDFAULT
    /AWS1/CX_DODGLBCLSTNOTFNDFAULT
    /AWS1/CX_DODINVDBCLSTSTATEFA00
    /AWS1/CX_DODINVGLBCLSTSTATEF00
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_globalclusteridentifier` `TYPE /AWS1/DODGLOBALCLUSTERID` `/AWS1/DODGLOBALCLUSTERID`¶

The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster.

Constraints:

Must match the identifier of an existing global cluster.

Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

`iv_targetdbclusteridentifier` `TYPE /AWS1/DODDBCLUSTERIDENTIFIER` `/AWS1/DODDBCLUSTERIDENTIFIER`¶

The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region.

Constraints:

Must match the identifier of an existing secondary cluster.

Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Optional arguments:¶

`iv_allowdataloss` `TYPE /AWS1/DODBOOLEANOPTIONAL` `/AWS1/DODBOOLEANOPTIONAL`¶

Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation.

If you don't specify AllowDataLoss, the global cluster operation defaults to a switchover.

Constraints:

Can't be specified together with the Switchover parameter.

`iv_switchover` `TYPE /AWS1/DODBOOLEANOPTIONAL` `/AWS1/DODBOOLEANOPTIONAL`¶

Specifies whether to switch over this global database cluster.

Constraints:

Can't be specified together with the AllowDataLoss parameter.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dodfailoverglbclstrs` `/AWS1/CL_DODFAILOVERGLBCLSTRS`¶

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->failoverglobalcluster(
  iv_allowdataloss = ABAP_TRUE
  iv_globalclusteridentifier = |string|
  iv_switchover = ABAP_TRUE
  iv_targetdbclusteridentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_globalcluster = lo_result->get_globalcluster( ).
  IF lo_globalcluster IS NOT INITIAL.
    lv_globalclusteridentifier = lo_globalcluster->get_globalclusteridentifier( ).
    lv_string = lo_globalcluster->get_globalclusterresourceid( ).
    lv_string = lo_globalcluster->get_globalclusterarn( ).
    lv_string = lo_globalcluster->get_status( ).
    lv_string = lo_globalcluster->get_engine( ).
    lv_string = lo_globalcluster->get_engineversion( ).
    lv_string = lo_globalcluster->get_databasename( ).
    lv_booleanoptional = lo_globalcluster->get_storageencrypted( ).
    lv_booleanoptional = lo_globalcluster->get_deletionprotection( ).
    LOOP AT lo_globalcluster->get_globalclustermembers( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_dbclusterarn( ).
        LOOP AT lo_row_1->get_readers( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv_string = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv_boolean = lo_row_1->get_iswriter( ).
        lv_globalclustermembersync = lo_row_1->get_synchronizationstatus( ).
      ENDIF.
    ENDLOOP.
    lo_failoverstate = lo_globalcluster->get_failoverstate( ).
    IF lo_failoverstate IS NOT INITIAL.
      lv_failoverstatus = lo_failoverstate->get_status( ).
      lv_string = lo_failoverstate->get_fromdbclusterarn( ).
      lv_string = lo_failoverstate->get_todbclusterarn( ).
      lv_boolean = lo_failoverstate->get_isdatalossallowed( ).
    ENDIF.
    LOOP AT lo_globalcluster->get_taglist( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_string = lo_row_5->get_key( ).
        lv_string = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_DOD=>FAILOVERGLOBALCLUSTER()¶