Skip to content

RDS  >  Operations  >  create_db_parameter_group

create_db_parameter_group

Operation

create_db_parameter_group async 

create_db_parameter_group(input: CreateDBParameterGroupInput, plugins: list[Plugin] | None = None) -> CreateDBParameterGroupOutput

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.

Parameters:

Name Type Description Default
input CreateDBParameterGroupInput

An instance of CreateDBParameterGroupInput.

 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
CreateDBParameterGroupOutput

An instance of CreateDBParameterGroupOutput.

Input

CreateDBParameterGroupInput dataclass

Bases: _SerdeShape

Attributes

db_parameter_group_family class-attribute instance-attribute 
db_parameter_group_family: str | None = ...

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-ce

  • db2-se

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

db_parameter_group_name class-attribute instance-attribute 
db_parameter_group_name: str | None = ...

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.

description class-attribute instance-attribute 
description: str | None = ...

The description for the DB parameter group.

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

Tags to assign to the DB parameter group.

Output

CreateDBParameterGroupOutput dataclass

Bases: _SerdeShape

Dataclass for CreateDBParameterGroupOutput structure.

Attributes

db_parameter_group class-attribute instance-attribute 
db_parameter_group: DBParameterGroup | None = ...

Contains the details of an Amazon RDS DB parameter group.

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

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

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.