RDS / Client / modify_db_parameter_group

modify_db_parameter_group

RDS.Client.modify_db_parameter_group(**kwargs)

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 action 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.

See also: AWS API Documentation

Request Syntax

response = client.modify_db_parameter_group(
    DBParameterGroupName='string',
    Parameters=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'ApplyType': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string',
            'ApplyMethod': 'immediate'|'pending-reboot',
            'SupportedEngineModes': [
                'string',
            ]
        },
    ]
)

Parameters:

• DBParameterGroupName (string) –

  [REQUIRED]

  The name of the DB parameter group.

  Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

• Parameters (list) –

  [REQUIRED]

  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.

  • (dict) –

    This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

    This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

    • ParameterName (string) –

      The name of the parameter.

    • ParameterValue (string) –

      The value of the parameter.

    • Description (string) –

      Provides a description of the parameter.

    • Source (string) –

      The source of the parameter value.

    • ApplyType (string) –

      Specifies the engine specific parameters type.

    • DataType (string) –

      Specifies the valid data type for the parameter.

    • AllowedValues (string) –

      Specifies the valid range of values for the parameter.

    • IsModifiable (boolean) –

      Indicates whether ( true) or not ( false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    • MinimumEngineVersion (string) –

      The earliest engine version to which the parameter can apply.

    • ApplyMethod (string) –

      Indicates when to apply parameter updates.

    • SupportedEngineModes (list) –

      The valid DB engine modes.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroupName': 'string'
}

Response Structure

• (dict) –

  Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

  • DBParameterGroupName (string) –

    The name of the DB parameter group.

Exceptions

• RDS.Client.exceptions.DBParameterGroupNotFoundFault

• RDS.Client.exceptions.InvalidDBParameterGroupStateFault

Examples

This example immediately changes the specified setting for the specified DB parameter group.

response = client.modify_db_parameter_group(
    DBParameterGroupName='mymysqlparametergroup',
    Parameters=[
        {
            'ApplyMethod': 'immediate',
            'ParameterName': 'time_zone',
            'ParameterValue': 'America/Phoenix',
        },
    ],
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}