Skip to content

RDS  >  Operations  >  reset_db_parameter_group

reset_db_parameter_group

Operation

reset_db_parameter_group async 

reset_db_parameter_group(input: ResetDBParameterGroupInput, plugins: list[Plugin] | None = None) -> ResetDBParameterGroupOutput

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.

Parameters:

Name Type Description Default
input ResetDBParameterGroupInput

An instance of ResetDBParameterGroupInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ResetDBParameterGroupOutput

An instance of ResetDBParameterGroupOutput.

Input

ResetDBParameterGroupInput dataclass

Bases: _SerdeShape

Attributes

db_parameter_group_name class-attribute instance-attribute 
db_parameter_group_name: str | None = ...

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.
parameters class-attribute instance-attribute 
parameters: list[Parameter] | None = ...

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.

MySQL

Valid Values (for Apply 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, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply 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, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

reset_all_parameters class-attribute instance-attribute 
reset_all_parameters: bool | None = ...

Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

Output

ResetDBParameterGroupOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup operation.

Attributes

db_parameter_group_name class-attribute instance-attribute 
db_parameter_group_name: str | None = ...

The name of the DB parameter group.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.