interface CfnDBClusterParameterGroupProps

Language	Type name
.NET	`Amazon.CDK.AWS.RDS.CfnDBClusterParameterGroupProps`
Java	`software.amazon.awscdk.services.rds.CfnDBClusterParameterGroupProps`
Python	`aws_cdk.aws_rds.CfnDBClusterParameterGroupProps`
TypeScript	`@aws-cdk/aws-rds` » `CfnDBClusterParameterGroupProps`

Properties for defining a CfnDBClusterParameterGroup.

Example

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

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

Name	Type	Description
description	`string`	A friendly description for this DB cluster parameter group.
family	`string`	The DB cluster parameter group family name.
parameters	`any`	Provides a list of parameters for the DB cluster parameter group.
dbClusterParameterGroupName?	`string`	The name of the DB cluster parameter group.
tags?	`CfnTag[]`	An optional array of key-value pairs to apply to this DB cluster parameter group.

description

Type: string

A friendly description for this DB cluster parameter group.

family

Type: 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 DB engine and engine version compatible with that DB cluster parameter group family.

The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.

To list all of the available parameter group families, use the following command:

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

The output contains duplicates.

For more information, see [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .

parameters

Type: any

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

dbClusterParameterGroupName?

Type: string (optional)

The name of the DB cluster parameter group.

Constraints:

Must not match the name of an existing DB cluster parameter group.

If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group.

This value is stored as a lowercase string.

tags?

Type: CfnTag[] (optional)

An optional array of key-value pairs to apply to this DB cluster parameter group.