RDS / Client / create_db_parameter_group

create_db_parameter_group#

RDS.Client.create_db_parameter_group(**kwargs)#

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you’ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

This command doesn’t apply to RDS Custom.

Warning

After you create 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 create 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.create_db_parameter_group(
    DBParameterGroupName='string',
    DBParameterGroupFamily='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DBParameterGroupName (string) –

    [REQUIRED]

    The name of the DB parameter group.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

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

  • DBParameterGroupFamily (string) –

    [REQUIRED]

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    To list all of the available parameter group families for a DB engine, use the following command:

    aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>

    For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

    aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql

    Note

    The output contains duplicates.

    The following are the valid DB engine values:

    • aurora-mysql

    • aurora-postgresql

    • db2-ae

    • db2-se

    • mysql

    • oracle-ee

    • oracle-ee-cdb

    • oracle-se2

    • oracle-se2-cdb

    • postgres

    • sqlserver-ee

    • sqlserver-se

    • sqlserver-ex

    • sqlserver-web

  • Description (string) –

    [REQUIRED]

    The description for the DB parameter group.

  • Tags (list) –

    Tags to assign to the DB parameter group.

    • (dict) –

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

      • Key (string) –

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

      • Value (string) –

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'DBParameterGroup': {
        'DBParameterGroupName': 'string',
        'DBParameterGroupFamily': 'string',
        'Description': 'string',
        'DBParameterGroupArn': 'string'
    }
}

Response Structure

  • (dict) –

    • DBParameterGroup (dict) –

      Contains the details of an Amazon RDS DB parameter group.

      This data type is used as a response element in the DescribeDBParameterGroups action.

      • DBParameterGroupName (string) –

        The name of the DB parameter group.

      • DBParameterGroupFamily (string) –

        The name of the DB parameter group family that this DB parameter group is compatible with.

      • Description (string) –

        Provides the customer-specified description for this DB parameter group.

      • DBParameterGroupArn (string) –

        The Amazon Resource Name (ARN) for the DB parameter group.

Exceptions

Examples

This example creates a DB parameter group.

response = client.create_db_parameter_group(
    DBParameterGroupFamily='mysql5.6',
    DBParameterGroupName='mymysqlparametergroup',
    Description='My MySQL parameter group',
)

print(response)

Expected Output:

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