reset_db_parameter_group

reset_db_parameter_group(**kwargs)

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod . To reset the entire DB parameter group, specify the DBParameterGroup name 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.

See also: AWS API Documentation

Request Syntax

response = client.reset_db_parameter_group(
    DBParameterGroupName='string',
    ResetAllParameters=True|False,
    Parameters=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'ApplyType': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string',
            'ApplyMethod': 'immediate'|'pending-reboot'
        },
    ]
)
Parameters
  • DBParameterGroupName (string) --

    [REQUIRED]

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.
  • ResetAllParameters (boolean) --

    Specifies whether ( true ) or not ( false ) to reset all parameters in the DB parameter group to default values.

    Default: true

  • Parameters (list) --

    To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod . A maximum of 20 parameters can be modified in a single request.

    Valid Values (for Apply method): pending-reboot

    • (dict) --

      Specifies a parameter.

      • ParameterName (string) --

        Specifies the name of the parameter.

      • ParameterValue (string) --

        Specifies the value of the parameter.

      • Description (string) --

        Provides a description of the parameter.

      • Source (string) --

        Indicates the source of the parameter value.

      • ApplyType (string) --

        Specifies the engine specific parameters type.

      • DataType (string) --

        Specifies the valid data type for the parameter.

      • AllowedValues (string) --

        Specifies the valid range of values for the parameter.

      • IsModifiable (boolean) --

        Indicates whether ( true ) or not ( false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion (string) --

        The earliest engine version to which the parameter can apply.

      • ApplyMethod (string) --

        Indicates when to apply parameter updates.

Return type

dict

Returns

Response Syntax

{
    'DBParameterGroupName': 'string'
}

Response Structure

  • (dict) --

    • DBParameterGroupName (string) --

      Provides the name of the DB parameter group.

Exceptions

  • Neptune.Client.exceptions.InvalidDBParameterGroupStateFault
  • Neptune.Client.exceptions.DBParameterGroupNotFoundFault