Package software.amazon.awscdk.services.docdb

Class ClusterParameterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.docdb.ClusterParameterGroup

All Implemented Interfaces:

IEnvironmentAware, IResource, IClusterParameterGroup, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:38.473Z")
@Stability(Stable)
public class ClusterParameterGroup
extends Resource
implements IClusterParameterGroup

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.*;
 ClusterParameterGroup clusterParameterGroup = ClusterParameterGroup.Builder.create(this, "MyClusterParameterGroup")
         .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	Class	Description
static final class	ClusterParameterGroup.Builder	A fluent builder for ClusterParameterGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.docdb.IClusterParameterGroup

IClusterParameterGroup.Jsii$Default, IClusterParameterGroup.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)
	ClusterParameterGroup(software.constructs.Construct scope, String id, ClusterParameterGroupProps props)

Method Summary

Modifier and Type	Method	Description
static IClusterParameterGroup	fromParameterGroupName(software.constructs.Construct scope, String id, String parameterGroupName)	Imports a parameter group.
String	getParameterGroupName()	The name of the parameter group.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

ClusterParameterGroup

protected ClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

ClusterParameterGroup

protected ClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ClusterParameterGroup

@Stability(Stable)
public ClusterParameterGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ClusterParameterGroupProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromParameterGroupName

@Stability(Stable)
@NotNull
public static IClusterParameterGroup fromParameterGroupName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String parameterGroupName)

Imports a parameter group.

Parameters:

scope - This parameter is required.

id - This parameter is required.

parameterGroupName - This parameter is required.

getParameterGroupName

@Stability(Stable)
@NotNull
public String getParameterGroupName()

The name of the parameter group.

Specified by:

getParameterGroupName in interface IClusterParameterGroup