Skip to content

/AWS1/IF_RDS=>MODIFYDBCLUSTERPARAMGROUP()

About ModifyDBClusterParameterGroup

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

There are two types of parameters - dynamic parameters and static parameters. Changes to dynamic parameters are applied to the DB cluster immediately without a reboot. Changes to static parameters are applied only after the DB cluster is rebooted, which can be done using RebootDBCluster operation. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.

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~MODIFYDBCLUSTERPARAMGROUP
  IMPORTING
    !IV_DBCLUSTERPARAMGROUPNAME TYPE /AWS1/RDSSTRING 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 modify.

it_parameters TYPE /AWS1/CL_RDSPARAMETER=>TT_PARAMETERSLIST TT_PARAMETERSLIST

A list of parameters in the DB cluster parameter group to modify.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.

When the application method is immediate, changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.

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->modifydbclusterparamgroup(
  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|
).

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 modify parameters in a DB cluster parameter group

The following example modifies the values of parameters in a DB cluster parameter group.

DATA(lo_result) = lo_client->modifydbclusterparamgroup(
  it_parameters = VALUE /aws1/cl_rdsparameter=>tt_parameterslist(
    (
      new /aws1/cl_rdsparameter(
        iv_applymethod = |immediate|
        iv_parametername = |server_audit_logging|
        iv_parametervalue = |1|
      )
    )
    (
      new /aws1/cl_rdsparameter(
        iv_applymethod = |immediate|
        iv_parametername = |server_audit_logs_upload|
        iv_parametervalue = |1|
      )
    )
  )
  iv_dbclusterparamgroupname = |mydbclusterpg|
).