Package software.amazon.awscdk.services.rds

Interface IParameterGroup

All Superinterfaces:

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

All Known Subinterfaces:

IParameterGroup.Jsii$Default

All Known Implementing Classes:

IParameterGroup.Jsii$Proxy, ParameterGroup

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.201Z")
@Stability(Stable)
public interface IParameterGroup
extends software.amazon.jsii.JsiiSerializable, IResource

A parameter group.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Boolean	addParameter(String key, 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.IConstruct

getNode

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

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

addParameter

@Stability(Stable)
@NotNull
Boolean addParameter(@NotNull
 String key,
 @NotNull
 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

@Stability(Stable)
@NotNull
ParameterGroupClusterConfig bindToCluster(@NotNull
 ParameterGroupClusterBindOptions options)

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

Parameters:

options - This parameter is required.

bindToInstance

@Stability(Stable)
@NotNull
ParameterGroupInstanceConfig bindToInstance(@NotNull
 ParameterGroupInstanceBindOptions options)

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

Parameters:

options - This parameter is required.