/AWS1/IF_ECA=>MODIFYREPLGROUPSHARDCONF()

About ModifyReplicationGroupShardConfiguration

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.

Method Signature

METHODS /AWS1/IF_ECA~MODIFYREPLGROUPSHARDCONF
  IMPORTING
    !IV_REPLICATIONGROUPID TYPE /AWS1/ECASTRING OPTIONAL
    !IV_NODEGROUPCOUNT TYPE /AWS1/ECAINTEGER OPTIONAL
    !IV_APPLYIMMEDIATELY TYPE /AWS1/ECABOOLEAN OPTIONAL
    !IT_RESHARDINGCONFIGURATION TYPE /AWS1/CL_ECARESHARDINGCONF=>TT_RESHARDINGCONFIGURATIONLIST OPTIONAL
    !IT_NODEGROUPSTOREMOVE TYPE /AWS1/CL_ECANODEGRPSTOREMLST_W=>TT_NODEGROUPSTOREMOVELIST OPTIONAL
    !IT_NODEGROUPSTORETAIN TYPE /AWS1/CL_ECANODEGRSTORTNLIST_W=>TT_NODEGROUPSTORETAINLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecamodreplgrshardco01
  RAISING
    /AWS1/CX_ECAINSUFFICIENTCACH00
    /AWS1/CX_ECAINVCACHECLSTSTAT00
    /AWS1/CX_ECAINVALIDKMSKEYFAULT
    /AWS1/CX_ECAINVPRMCOMBINATIO00
    /AWS1/CX_ECAINVPARAMVALUEEX
    /AWS1/CX_ECAINVREPLGRSTATEFA00
    /AWS1/CX_ECAINVVPCNETWORKSTA00
    /AWS1/CX_ECANODEGRSPERREPLGR00
    /AWS1/CX_ECANODEQUOTAFORCUSE00
    /AWS1/CX_ECAREPLGRPNOTFNDFAULT
    /AWS1/CX_ECACLIENTEXC
    /AWS1/CX_ECASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_replicationgroupid TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The name of the Valkey or Redis OSS (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

iv_nodegroupcount TYPE /AWS1/ECAINTEGER /AWS1/ECAINTEGER

The number of node groups (shards) that results from the modification of the shard configuration.

iv_applyimmediately TYPE /AWS1/ECABOOLEAN /AWS1/ECABOOLEAN

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

Optional arguments:

it_reshardingconfiguration TYPE /AWS1/CL_ECARESHARDINGCONF=>TT_RESHARDINGCONFIGURATIONLIST TT_RESHARDINGCONFIGURATIONLIST

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

it_nodegroupstoremove TYPE /AWS1/CL_ECANODEGRPSTOREMLST_W=>TT_NODEGROUPSTOREMOVELIST TT_NODEGROUPSTOREMOVELIST

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

it_nodegroupstoretain TYPE /AWS1/CL_ECANODEGRSTORTNLIST_W=>TT_NODEGROUPSTORETAINLIST TT_NODEGROUPSTORETAINLIST

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecamodreplgrshardco01 /AWS1/CL_ECAMODREPLGRSHARDCO01

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->modifyreplgroupshardconf(
  it_nodegroupstoremove = VALUE /aws1/cl_ecanodegrpstoremlst_w=>tt_nodegroupstoremovelist(
    ( new /aws1/cl_ecanodegrpstoremlst_w( |string| ) )
  )
  it_nodegroupstoretain = VALUE /aws1/cl_ecanodegrstortnlist_w=>tt_nodegroupstoretainlist(
    ( new /aws1/cl_ecanodegrstortnlist_w( |string| ) )
  )
  it_reshardingconfiguration = VALUE /aws1/cl_ecareshardingconf=>tt_reshardingconfigurationlist(
    (
      new /aws1/cl_ecareshardingconf(
        it_preferredazs = VALUE /aws1/cl_ecaazslist_w=>tt_availabilityzoneslist(
          ( new /aws1/cl_ecaazslist_w( |string| ) )
        )
        iv_nodegroupid = |string|
      )
    )
  )
  iv_applyimmediately = ABAP_TRUE
  iv_nodegroupcount = 123
  iv_replicationgroupid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_replicationgroup = lo_result->get_replicationgroup( ).
  IF lo_replicationgroup IS NOT INITIAL.
    lv_string = lo_replicationgroup->get_replicationgroupid( ).
    lv_string = lo_replicationgroup->get_description( ).
    lo_globalreplicationgroupi = lo_replicationgroup->get_globalreplgroupinfo( ).
    IF lo_globalreplicationgroupi IS NOT INITIAL.
      lv_string = lo_globalreplicationgroupi->get_globalreplicationgroupid( ).
      lv_string = lo_globalreplicationgroupi->get_glbreplgroupmemberrole( ).
    ENDIF.
    lv_string = lo_replicationgroup->get_status( ).
    lo_replicationgrouppending = lo_replicationgroup->get_pendingmodifiedvalues( ).
    IF lo_replicationgrouppending IS NOT INITIAL.
      lv_string = lo_replicationgrouppending->get_primaryclusterid( ).
      lv_pendingautomaticfailove = lo_replicationgrouppending->get_automaticfailoverstatus( ).
      lo_reshardingstatus = lo_replicationgrouppending->get_resharding( ).
      IF lo_reshardingstatus IS NOT INITIAL.
        lo_slotmigration = lo_reshardingstatus->get_slotmigration( ).
        IF lo_slotmigration IS NOT INITIAL.
          lv_double = lo_slotmigration->get_progresspercentage( ).
        ENDIF.
      ENDIF.
      lv_authtokenupdatestatus = lo_replicationgrouppending->get_authtokenstatus( ).
      lo_usergroupsupdatestatus = lo_replicationgrouppending->get_usergroups( ).
      IF lo_usergroupsupdatestatus IS NOT INITIAL.
        LOOP AT lo_usergroupsupdatestatus->get_usergroupidstoadd( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_usergroupid = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
        LOOP AT lo_usergroupsupdatestatus->get_usergroupidstoremove( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_usergroupid = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
      LOOP AT lo_replicationgrouppending->get_logdeliveryconfs( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_logtype = lo_row_3->get_logtype( ).
          lv_destinationtype = lo_row_3->get_destinationtype( ).
          lo_destinationdetails = lo_row_3->get_destinationdetails( ).
          IF lo_destinationdetails IS NOT INITIAL.
            lo_cloudwatchlogsdestinati = lo_destinationdetails->get_cloudwatchlogsdetails( ).
            IF lo_cloudwatchlogsdestinati IS NOT INITIAL.
              lv_string = lo_cloudwatchlogsdestinati->get_loggroup( ).
            ENDIF.
            lo_kinesisfirehosedestinat = lo_destinationdetails->get_kinesisfirehosedetails( ).
            IF lo_kinesisfirehosedestinat IS NOT INITIAL.
              lv_string = lo_kinesisfirehosedestinat->get_deliverystream( ).
            ENDIF.
          ENDIF.
          lv_logformat = lo_row_3->get_logformat( ).
        ENDIF.
      ENDLOOP.
      lv_booleanoptional = lo_replicationgrouppending->get_transitencryptionenabled( ).
      lv_transitencryptionmode = lo_replicationgrouppending->get_transitencryptionmode( ).
      lv_clustermode = lo_replicationgrouppending->get_clustermode( ).
    ENDIF.
    LOOP AT lo_replicationgroup->get_memberclusters( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_string = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_replicationgroup->get_nodegroups( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_string = lo_row_7->get_nodegroupid( ).
        lv_string = lo_row_7->get_status( ).
        lo_endpoint = lo_row_7->get_primaryendpoint( ).
        IF lo_endpoint IS NOT INITIAL.
          lv_string = lo_endpoint->get_address( ).
          lv_integer = lo_endpoint->get_port( ).
        ENDIF.
        lo_endpoint = lo_row_7->get_readerendpoint( ).
        IF lo_endpoint IS NOT INITIAL.
          lv_string = lo_endpoint->get_address( ).
          lv_integer = lo_endpoint->get_port( ).
        ENDIF.
        lv_string = lo_row_7->get_slots( ).
        LOOP AT lo_row_7->get_nodegroupmembers( ) into lo_row_8.
          lo_row_9 = lo_row_8.
          IF lo_row_9 IS NOT INITIAL.
            lv_string = lo_row_9->get_cacheclusterid( ).
            lv_string = lo_row_9->get_cachenodeid( ).
            lo_endpoint = lo_row_9->get_readendpoint( ).
            IF lo_endpoint IS NOT INITIAL.
              lv_string = lo_endpoint->get_address( ).
              lv_integer = lo_endpoint->get_port( ).
            ENDIF.
            lv_string = lo_row_9->get_preferredaz( ).
            lv_string = lo_row_9->get_preferredoutpostarn( ).
            lv_string = lo_row_9->get_currentrole( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
    lv_string = lo_replicationgroup->get_snapshottingclusterid( ).
    lv_automaticfailoverstatus = lo_replicationgroup->get_automaticfailover( ).
    lv_multiazstatus = lo_replicationgroup->get_multiaz( ).
    lo_endpoint = lo_replicationgroup->get_configurationendpoint( ).
    IF lo_endpoint IS NOT INITIAL.
      lv_string = lo_endpoint->get_address( ).
      lv_integer = lo_endpoint->get_port( ).
    ENDIF.
    lv_integeroptional = lo_replicationgroup->get_snapshotretentionlimit( ).
    lv_string = lo_replicationgroup->get_snapshotwindow( ).
    lv_booleanoptional = lo_replicationgroup->get_clusterenabled( ).
    lv_string = lo_replicationgroup->get_cachenodetype( ).
    lv_booleanoptional = lo_replicationgroup->get_authtokenenabled( ).
    lv_tstamp = lo_replicationgroup->get_authtokenlastmoddeddate( ).
    lv_booleanoptional = lo_replicationgroup->get_transitencryptionenabled( ).
    lv_booleanoptional = lo_replicationgroup->get_atrestencryptionenabled( ).
    LOOP AT lo_replicationgroup->get_memberclustsoutpostarns( ) into lo_row_10.
      lo_row_11 = lo_row_10.
      IF lo_row_11 IS NOT INITIAL.
        lv_string = lo_row_11->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string = lo_replicationgroup->get_kmskeyid( ).
    lv_string = lo_replicationgroup->get_arn( ).
    LOOP AT lo_replicationgroup->get_usergroupids( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_usergroupid = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_replicationgroup->get_logdeliveryconfs( ) into lo_row_12.
      lo_row_13 = lo_row_12.
      IF lo_row_13 IS NOT INITIAL.
        lv_logtype = lo_row_13->get_logtype( ).
        lv_destinationtype = lo_row_13->get_destinationtype( ).
        lo_destinationdetails = lo_row_13->get_destinationdetails( ).
        IF lo_destinationdetails IS NOT INITIAL.
          lo_cloudwatchlogsdestinati = lo_destinationdetails->get_cloudwatchlogsdetails( ).
          IF lo_cloudwatchlogsdestinati IS NOT INITIAL.
            lv_string = lo_cloudwatchlogsdestinati->get_loggroup( ).
          ENDIF.
          lo_kinesisfirehosedestinat = lo_destinationdetails->get_kinesisfirehosedetails( ).
          IF lo_kinesisfirehosedestinat IS NOT INITIAL.
            lv_string = lo_kinesisfirehosedestinat->get_deliverystream( ).
          ENDIF.
        ENDIF.
        lv_logformat = lo_row_13->get_logformat( ).
        lv_logdeliveryconfiguratio = lo_row_13->get_status( ).
        lv_string = lo_row_13->get_message( ).
      ENDIF.
    ENDLOOP.
    lv_tstamp = lo_replicationgroup->get_replgroupcreatetime( ).
    lv_datatieringstatus = lo_replicationgroup->get_datatiering( ).
    lv_boolean = lo_replicationgroup->get_autominorversionupgrade( ).
    lv_networktype = lo_replicationgroup->get_networktype( ).
    lv_ipdiscovery = lo_replicationgroup->get_ipdiscovery( ).
    lv_transitencryptionmode = lo_replicationgroup->get_transitencryptionmode( ).
    lv_clustermode = lo_replicationgroup->get_clustermode( ).
    lv_string = lo_replicationgroup->get_engine( ).
  ENDIF.
ENDIF.