Package software.amazon.awscdk.services.rds

Class ParameterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.rds.ParameterGroup

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:32.339Z")
@Stability(Stable)
public class ParameterGroup
extends Resource
implements IParameterGroup

A parameter group.

Represents both a cluster parameter group, and an instance parameter group.

Example:

 BackupPlan plan;
 Vpc vpc;
 ITable myTable = Table.fromTableName(this, "Table", "myTableName");
 DatabaseInstance myDatabaseInstance = DatabaseInstance.Builder.create(this, "DatabaseInstance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_26).build()))
         .vpc(vpc)
         .build();
 DatabaseCluster myDatabaseCluster = DatabaseCluster.Builder.create(this, "DatabaseCluster")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_2_08_1).build()))
         .credentials(Credentials.fromGeneratedSecret("clusteradmin"))
         .instanceProps(InstanceProps.builder()
                 .vpc(vpc)
                 .build())
         .build();
 ServerlessCluster myServerlessCluster = ServerlessCluster.Builder.create(this, "ServerlessCluster")
         .engine(DatabaseClusterEngine.AURORA_POSTGRESQL)
         .parameterGroup(ParameterGroup.fromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql11"))
         .vpc(vpc)
         .build();
 Construct myCoolConstruct = new Construct(this, "MyCoolConstruct");
 plan.addSelection("Selection", BackupSelectionOptions.builder()
         .resources(List.of(BackupResource.fromDynamoDbTable(myTable), BackupResource.fromRdsDatabaseInstance(myDatabaseInstance), BackupResource.fromRdsDatabaseCluster(myDatabaseCluster), BackupResource.fromRdsServerlessCluster(myServerlessCluster), BackupResource.fromTag("stage", "prod"), BackupResource.fromConstruct(myCoolConstruct)))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ParameterGroup.Builder	A fluent builder for ParameterGroup.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.rds.IParameterGroup

IParameterGroup.Jsii$Default, IParameterGroup.Jsii$Proxy

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

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Boolean	addParameter(String key, String value)	Add a parameter to this parameter group.
ParameterGroupClusterConfig	bindToCluster(ParameterGroupClusterBindOptions _options)	Method called when this Parameter Group is used when defining a database cluster.
ParameterGroupInstanceConfig	bindToInstance(ParameterGroupInstanceBindOptions _options)	Method called when this Parameter Group is used when defining a database instance.
static IParameterGroup	fromParameterGroupName(software.constructs.Construct scope, String id, String parameterGroupName)	Imports a 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.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ParameterGroup

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

ParameterGroup

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

ParameterGroup

@Stability(Stable)
public ParameterGroup(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ParameterGroupProps 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 IParameterGroup 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.

addParameter

@Stability(Stable)
@NotNull
public Boolean addParameter(@NotNull
 String key,
 @NotNull
 String value)

Add a parameter to this parameter group.

Specified by:

addParameter in interface IParameterGroup

Parameters:

key - The key of the parameter to be added. This parameter is required.

value - The value of the parameter to be added. This parameter is required.

Returns:

true if the parameter was actually added (i.e., this ParameterGroup is not imported), false otherwise

bindToCluster

@Stability(Stable)
@NotNull
public ParameterGroupClusterConfig bindToCluster(@NotNull
 ParameterGroupClusterBindOptions _options)

Method called when this Parameter Group is used when defining a database cluster.

Specified by:

bindToCluster in interface IParameterGroup

Parameters:

_options - This parameter is required.

bindToInstance

@Stability(Stable)
@NotNull
public ParameterGroupInstanceConfig bindToInstance(@NotNull
 ParameterGroupInstanceBindOptions _options)

Method called when this Parameter Group is used when defining a database instance.

Specified by:

bindToInstance in interface IParameterGroup

Parameters:

_options - This parameter is required.