software.amazon.awscdk.services.rds

Interface IParameterGroup

All Superinterfaces:

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.24.0 (build b722f66)",
           date="2021-03-11T13:46:51.586Z")
 @Stability(value=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 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
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.IResource

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

addParameter

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