DESCRIBEGLOBALCLUSTERS()`¶

About DescribeGlobalClusters¶

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

Method Signature¶

METHODS /AWS1/IF_DOD~DESCRIBEGLOBALCLUSTERS
  IMPORTING
    !IV_GLOBALCLUSTERIDENTIFIER TYPE /AWS1/DODGLOBALCLUSTERID OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_DODFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DODINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/DODSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dodglobalclustsmsg
  RAISING
    /AWS1/CX_DODGLBCLSTNOTFNDFAULT
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

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

The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.

`it_filters` `TYPE /AWS1/CL_DODFILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

A filter that specifies one or more global DB clusters to describe.

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

`iv_maxrecords` `TYPE /AWS1/DODINTEGEROPTIONAL` `/AWS1/DODINTEGEROPTIONAL`¶

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

`iv_marker` `TYPE /AWS1/DODSTRING` `/AWS1/DODSTRING`¶

An optional pagination token provided by a previous DescribeGlobalClusters request. 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_dodglobalclustsmsg` `/AWS1/CL_DODGLOBALCLUSTSMSG`¶

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->describeglobalclusters(
  it_filters = VALUE /aws1/cl_dodfilter=>tt_filterlist(
    (
      new /aws1/cl_dodfilter(
        it_values = VALUE /aws1/cl_dodfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_dodfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_globalclusteridentifier = |string|
  iv_marker = |string|
  iv_maxrecords = 123
).

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_globalclusters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_globalclusteridentifier = lo_row_1->get_globalclusteridentifier( ).
      lv_string = lo_row_1->get_globalclusterresourceid( ).
      lv_string = lo_row_1->get_globalclusterarn( ).
      lv_string = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_engine( ).
      lv_string = lo_row_1->get_engineversion( ).
      lv_string = lo_row_1->get_databasename( ).
      lv_booleanoptional = lo_row_1->get_storageencrypted( ).
      lv_booleanoptional = lo_row_1->get_deletionprotection( ).
      LOOP AT lo_row_1->get_globalclustermembers( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_dbclusterarn( ).
          LOOP AT lo_row_3->get_readers( ) 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.
          lv_boolean = lo_row_3->get_iswriter( ).
          lv_globalclustermembersync = lo_row_3->get_synchronizationstatus( ).
        ENDIF.
      ENDLOOP.
      lo_failoverstate = lo_row_1->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_row_1->get_taglist( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_key( ).
          lv_string = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_DOD=>DESCRIBEGLOBALCLUSTERS()¶