modify_db_parameter_group¶
Operation¶
async
¶
modify_db_parameter_group(input: ModifyDBParameterGroupInput, plugins: list[Plugin] | None = None) -> ModifyDBParameterGroupOutput
Modifies the parameters of a DB 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
After you modify a DB parameter group, you should wait at least 5
minutes before creating your first DB instance that uses that DB
parameter group as the default parameter group. This allows Amazon RDS
to fully complete the modify operation before the parameter group is
used as the default for a new DB instance. This is especially important
for parameters that are critical when creating the default database for
a DB instance, 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
DescribeDBParameters command to verify that your DB parameter group
has been created or modified.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyDBParameterGroupInput
|
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 |
|---|---|
ModifyDBParameterGroupOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
db_parameter_group_name: str | None = ...
The name of the DB parameter group.
Constraints:
- If supplied, must match the name of an existing
DBParameterGroup.
class-attribute
instance-attribute
¶
parameters: list[Parameter] | None = ...
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
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 instances 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
instances associated with the parameter group.
Note
You can't use pending-reboot with dynamic parameters on RDS for SQL
Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide.
Output¶
dataclass
¶
Bases: _SerdeShape
Contains the result of a successful invocation of the
ModifyDBParameterGroup or ResetDBParameterGroup operation.
Attributes¶
class-attribute
instance-attribute
¶
db_parameter_group_name: str | None = ...
The name of the DB parameter group.
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.