RDS / Client / reset_db_parameter_group
reset_db_parameter_group#
- RDS.Client.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
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
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', 'SupportedEngineModes': [ 'string', ] }, ] )
- Parameters:
DBParameterGroupName (string) –
[REQUIRED]
The name of the DB parameter group.
Constraints:
Must match the name of an existing
DBParameterGroup
.
ResetAllParameters (boolean) – 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.
Parameters (list) –
To reset the entire DB parameter group, specify the
DBParameterGroup
name andResetAllParameters
parameters. To reset specific parameters, provide a list of the following:ParameterName
andApplyMethod
. 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
(dict) –
This data type is used as a request parameter in the
ModifyDBParameterGroup
andResetDBParameterGroup
actions.This data type is used as a response element in the
DescribeEngineDefaultParameters
andDescribeDBParameters
actions.ParameterName (string) –
The name of the parameter.
ParameterValue (string) –
The value of the parameter.
Description (string) –
Provides a description of the parameter.
Source (string) –
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.
SupportedEngineModes (list) –
The valid DB engine modes.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'DBParameterGroupName': 'string' }
Response Structure
(dict) –
Contains the result of a successful invocation of the
ModifyDBParameterGroup
orResetDBParameterGroup
operation.DBParameterGroupName (string) –
The name of the DB parameter group.
Exceptions
RDS.Client.exceptions.InvalidDBParameterGroupStateFault
RDS.Client.exceptions.DBParameterGroupNotFoundFault
Examples
This example resets all parameters for the specified DB parameter group to their default values.
response = client.reset_db_parameter_group( DBParameterGroupName='mydbparametergroup', ResetAllParameters=True, ) print(response)
Expected Output:
{ 'ResponseMetadata': { '...': '...', }, }