DESCRIBEDBCLUSTERPARAMETERS()`¶

About DescribeDBClusterParameters¶

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Method Signature¶

METHODS /AWS1/IF_RDS~DESCRIBEDBCLUSTERPARAMETERS
  IMPORTING
    !IV_DBCLUSTERPARAMGROUPNAME TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_SOURCE 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_rdsdbclstparmgrdets
  RAISING
    /AWS1/CX_RDSDBPRMGRNOTFNDFAULT
    /AWS1/CX_RDSCLIENTEXC
    /AWS1/CX_RDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_dbclusterparamgroupname` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

Optional arguments:¶

`iv_source` `TYPE /AWS1/RDSSTRING` `/AWS1/RDSSTRING`¶

A specific source to return parameters for.

Valid Values:

engine-default

system

user

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

A filter that specifies one or more DB cluster parameters to describe.

The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.

`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 DescribeDBClusterParameters 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_rdsdbclstparmgrdets` `/AWS1/CL_RDSDBCLSTPARMGRDETS`¶

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->describedbclusterparameters(
  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_dbclusterparamgroupname = |string|
  iv_marker = |string|
  iv_maxrecords = 123
  iv_source = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_parameters( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_parametername( ).
      lv_potentiallysensitivepar = lo_row_1->get_parametervalue( ).
      lv_string = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_source( ).
      lv_string = lo_row_1->get_applytype( ).
      lv_string = lo_row_1->get_datatype( ).
      lv_string = lo_row_1->get_allowedvalues( ).
      lv_boolean = lo_row_1->get_ismodifiable( ).
      lv_string = lo_row_1->get_minimumengineversion( ).
      lv_applymethod = lo_row_1->get_applymethod( ).
      LOOP AT lo_row_1->get_supportedenginemodes( ) 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.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_marker( ).
ENDIF.

To describe the parameters in a DB cluster parameter group¶

The following example retrieves details about the parameters in a DB cluster parameter group.

DATA(lo_result) = lo_client->describedbclusterparameters( iv_dbclusterparamgroupname = |mydbclusterpg| ) .

/AWS1/IF_RDS=>DESCRIBEDBCLUSTERPARAMETERS()¶