/AWS1/CL_ECA=>DESCRIBEREPLICATIONGROUPS()

About DescribeReplicationGroups

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

This operation is valid for Valkey or Redis OSS only.

Method Signature

IMPORTING

Optional arguments:

iv_replicationgroupid TYPE /AWS1/ECASTRING /AWS1/ECASTRING

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

iv_maxrecords TYPE /AWS1/ECAINTEGEROPTIONAL /AWS1/ECAINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

iv_marker TYPE /AWS1/ECASTRING /AWS1/ECASTRING

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

RETURNING

oo_output TYPE REF TO /aws1/cl_ecareplgroupmessage /AWS1/CL_ECAREPLGROUPMESSAGE

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_eca~describereplicationgroups(
  iv_marker = |string|
  iv_maxrecords = 123
  iv_replicationgroupid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_replicationgroups( ) 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_description( ).
      lo_globalreplicationgroupi = lo_row_1->get_globalreplgroupinfo( ).
      IF lo_globalreplicationgroupi IS NOT INITIAL.
        lv_string = lo_globalreplicationgroupi->get_globalreplicationgroupid( ).
        lv_string = lo_globalreplicationgroupi->get_glbreplgroupmemberrole( ).
      ENDIF.
      lv_string = lo_row_1->get_status( ).
      lo_replicationgrouppending = lo_row_1->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_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_usergroupid = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_usergroupsupdatestatus->get_usergroupidstoremove( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_usergroupid = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
        LOOP AT lo_replicationgrouppending->get_logdeliveryconfs( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_logtype = lo_row_5->get_logtype( ).
            lv_destinationtype = lo_row_5->get_destinationtype( ).
            lo_destinationdetails = lo_row_5->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_5->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_row_1->get_memberclusters( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_nodegroups( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_string = lo_row_9->get_nodegroupid( ).
          lv_string = lo_row_9->get_status( ).
          lo_endpoint = lo_row_9->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_9->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_9->get_slots( ).
          LOOP AT lo_row_9->get_nodegroupmembers( ) into lo_row_10.
            lo_row_11 = lo_row_10.
            IF lo_row_11 IS NOT INITIAL.
              lv_string = lo_row_11->get_cacheclusterid( ).
              lv_string = lo_row_11->get_cachenodeid( ).
              lo_endpoint = lo_row_11->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_11->get_preferredaz( ).
              lv_string = lo_row_11->get_preferredoutpostarn( ).
              lv_string = lo_row_11->get_currentrole( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_snapshottingclusterid( ).
      lv_automaticfailoverstatus = lo_row_1->get_automaticfailover( ).
      lv_multiazstatus = lo_row_1->get_multiaz( ).
      lo_endpoint = lo_row_1->get_configurationendpoint( ).
      IF lo_endpoint IS NOT INITIAL.
        lv_string = lo_endpoint->get_address( ).
        lv_integer = lo_endpoint->get_port( ).
      ENDIF.
      lv_integeroptional = lo_row_1->get_snapshotretentionlimit( ).
      lv_string = lo_row_1->get_snapshotwindow( ).
      lv_booleanoptional = lo_row_1->get_clusterenabled( ).
      lv_string = lo_row_1->get_cachenodetype( ).
      lv_booleanoptional = lo_row_1->get_authtokenenabled( ).
      lv_tstamp = lo_row_1->get_authtokenlastmoddeddate( ).
      lv_booleanoptional = lo_row_1->get_transitencryptionenabled( ).
      lv_booleanoptional = lo_row_1->get_atrestencryptionenabled( ).
      LOOP AT lo_row_1->get_memberclustsoutpostarns( ) into lo_row_12.
        lo_row_13 = lo_row_12.
        IF lo_row_13 IS NOT INITIAL.
          lv_string = lo_row_13->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_kmskeyid( ).
      lv_string = lo_row_1->get_arn( ).
      LOOP AT lo_row_1->get_usergroupids( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_usergroupid = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_logdeliveryconfs( ) into lo_row_14.
        lo_row_15 = lo_row_14.
        IF lo_row_15 IS NOT INITIAL.
          lv_logtype = lo_row_15->get_logtype( ).
          lv_destinationtype = lo_row_15->get_destinationtype( ).
          lo_destinationdetails = lo_row_15->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_15->get_logformat( ).
          lv_logdeliveryconfiguratio = lo_row_15->get_status( ).
          lv_string = lo_row_15->get_message( ).
        ENDIF.
      ENDLOOP.
      lv_tstamp = lo_row_1->get_replgroupcreatetime( ).
      lv_datatieringstatus = lo_row_1->get_datatiering( ).
      lv_boolean = lo_row_1->get_autominorversionupgrade( ).
      lv_networktype = lo_row_1->get_networktype( ).
      lv_ipdiscovery = lo_row_1->get_ipdiscovery( ).
      lv_transitencryptionmode = lo_row_1->get_transitencryptionmode( ).
      lv_clustermode = lo_row_1->get_clustermode( ).
      lv_string = lo_row_1->get_engine( ).
    ENDIF.
  ENDLOOP.
ENDIF.

DescribeReplicationGroups

Returns information about the replication group myreplgroup.

DATA(lo_result) = lo_client->/aws1/if_eca~describereplicationgroups( ).