Package software.amazon.awscdk.services.docdb

Interface ClusterParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ClusterParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:08.858Z")
@Stability(Stable)
public interface ClusterParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

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 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClusterParameterGroupProps.Builder	A builder for ClusterParameterGroupProps
static final class	ClusterParameterGroupProps.Jsii$Proxy	An implementation for ClusterParameterGroupProps

Method Summary

Modifier and Type	Method	Description
static ClusterParameterGroupProps.Builder	builder()
default String	getDbClusterParameterGroupName()	The name of the cluster parameter group.
default String	getDescription()	Description for this parameter group.
String	getFamily()	Database family of this parameter group.
Map<String,String>	getParameters()	The parameters in this parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFamily

@Stability(Stable)
@NotNull
String getFamily()

Database family of this parameter group.

getParameters

@Stability(Stable)
@NotNull
Map<String,String> getParameters()

The parameters in this parameter group.

getDbClusterParameterGroupName

@Stability(Stable)
@Nullable
default String getDbClusterParameterGroupName()

The name of the cluster parameter group.

Default: A CDK generated name for the cluster parameter group

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Description for this parameter group.

Default: a CDK generated description

builder

@Stability(Stable)
static ClusterParameterGroupProps.Builder builder()

Returns:

a ClusterParameterGroupProps.Builder of ClusterParameterGroupProps