Amazon Neptune
User Guide (API Version 2017-11-29)

ResetDBParameterGroup

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBParameterGroupName

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

Type: String

Required: Yes

Parameters.Parameter.N

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

Type: Array of Parameter objects

Required: No

ResetAllParameters

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

Default: true

Type: Boolean

Required: No

Response Elements

The following element is returned by the service.

DBParameterGroupName

Provides the name of the DB parameter group.

Type: String

Errors

For information about the errors that are common to all actions, see Cluster Management Error Messages and Codes.

DBParameterGroupNotFound

DBParameterGroupName does not refer to an existing DB parameter group.

HTTP Status Code: 404

InvalidDBParameterGroupState

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: