ResetDBClusterParameterGroup
Modifies the parameters of a DB cluster parameter group to the default value. To reset
specific parameters submit a list of the following: ParameterName
and
ApplyMethod
. To reset the entire DB cluster parameter group, specify the
DBClusterParameterGroupName
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. You must call RebootDBInstance for every DB instance in your DB cluster
that you want the updated static parameter to apply to.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group to reset.
Type: String
Required: Yes
- Parameters.Parameter.N
-
A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the
ResetAllParameters
parameter is set totrue
.Type: Array of Parameter objects
Required: No
- ResetAllParameters
-
A value that is set to
true
to reset all parameters in the DB cluster parameter group to their default values, andfalse
otherwise. You can't use this parameter if there is a list of parameter names specified for theParameters
parameter.Type: Boolean
Required: No
Response Elements
The following element is returned by the service.
- DBClusterParameterGroupName
-
The name of the DB cluster parameter group.
Constraints:
-
Must be 1 to 255 letters or numbers.
-
First character must be a letter
-
Cannot end with a hyphen or contain two consecutive hyphens
Note
This value is stored as a lowercase string.
Type: String
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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: