RDS / Client / create_db_cluster_parameter_group

create_db_cluster_parameter_group#

RDS.Client.create_db_cluster_parameter_group(**kwargs)#

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you’ve created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.

When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

Warning

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 DB cluster 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 operation to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, 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.

See also: AWS API Documentation

Request Syntax

response = client.create_db_cluster_parameter_group(
    DBClusterParameterGroupName='string',
    DBParameterGroupFamily='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

DBClusterParameterGroupName (string) –
[REQUIRED]

The name of the DB cluster parameter group.

Constraints:
- Must not match the name of an existing DB cluster parameter group.
Note

This value is stored as a lowercase string.
DBParameterGroupFamily (string) –
[REQUIRED]

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

Aurora MySQL

Example: aurora5.6, aurora-mysql5.7, aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql9.6

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres12

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 Aurora PostgreSQL DB engine, use the following command:

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

Note

The output contains duplicates.

The following are the valid DB engine values:
- aurora (for MySQL 5.6-compatible Aurora)
- aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
- aurora-postgresql
- mysql
- postgres
Description (string) –
[REQUIRED]

The description for the DB cluster parameter group.
Tags (list) –
Tags to assign to the DB cluster 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.
  - 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

{
    'DBClusterParameterGroup': {
        'DBClusterParameterGroupName': 'string',
        'DBParameterGroupFamily': 'string',
        'Description': 'string',
        'DBClusterParameterGroupArn': 'string'
    }
}

Response Structure

(dict) –
- DBClusterParameterGroup (dict) –
  
  Contains the details of an Amazon RDS DB cluster parameter group.
  
  This data type is used as a response element in the DescribeDBClusterParameterGroups action.
  - DBClusterParameterGroupName (string) –
    
    The name of the DB cluster parameter group.
  - DBParameterGroupFamily (string) –
    
    The name of the DB parameter group family that this DB cluster parameter group is compatible with.
  - Description (string) –
    
    Provides the customer-specified description for this DB cluster parameter group.
  - DBClusterParameterGroupArn (string) –
    
    The Amazon Resource Name (ARN) for the DB cluster parameter group.

Exceptions

RDS.Client.exceptions.DBParameterGroupQuotaExceededFault
RDS.Client.exceptions.DBParameterGroupAlreadyExistsFault

Examples

This example creates a DB cluster parameter group.

response = client.create_db_cluster_parameter_group(
    DBClusterParameterGroupName='mydbclusterparametergroup',
    DBParameterGroupFamily='aurora5.6',
    Description='My DB cluster parameter group',
)

print(response)

Expected Output:

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