AWS CDK Reference

Appearance

v2.273.0

CfnDBClusterParameterGroupProps Struct ​

Properties for defining a CfnDBClusterParameterGroup.

Source
Generated code
Type last changed
v2.51.0 · 18 Nov 2022

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';

declare const parameters: any;
const cfnDBClusterParameterGroupProps: rds.CfnDBClusterParameterGroupProps = {
  description: 'description',
  family: 'family',
  parameters: parameters,

  // the properties below are optional
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

dbClusterParameterGroupNamestringdb_cluster_parameter_group_namestrdbClusterParameterGroupNameStringDbClusterParameterGroupNamestringDbClusterParameterGroupName*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.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*stringrequired#
The description for the DB cluster parameter group.
familystringfamilystrfamilyStringFamilystringFamily*stringrequired#
The DB cluster parameter group family name.
notes

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
parametersanyparametersAnyparametersObjectParametersobjectParametersinterface{}required#
Provides a list of parameters for the DB cluster parameter group.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Tags to assign to the DB cluster parameter group.

Used as props by ​