interface ClusterParameterGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.DocDB.ClusterParameterGroupProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdocdb#ClusterParameterGroupProps
Java	software.amazon.awscdk.services.docdb.ClusterParameterGroupProps
Python	aws_cdk.aws_docdb.ClusterParameterGroupProps
TypeScript (source)	aws-cdk-lib » aws_docdb » ClusterParameterGroupProps

Properties for a cluster parameter group.

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';
const clusterParameterGroupProps: docdb.ClusterParameterGroupProps = {
  family: 'family',
  parameters: {
    parametersKey: 'parameters',
  },

  // the properties below are optional
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  description: 'description',
};

Properties

Name	Type	Description
family	string	Database family of this parameter group.
parameters	{ [string]: string }	The parameters in this parameter group.
dbClusterParameterGroupName?	string	The name of the cluster parameter group.
description?	string	Description for this parameter group.

---

family

Type: string

Database family of this parameter group.

---

parameters

Type: { [string]: string }

The parameters in this parameter group.

---

dbClusterParameterGroupName?

Type: string (optional, default: A CDK generated name for the cluster parameter group)

The name of the cluster parameter group.

---

description?

Type: string (optional, default: a CDK generated description)

Description for this parameter group.