Skip to content
v2.277.0

ClusterParameterGroupProps Struct ​

Properties for a cluster parameter group.

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

  // the properties below are optional
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  description: 'description',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_docdb as docdb

cluster_parameter_group_props = docdb.ClusterParameterGroupProps(
    family="family",
    parameters={
        "parameters_key": "parameters"
    },

    # the properties below are optional
    db_cluster_parameter_group_name="dbClusterParameterGroupName",
    description="description"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.docdb.*;

ClusterParameterGroupProps clusterParameterGroupProps = ClusterParameterGroupProps.builder()
        .family("family")
        .parameters(Map.of(
                "parametersKey", "parameters"))

        // the properties below are optional
        .dbClusterParameterGroupName("dbClusterParameterGroupName")
        .description("description")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DocDB;

var clusterParameterGroupProps = new ClusterParameterGroupProps {
    Family = "family",
    Parameters = new Dictionary<string, string> {
        { "parametersKey", "parameters" }
    },

    // the properties below are optional
    DbClusterParameterGroupName = "dbClusterParameterGroupName",
    Description = "description"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

clusterParameterGroupProps := &ClusterParameterGroupProps{
	Family: jsii.String("family"),
	Parameters: map[string]*string{
		"parametersKey": jsii.String("parameters"),
	},

	// the properties below are optional
	DbClusterParameterGroupName: jsii.String("dbClusterParameterGroupName"),
	Description: jsii.String("description"),
}

Properties ​

dbClusterParameterGroupNameoptionalstringdb_cluster_parameter_group_nameoptionalstrdbClusterParameterGroupNameoptionalStringDbClusterParameterGroupNameoptionalstringDbClusterParameterGroupNameoptional*string #
The name of the cluster parameter group.

Default: A CDK generated name for the cluster parameter group

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
Description for this parameter group.

Default: a CDK generated description

familystringfamilystrfamilyStringFamilystringFamily*string required #
Database family of this parameter group.
parameters{ [key: string]: string }parameterstyping.Mapping[str, str]parametersMap<String, String>ParametersIDictionary<string, string>Parameters*map[string]*string required #
The parameters in this parameter group.