DESCRIBEDBCLUSTERENDPOINTS()`¶

About DescribeDBClusterEndpoints¶

Returns information about endpoints for an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Method Signature¶

METHODS /AWS1/IF_RDS~DESCRIBEDBCLUSTERENDPOINTS
  IMPORTING
    !IV_DBCLUSTERIDENTIFIER TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_DBCLUSTERENDPOINTID TYPE /AWS1/RDSSTRING OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/RDSINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/RDSSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rdsdbclustendptmsg
  RAISING
    /AWS1/CX_RDSDBCLUSTNOTFNDFAULT
    /AWS1/CX_RDSCLIENTEXC
    /AWS1/CX_RDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_dbclusteridentifier` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

`iv_dbclusterendpointid` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

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

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

`iv_maxrecords` `TYPE /AWS1/RDSINTEGEROPTIONAL` `/AWS1/RDSINTEGEROPTIONAL`¶

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

`iv_marker` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

An optional pagination token provided by a previous DescribeDBClusterEndpoints 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_rdsdbclustendptmsg` `/AWS1/CL_RDSDBCLUSTENDPTMSG`¶

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->describedbclusterendpoints(
  it_filters = VALUE /aws1/cl_rdsfilter=>tt_filterlist(
    (
      new /aws1/cl_rdsfilter(
        it_values = VALUE /aws1/cl_rdsfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_rdsfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_dbclusterendpointid = |string|
  iv_dbclusteridentifier = |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_dbclusterendpoints( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_dbclusterendpointid( ).
      lv_string = lo_row_1->get_dbclusteridentifier( ).
      lv_string = lo_row_1->get_dbclusterendptresourceid( ).
      lv_string = lo_row_1->get_endpoint( ).
      lv_string = lo_row_1->get_status( ).
      lv_string = lo_row_1->get_endpointtype( ).
      lv_string = lo_row_1->get_customendpointtype( ).
      LOOP AT lo_row_1->get_staticmembers( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_excludedmembers( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_dbclusterendpointarn( ).
    ENDIF.
  ENDLOOP.
ENDIF.

To describe DB cluster endpoints¶

The following example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type WRITER. You can use this endpoint for all SQL statements. The other endpoint has type READER. You can use this endpoint only for SELECT and other read-only SQL statements.

DATA(lo_result) = lo_client->describedbclusterendpoints( ).

To describe DB cluster endpoints of a single DB cluster¶

The following example retrieves details for the DB cluster endpoints of a single specified DB cluster. Aurora Serverless clusters have only a single endpoint with a type of WRITER.

DATA(lo_result) = lo_client->describedbclusterendpoints( iv_dbclusteridentifier = |serverless-cluster| ) .

/AWS1/IF_RDS=>DESCRIBEDBCLUSTERENDPOINTS()¶