aws-cdk-lib.aws_rds.IParameterGroup

interface IParameterGroup

LanguageType name
.NETAmazon.CDK.AWS.RDS.IParameterGroup
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsrds#IParameterGroup
Javasoftware.amazon.awscdk.services.rds.IParameterGroup
Pythonaws_cdk.aws_rds.IParameterGroup
TypeScript (source)aws-cdk-lib » aws_rds » IParameterGroup

Implemented by ParameterGroup

Obtainable from ParameterGroup.fromParameterGroupName()

A parameter group.

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

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

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.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
addParameter(key, value)Adds a parameter to this group.
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
bindToCluster(options)Method called when this Parameter Group is used when defining a database cluster.
bindToInstance(options)Method called when this Parameter Group is used when defining a database instance.

addParameter(key, value)

public addParameter(key: string, value: string): boolean

Parameters

  • key string
  • value string

Returns

  • boolean

Adds a parameter to this group.

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


applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


bindToCluster(options)

public bindToCluster(options: ParameterGroupClusterBindOptions): ParameterGroupClusterConfig

Parameters

  • options ParameterGroupClusterBindOptions

Returns

  • ParameterGroupClusterConfig

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


bindToInstance(options)

public bindToInstance(options: ParameterGroupInstanceBindOptions): ParameterGroupInstanceConfig

Parameters

  • options ParameterGroupInstanceBindOptions

Returns

  • ParameterGroupInstanceConfig

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