- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ResetDBParameterGroupCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { RDSClient, ResetDBParameterGroupCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, ResetDBParameterGroupCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // ResetDBParameterGroupMessage
DBParameterGroupName: "STRING_VALUE", // required
ResetAllParameters: true || false,
Parameters: [ // ParametersList
{ // Parameter
ParameterName: "STRING_VALUE",
ParameterValue: "STRING_VALUE",
Description: "STRING_VALUE",
Source: "STRING_VALUE",
ApplyType: "STRING_VALUE",
DataType: "STRING_VALUE",
AllowedValues: "STRING_VALUE",
IsModifiable: true || false,
MinimumEngineVersion: "STRING_VALUE",
ApplyMethod: "immediate" || "pending-reboot",
SupportedEngineModes: [ // EngineModeList
"STRING_VALUE",
],
},
],
};
const command = new ResetDBParameterGroupCommand(input);
const response = await client.send(command);
// { // DBParameterGroupNameMessage
// DBParameterGroupName: "STRING_VALUE",
// };
Example Usage
ResetDBParameterGroupCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DBParameterGroupName Required | string | undefined | The name of the DB parameter group. Constraints:
|
Parameters | Parameter[] | undefined | To reset the entire DB parameter group, specify the MySQL Valid Values (for Apply method): You can use the immediate value with dynamic parameters only. You can use the MariaDB Valid Values (for Apply method): You can use the immediate value with dynamic parameters only. You can use the Oracle Valid Values (for Apply method): |
ResetAllParameters | boolean | undefined | 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. |
ResetDBParameterGroupCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DBParameterGroupName | string | undefined | The name of the DB parameter group. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
DBParameterGroupNotFoundFault | client | |
InvalidDBParameterGroupStateFault | client | The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state. |
RDSServiceException | Base exception class for all service exceptions from RDS service. |