aws-cdk-lib.aws_docdb.CfnDBClusterParameterGroupProps

interface CfnDBClusterParameterGroupProps

LanguageType name
.NETAmazon.CDK.AWS.DocDB.CfnDBClusterParameterGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#CfnDBClusterParameterGroupProps
Javasoftware.amazon.awscdk.services.docdb.CfnDBClusterParameterGroupProps
Pythonaws_cdk.aws_docdb.CfnDBClusterParameterGroupProps
TypeScript aws-cdk-lib » aws_docdb » 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 { 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

NameTypeDescription
descriptionstringThe description for the cluster parameter group.
familystringThe cluster parameter group family name.
parametersanyProvides a list of parameters for the cluster parameter group.
name?stringThe name of the DB cluster parameter group.
tags?CfnTag[]The tags to be assigned to the cluster parameter group.

description

Type: string

The description for the cluster parameter group.


family

Type: string

The cluster parameter group family name.


parameters

Type: any

Provides a list of parameters for the cluster parameter group.


name?

Type: string (optional)

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.


tags?

Type: CfnTag[] (optional)

The tags to be assigned to the cluster parameter group.