DESCRIBEMULTIREGIONCLUSTERS()`¶

About DescribeMultiRegionClusters¶

Returns details about one or more multi-Region clusters.

Method Signature¶

METHODS /AWS1/IF_MEM~DESCRIBEMULTIREGIONCLUSTERS
  IMPORTING
    !IV_MULTIREGIONCLUSTERNAME TYPE /AWS1/MEMSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/MEMINTEGEROPTIONAL OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/MEMSTRING OPTIONAL
    !IV_SHOWCLUSTERDETAILS TYPE /AWS1/MEMBOOLEANOPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_memdscmultiregioncl01
  RAISING
    /AWS1/CX_MEMCLUSTNOTFOUNDFAULT
    /AWS1/CX_MEMINVPRMCOMBINATIO00
    /AWS1/CX_MEMINVPARAMVALUEEX
    /AWS1/CX_MEMMULTIREGIONCLSTN00
    /AWS1/CX_MEMCLIENTEXC
    /AWS1/CX_MEMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_multiregionclustername` `TYPE /AWS1/MEMSTRING` `/AWS1/MEMSTRING`¶

The name of a specific multi-Region cluster to describe.

`iv_maxresults` `TYPE /AWS1/MEMINTEGEROPTIONAL` `/AWS1/MEMINTEGEROPTIONAL`¶

The maximum number of results to return.

`iv_nexttoken` `TYPE /AWS1/MEMSTRING` `/AWS1/MEMSTRING`¶

A token to specify where to start paginating.

`iv_showclusterdetails` `TYPE /AWS1/MEMBOOLEANOPTIONAL` `/AWS1/MEMBOOLEANOPTIONAL`¶

Details about the multi-Region cluster.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_memdscmultiregioncl01` `/AWS1/CL_MEMDSCMULTIREGIONCL01`¶

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->describemultiregionclusters(
  iv_maxresults = 123
  iv_multiregionclustername = |string|
  iv_nexttoken = |string|
  iv_showclusterdetails = ABAP_TRUE
).

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_nexttoken( ).
  LOOP AT lo_result->get_multiregionclusters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_multiregionclustername( ).
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_nodetype( ).
      lv_string = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_integeroptional = lo_row_1->get_numberofshards( ).
      LOOP AT lo_row_1->get_clusters( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_clustername( ).
          lv_string = lo_row_3->get_region( ).
          lv_string = lo_row_3->get_status( ).
          lv_string = lo_row_3->get_arn( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_multiregionparamgrpname( ).
      lv_booleanoptional = lo_row_1->get_tlsenabled( ).
      lv_string = lo_row_1->get_arn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_MEM=>DESCRIBEMULTIREGIONCLUSTERS()¶