Reset Db Parameter Group
rds_reset_db_parameter_group | R Documentation |
Modifies the parameters of a DB parameter group to the engine/system default value¶
Description¶
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
reboot_db_instance
request.
Usage¶
Arguments¶
DBParameterGroupName
[required] The name of the DB parameter group.
Constraints:
Must match the name of an existing
DBParameterGroup
.
ResetAllParameters
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.
Parameters
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
Value¶
A list with the following syntax:
Request syntax¶
svc$reset_db_parameter_group(
DBParameterGroupName = "string",
ResetAllParameters = TRUE|FALSE,
Parameters = list(
list(
ParameterName = "string",
ParameterValue = "string",
Description = "string",
Source = "string",
ApplyType = "string",
DataType = "string",
AllowedValues = "string",
IsModifiable = TRUE|FALSE,
MinimumEngineVersion = "string",
ApplyMethod = "immediate"|"pending-reboot",
SupportedEngineModes = list(
"string"
)
)
)
)