/AWS1/IF_RDS=>RESETDBCLUSTERPARAMETERGROUP()

About ResetDBClusterParameterGroup

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora DB clusters, 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~RESETDBCLUSTERPARAMETERGROUP
  IMPORTING
    !IV_DBCLUSTERPARAMGROUPNAME TYPE /AWS1/RDSSTRING OPTIONAL
    !IV_RESETALLPARAMETERS TYPE /AWS1/RDSBOOLEAN OPTIONAL
    !IT_PARAMETERS TYPE /AWS1/CL_RDSPARAMETER=>TT_PARAMETERSLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rdsdbclstprmgrnamemsg
  RAISING
    /AWS1/CX_RDSDBPRMGRNOTFNDFAULT
    /AWS1/CX_RDSINVDBPRMGRSTATEF00
    /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 the DB cluster parameter group to reset.

Optional arguments:

iv_resetallparameters TYPE /AWS1/RDSBOOLEAN /AWS1/RDSBOOLEAN

Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

it_parameters TYPE /AWS1/CL_RDSPARAMETER=>TT_PARAMETERSLIST TT_PARAMETERSLIST

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

RETURNING

oo_output TYPE REF TO /aws1/cl_rdsdbclstprmgrnamemsg /AWS1/CL_RDSDBCLSTPRMGRNAMEMSG

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->resetdbclusterparametergroup(
  it_parameters = VALUE /aws1/cl_rdsparameter=>tt_parameterslist(
    (
      new /aws1/cl_rdsparameter(
        it_supportedenginemodes = VALUE /aws1/cl_rdsenginemodelist_w=>tt_enginemodelist(
          ( new /aws1/cl_rdsenginemodelist_w( |string| ) )
        )
        iv_allowedvalues = |string|
        iv_applymethod = |string|
        iv_applytype = |string|
        iv_datatype = |string|
        iv_description = |string|
        iv_ismodifiable = ABAP_TRUE
        iv_minimumengineversion = |string|
        iv_parametername = |string|
        iv_parametervalue = |string|
        iv_source = |string|
      )
    )
  )
  iv_dbclusterparamgroupname = |string|
  iv_resetallparameters = 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_dbclusterparamgroupname( ).
ENDIF.

To reset all parameters to their default values

The following example resets all parameter values in a customer-created DB cluster parameter group to their default values.

DATA(lo_result) = lo_client->resetdbclusterparametergroup(
  iv_dbclusterparamgroupname = |mydbclpg|
  iv_resetallparameters = ABAP_TRUE
).