AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::RDS::DBClusterParameterGroup

CfnDBClusterParameterGroup

The `AWS::RDS::DBClusterParameterGroup` resource creates a new Amazon RDS DB cluster parameter group. For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide* . > If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. > > If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.

Import

import { CfnDBClusterParameterGroup } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.CfnDBClusterParameterGroup

Properties

Configuration passed to the constructor as CfnDBClusterParameterGroupProps.

descriptionRequired
string

The description for the DB cluster parameter group.

familyRequired
string

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: `aurora-mysql5.7` , `aurora-mysql8.0` *Aurora PostgreSQL* Example: `aurora-postgresql14` *RDS for MySQL* Example: `mysql8.0` *RDS for PostgreSQL* Example: `postgres13` 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` > The output contains duplicates. The following are the valid DB engine values: - `aurora-mysql` - `aurora-postgresql` - `mysql` - `postgres`

parametersRequired
any

Provides a list of parameters for the DB cluster parameter group.

dbClusterParameterGroupNameOptional
string

The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DB cluster parameter group. > This value is stored as a lowercase string.

tagsOptional
CfnTag[]

Tags to assign to the DB cluster parameter group.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::RDS::DBClusterParameterGroupView in CloudFormation Explorer

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-rds
CFN TypeAWS::RDS::DBClusterParameterGroup
Properties5

Related Constructs

Explore This Service

External Links