Skip to content

/AWS1/IF_RDS=>DESCRIBEENGINEDEFAULTPARAMS()

About DescribeEngineDefaultParameters

Returns the default engine and system parameter information for the specified database engine.

Method Signature

METHODS /AWS1/IF_RDS~DESCRIBEENGINEDEFAULTPARAMS
  IMPORTING
    !IV_DBPARAMETERGROUPFAMILY 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_rdsdscenginedefprmsrs
  RAISING
    /AWS1/CX_RDSCLIENTEXC
    /AWS1/CX_RDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_dbparametergroupfamily TYPE /AWS1/RDSSTRING /AWS1/RDSSTRING

The name of the DB parameter group family.

Valid Values:

  • aurora-mysql5.7

  • aurora-mysql8.0

  • aurora-postgresql10

  • aurora-postgresql11

  • aurora-postgresql12

  • aurora-postgresql13

  • aurora-postgresql14

  • custom-oracle-ee-19

  • custom-oracle-ee-cdb-19

  • db2-ae

  • db2-se

  • mariadb10.2

  • mariadb10.3

  • mariadb10.4

  • mariadb10.5

  • mariadb10.6

  • mysql5.7

  • mysql8.0

  • oracle-ee-19

  • oracle-ee-cdb-19

  • oracle-ee-cdb-21

  • oracle-se2-19

  • oracle-se2-cdb-19

  • oracle-se2-cdb-21

  • postgres10

  • postgres11

  • postgres12

  • postgres13

  • postgres14

  • sqlserver-ee-11.0

  • sqlserver-ee-12.0

  • sqlserver-ee-13.0

  • sqlserver-ee-14.0

  • sqlserver-ee-15.0

  • sqlserver-ex-11.0

  • sqlserver-ex-12.0

  • sqlserver-ex-13.0

  • sqlserver-ex-14.0

  • sqlserver-ex-15.0

  • sqlserver-se-11.0

  • sqlserver-se-12.0

  • sqlserver-se-13.0

  • sqlserver-se-14.0

  • sqlserver-se-15.0

  • sqlserver-web-11.0

  • sqlserver-web-12.0

  • sqlserver-web-13.0

  • sqlserver-web-14.0

  • sqlserver-web-15.0

Optional arguments:

it_filters TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST TT_FILTERLIST

A filter that specifies one or more parameters to describe.

The only supported filter is parameter-name. The results list only includes information about the 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 DescribeEngineDefaultParameters 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_rdsdscenginedefprmsrs /AWS1/CL_RDSDSCENGINEDEFPRMSRS

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->describeenginedefaultparams(
  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_dbparametergroupfamily = |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.
  lo_enginedefaults = lo_result->get_enginedefaults( ).
  IF lo_enginedefaults IS NOT INITIAL.
    lv_string = lo_enginedefaults->get_dbparametergroupfamily( ).
    lv_string = lo_enginedefaults->get_marker( ).
    LOOP AT lo_enginedefaults->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.
  ENDIF.
ENDIF.

To describe the default engine and system parameter information for the database engine

The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.

DATA(lo_result) = lo_client->describeenginedefaultparams( iv_dbparametergroupfamily = |mysql5.7| ) .