AWS CDK Reference

Appearance

v2.275.0

CfnDBClusterParameterGroupProps Struct ​

Properties for defining a CfnDBClusterParameterGroup.

Source
Generated code

Example ​

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

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

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

Properties ​

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

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup .

This value is stored as a lowercase string.

parametersanyparametersAnyparametersObjectParametersobjectParametersinterface{}required#
Provides a list of parameters for the cluster parameter group.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to be assigned to the cluster parameter group.