ResetDBParameterGroup - Amazon Relational Database Service

Description

Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup 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.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required

Name	Description	Required
`DBParameterGroupName`	The name of the DB Parameter Group. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Type: String	Yes
`Parameters.member.N`	An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may 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. Oracle Valid Values (for Apply method): `pending-reboot` Type: Parameter list	No
`ResetAllParameters`	Specifies whether (`true`) or not (`false`) to reset all parameters in the DB Parameter Group to default values. Default: `true` Type: Boolean	No

DBParameterGroupName

The name of the DB Parameter Group.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Type: String

Yes

Parameters.member.N

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may 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.

Oracle

Valid Values (for Apply method): pending-reboot

Type: Parameter list

No

ResetAllParameters

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

Default: true

Type: Boolean

No

Response Elements

The following elements come wrapped in a ResetDBParameterGroupResult structure.

Name Description

Name	Description
`DBParameterGroupName`	The name of the DB Parameter Group. Type: String

DBParameterGroupName

The name of the DB Parameter Group.

Type: String

Errors

For information about the common errors that all actions use, see Common Errors.

Error	Description	HTTP Status Code
`DBParameterGroupNotFound`	DBParameterGroupName does not refer to an existing DB Parameter Group.	404
`InvalidDBParameterGroupState`	The DB Parameter Group cannot be deleted because it is in use.	400

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=ResetDBParameterGroup
    &DBParameterGroupName=mydbparametergroup
    &Parameters.member.1.ParameterName=max_user_connections
    &Parameters.member.1.ApplyMethod=pending-reboot
    &Parameters.member.2.ParameterName=max_allowed_packet
    &Parameters.member.2.ApplyMethod=immediate
    &ResetAllParameters=false
    &Version=2012-04-23
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<ResetDBParameterGroupResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <ResetDBParameterGroupResult>
    <DBParameterGroupName>mydbparametergroup</DBParameterGroupName>
  </ResetDBParameterGroupResult>
  <ResponseMetadata>
    <RequestId>071e758f-bf57-11de-9f9f-53d6aee22de9</RequestId>
  </ResponseMetadata>
</ResetDBParameterGroupResponse>