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:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.019Z")
 @Stability(value=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 and Description
static 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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ClusterParameterGroup

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

ClusterParameterGroup

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

ClusterParameterGroup

@Stability(value=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 Detail

fromParameterGroupName

@Stability(value=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(value=Stable)
 @NotNull
public String getParameterGroupName()

The name of the parameter group.

Specified by:

getParameterGroupName in interface IClusterParameterGroup