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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
reset-db-parameter-group
--db-parameter-group-name <value>
[--reset-all-parameters | --no-reset-all-parameters]
[--parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-parameter-group-name
(string)
The name of the DB parameter group.
Constraints:
Must match the name of an existing
DBParameterGroup
.
--reset-all-parameters
| --no-reset-all-parameters
(boolean)
A value that indicates 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
(structure)
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)
Specifies the name of the parameter.
ParameterValue -> (string)
Specifies the value of the parameter.
Description -> (string)
Provides a description of the parameter.
Source -> (string)
Indicates 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)
Shorthand Syntax:
ParameterName=string,ParameterValue=string,Description=string,Source=string,ApplyType=string,DataType=string,AllowedValues=string,IsModifiable=boolean,MinimumEngineVersion=string,ApplyMethod=string,SupportedEngineModes=string,string ...
JSON Syntax:
[
{
"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", ...]
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.