| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.RDS.ModifyDBClusterParameterGroup
Description
Modifies the parameters of a DB cluster parameter group. To modify more
than one parameter, submit a list of the following: ParameterName,
ParameterValue, and ApplyMethod. A maximum of 20 parameters can be
modified in a single request.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
After you create a DB cluster parameter group, you should wait at least
5 minutes before creating your first DB cluster that uses that DB
cluster parameter group as the default parameter group. This allows
Amazon RDS to fully complete the create action before the parameter
group is used as the default for a new DB cluster. This is especially
important for parameters that are critical when creating the default
database for a DB cluster, such as the character set for the default
database defined by the character_set_database parameter. You can use
the Parameter Groups option of the
Amazon RDS console or the
DescribeDBClusterParameters action to verify that your DB cluster
parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
This action only applies to Aurora DB clusters.
Synopsis
- data ModifyDBClusterParameterGroup = ModifyDBClusterParameterGroup' {}
- newModifyDBClusterParameterGroup :: Text -> ModifyDBClusterParameterGroup
- modifyDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ModifyDBClusterParameterGroup Text
- modifyDBClusterParameterGroup_parameters :: Lens' ModifyDBClusterParameterGroup [Parameter]
- data DBClusterParameterGroupNameMessage = DBClusterParameterGroupNameMessage' {}
- newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage
- dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text)
Creating a Request
data ModifyDBClusterParameterGroup Source #
See: newModifyDBClusterParameterGroup smart constructor.
Constructors
| ModifyDBClusterParameterGroup' | |
Fields
| |
Instances
newModifyDBClusterParameterGroup Source #
Arguments
| :: Text |
|
| -> ModifyDBClusterParameterGroup |
Create a value of ModifyDBClusterParameterGroup 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:dbClusterParameterGroupName:ModifyDBClusterParameterGroup', modifyDBClusterParameterGroup_dbClusterParameterGroupName - The name of the DB cluster parameter group to modify.
$sel:parameters:ModifyDBClusterParameterGroup', modifyDBClusterParameterGroup_parameters - A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application 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.
When the application method is immediate, changes to dynamic
parameters are applied immediately to the DB clusters associated with
the parameter group. When the application method is pending-reboot,
changes to dynamic and static parameters are applied after a reboot
without failover to the DB clusters associated with the parameter group.
Request Lenses
modifyDBClusterParameterGroup_dbClusterParameterGroupName :: Lens' ModifyDBClusterParameterGroup Text Source #
The name of the DB cluster parameter group to modify.
modifyDBClusterParameterGroup_parameters :: Lens' ModifyDBClusterParameterGroup [Parameter] Source #
A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application 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.
When the application method is immediate, changes to dynamic
parameters are applied immediately to the DB clusters associated with
the parameter group. When the application method is pending-reboot,
changes to dynamic and static parameters are applied after a reboot
without failover to the DB clusters associated with the parameter group.
Destructuring the Response
data DBClusterParameterGroupNameMessage Source #
See: newDBClusterParameterGroupNameMessage smart constructor.
Constructors
| DBClusterParameterGroupNameMessage' | |
Fields
| |
Instances
newDBClusterParameterGroupNameMessage :: DBClusterParameterGroupNameMessage Source #
Create a value of DBClusterParameterGroupNameMessage 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:dbClusterParameterGroupName:DBClusterParameterGroupNameMessage', dbClusterParameterGroupNameMessage_dbClusterParameterGroupName - The name of the DB cluster parameter group.
Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.
Response Lenses
dbClusterParameterGroupNameMessage_dbClusterParameterGroupName :: Lens' DBClusterParameterGroupNameMessage (Maybe Text) Source #
The name of the DB cluster parameter group.
Constraints:
- Must be 1 to 255 letters or numbers.
- First character must be a letter
- Can't end with a hyphen or contain two consecutive hyphens
This value is stored as a lowercase string.