| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.RDS.ResetDBParameterGroup
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
RebootDBInstance request.
Synopsis
- data ResetDBParameterGroup = ResetDBParameterGroup' {}
- newResetDBParameterGroup :: Text -> ResetDBParameterGroup
- resetDBParameterGroup_parameters :: Lens' ResetDBParameterGroup (Maybe [Parameter])
- resetDBParameterGroup_resetAllParameters :: Lens' ResetDBParameterGroup (Maybe Bool)
- resetDBParameterGroup_dbParameterGroupName :: Lens' ResetDBParameterGroup Text
- data DBParameterGroupNameMessage = DBParameterGroupNameMessage' {}
- newDBParameterGroupNameMessage :: DBParameterGroupNameMessage
- dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text)
Creating a Request
data ResetDBParameterGroup Source #
See: newResetDBParameterGroup smart constructor.
Constructors
| ResetDBParameterGroup' | |
Fields
| |
Instances
newResetDBParameterGroup Source #
Arguments
| :: Text | |
| -> ResetDBParameterGroup |
Create a value of ResetDBParameterGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ResetDBParameterGroup, resetDBParameterGroup_parameters - 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.
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
$sel:resetAllParameters:ResetDBParameterGroup', resetDBParameterGroup_resetAllParameters - 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.
ResetDBParameterGroup, resetDBParameterGroup_dbParameterGroupName - The name of the DB parameter group.
Constraints:
- Must match the name of an existing
DBParameterGroup.
Request Lenses
resetDBParameterGroup_parameters :: Lens' ResetDBParameterGroup (Maybe [Parameter]) Source #
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.
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
resetDBParameterGroup_resetAllParameters :: Lens' ResetDBParameterGroup (Maybe Bool) Source #
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.
resetDBParameterGroup_dbParameterGroupName :: Lens' ResetDBParameterGroup Text Source #
The name of the DB parameter group.
Constraints:
- Must match the name of an existing
DBParameterGroup.
Destructuring the Response
data DBParameterGroupNameMessage Source #
Contains the result of a successful invocation of the
ModifyDBParameterGroup or ResetDBParameterGroup action.
See: newDBParameterGroupNameMessage smart constructor.
Constructors
| DBParameterGroupNameMessage' | |
Fields
| |
Instances
newDBParameterGroupNameMessage :: DBParameterGroupNameMessage Source #
Create a value of DBParameterGroupNameMessage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbParameterGroupName:DBParameterGroupNameMessage', dbParameterGroupNameMessage_dbParameterGroupName - The name of the DB parameter group.
Response Lenses
dbParameterGroupNameMessage_dbParameterGroupName :: Lens' DBParameterGroupNameMessage (Maybe Text) Source #
The name of the DB parameter group.