Skip to content

/AWS1/IF_ECA=>MODIFYGLOBALREPLICATIONGROUP()

About ModifyGlobalReplicationGroup

Modifies the settings for a Global datastore.

Method Signature

METHODS /AWS1/IF_ECA~MODIFYGLOBALREPLICATIONGROUP
  IMPORTING
    !IV_GLOBALREPLICATIONGROUPID TYPE /AWS1/ECASTRING OPTIONAL
    !IV_APPLYIMMEDIATELY TYPE /AWS1/ECABOOLEAN OPTIONAL
    !IV_CACHENODETYPE TYPE /AWS1/ECASTRING OPTIONAL
    !IV_ENGINE TYPE /AWS1/ECASTRING OPTIONAL
    !IV_ENGINEVERSION TYPE /AWS1/ECASTRING OPTIONAL
    !IV_CACHEPARAMETERGROUPNAME TYPE /AWS1/ECASTRING OPTIONAL
    !IV_GLOBALREPLGROUPDESC TYPE /AWS1/ECASTRING OPTIONAL
    !IV_AUTOMATICFAILOVERENABLED TYPE /AWS1/ECABOOLEANOPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecamdfyglbreplgrprslt
  RAISING
    /AWS1/CX_ECAGLBREPLGRNOTFNDF00
    /AWS1/CX_ECAINVGLBREPLGRSTAT00
    /AWS1/CX_ECAINVPARAMVALUEEX
    /AWS1/CX_ECACLIENTEXC
    /AWS1/CX_ECASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_globalreplicationgroupid TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The name of the Global datastore

iv_applyimmediately TYPE /AWS1/ECABOOLEAN /AWS1/ECABOOLEAN

This parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible. Modifications to Global Replication Groups cannot be requested to be applied in PreferredMaintenceWindow.

Optional arguments:

iv_cachenodetype TYPE /AWS1/ECASTRING /AWS1/ECASTRING

A valid cache node type that you want to scale this Global datastore to.

iv_engine TYPE /AWS1/ECASTRING /AWS1/ECASTRING

Modifies the engine listed in a global replication group message. The options are redis, memcached or valkey.

iv_engineversion TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The upgraded version of the cache engine to be run on the clusters in the Global datastore.

iv_cacheparametergroupname TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.

iv_globalreplgroupdesc TYPE /AWS1/ECASTRING /AWS1/ECASTRING

A description of the Global datastore

iv_automaticfailoverenabled TYPE /AWS1/ECABOOLEANOPTIONAL /AWS1/ECABOOLEANOPTIONAL

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecamdfyglbreplgrprslt /AWS1/CL_ECAMDFYGLBREPLGRPRSLT

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->modifyglobalreplicationgroup(
  iv_applyimmediately = ABAP_TRUE
  iv_automaticfailoverenabled = ABAP_TRUE
  iv_cachenodetype = |string|
  iv_cacheparametergroupname = |string|
  iv_engine = |string|
  iv_engineversion = |string|
  iv_globalreplgroupdesc = |string|
  iv_globalreplicationgroupid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_globalreplicationgroup = lo_result->get_globalreplicationgroup( ).
  IF lo_globalreplicationgroup IS NOT INITIAL.
    lv_string = lo_globalreplicationgroup->get_globalreplicationgroupid( ).
    lv_string = lo_globalreplicationgroup->get_globalreplgroupdesc( ).
    lv_string = lo_globalreplicationgroup->get_status( ).
    lv_string = lo_globalreplicationgroup->get_cachenodetype( ).
    lv_string = lo_globalreplicationgroup->get_engine( ).
    lv_string = lo_globalreplicationgroup->get_engineversion( ).
    LOOP AT lo_globalreplicationgroup->get_members( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_string = lo_row_1->get_replicationgroupid( ).
        lv_string = lo_row_1->get_replicationgroupregion( ).
        lv_string = lo_row_1->get_role( ).
        lv_automaticfailoverstatus = lo_row_1->get_automaticfailover( ).
        lv_string = lo_row_1->get_status( ).
      ENDIF.
    ENDLOOP.
    lv_booleanoptional = lo_globalreplicationgroup->get_clusterenabled( ).
    LOOP AT lo_globalreplicationgroup->get_globalnodegroups( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_string = lo_row_3->get_globalnodegroupid( ).
        lv_string = lo_row_3->get_slots( ).
      ENDIF.
    ENDLOOP.
    lv_booleanoptional = lo_globalreplicationgroup->get_authtokenenabled( ).
    lv_booleanoptional = lo_globalreplicationgroup->get_transitencryptionenabled( ).
    lv_booleanoptional = lo_globalreplicationgroup->get_atrestencryptionenabled( ).
    lv_string = lo_globalreplicationgroup->get_arn( ).
  ENDIF.
ENDIF.