Skip to content

Create Db Parameter Group

rds_create_db_parameter_group R Documentation

Creates a new DB parameter group

Description

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 modify_db_parameter_group. Once you've created a DB parameter group, you need to associate it with your DB instance using modify_db_instance. 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.

Usage

rds_create_db_parameter_group(DBParameterGroupName,
  DBParameterGroupFamily, Description, Tags)

Arguments

DBParameterGroupName

[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

This value is stored as a lowercase string.
DBParameterGroupFamily

[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⁠

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

[required] The description for the DB parameter group.
Tags

Tags to assign to the DB parameter group.

Value

A list with the following syntax:

list(
  DBParameterGroup = list(
    DBParameterGroupName = "string",
    DBParameterGroupFamily = "string",
    Description = "string",
    DBParameterGroupArn = "string"
  )
)

Request syntax

svc$create_db_parameter_group(
  DBParameterGroupName = "string",
  DBParameterGroupFamily = "string",
  Description = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples

## Not run: 
# This example creates a DB parameter group.
svc$create_db_parameter_group(
  DBParameterGroupFamily = "mysql5.6",
  DBParameterGroupName = "mymysqlparametergroup",
  Description = "My MySQL parameter group"
)

## End(Not run)