modify_db_cluster_parameter_group¶
Operation¶
async
¶
modify_db_cluster_parameter_group(input: ModifyDBClusterParameterGroupInput, plugins: list[Plugin] | None = None) -> ModifyDBClusterParameterGroupOutput
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.
Warning
There are two types of parameters - dynamic parameters and static
parameters. Changes to dynamic parameters are applied to the DB cluster
immediately without a reboot. Changes to static parameters are applied
only after the DB cluster is rebooted, which can be done using
RebootDBCluster operation. You can use the Parameter Groups option
of the Amazon RDS console or the
DescribeDBClusterParameters operation to verify that your DB cluster
parameter group has been created or modified.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyDBClusterParameterGroupInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyDBClusterParameterGroupOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_cluster_parameter_group_name: str | None = ...
The name of the DB cluster parameter group to modify.
class-attribute
instance-attribute
¶
parameters: list[Parameter] | None = ...
A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
Note
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_cluster_parameter_group_name: str | None = ...
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
Note
This value is stored as a lowercase string.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.