software.amazon.awscdk.services.rds

Interface IParameterGroup

All Superinterfaces:

IConstruct, IDependable, IResource

All Known Subinterfaces:

IParameterGroup.Jsii$Default

All Known Implementing Classes:

IParameterGroup.Jsii$Proxy, ParameterGroup

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.272Z")
public interface IParameterGroup
extends IResource

A parameter group.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IParameterGroup.Jsii$Default Internal default implementation for IParameterGroup.
static class	IParameterGroup.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	addParameter(java.lang.String key, java.lang.String value) Adds a parameter to this 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.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Method Detail

addParameter

java.lang.Boolean addParameter(java.lang.String key,
                               java.lang.String value)

Adds a parameter to this group.

If this is an imported parameter group, this method does nothing.

Parameters:

key - This parameter is required.

value - This parameter is required.

Returns:

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

bindToCluster

ParameterGroupClusterConfig bindToCluster(ParameterGroupClusterBindOptions options)

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

Parameters:

options - This parameter is required.

bindToInstance

ParameterGroupInstanceConfig bindToInstance(ParameterGroupInstanceBindOptions options)

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

Parameters:

options - This parameter is required.