software.amazon.awscdk.services.rds

Interface IParameterGroup.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IParameterGroup, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IParameterGroup.Jsii$Proxy

Enclosing interface:

IParameterGroup

@Internal
public static interface IParameterGroup.Jsii$Default
extends IParameterGroup, IResource.Jsii$Default

Internal default implementation for IParameterGroup.

Nested Class Summary

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

IParameterGroup.Jsii$Default, IParameterGroup.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default Boolean	addParameter(String key, String value) Adds a parameter to this group.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default ParameterGroupClusterConfig	bindToCluster(ParameterGroupClusterBindOptions options) Method called when this Parameter Group is used when defining a database cluster.
default ParameterGroupInstanceConfig	bindToInstance(ParameterGroupInstanceBindOptions options) Method called when this Parameter Group is used when defining a database instance.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addParameter

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

addParameter in interface IParameterGroup

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
default 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(value=Stable)
 @NotNull
default 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.