class ParameterGroup (construct)

Language	Type name
.NET	Amazon.CDK.AWS.RDS.ParameterGroup
Java	software.amazon.awscdk.services.rds.ParameterGroup
Python	aws_cdk.aws_rds.ParameterGroup
TypeScript (source)	@aws-cdk/aws-rds » ParameterGroup

Implements IConstruct, IConstruct, IDependable, IResource, IParameterGroup

A parameter group.

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

Example

declare const vpc: ec2.Vpc;

const cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {
  engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,
  parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql10'),
  vpc,
  scaling: {
    autoPause: Duration.minutes(10), // default is to pause after 5 minutes of idle time
    minCapacity: rds.AuroraCapacityUnit.ACU_8, // default is 2 Aurora capacity units (ACUs)
    maxCapacity: rds.AuroraCapacityUnit.ACU_32, // default is 16 Aurora capacity units (ACUs)
  }
});

Initializer

new ParameterGroup(scope: Construct, id: string, props: ParameterGroupProps)

Parameters

• scope Construct
• id string
• props ParameterGroupProps

Construct Props

Name	Type	Description
engine	IEngine	The database engine for this parameter group.
description?	string	Description for this parameter group.
parameters?	{ [string]: string }	The parameters in this parameter group.

---

engine

Type: IEngine

The database engine for this parameter group.

---

description?

Type: string (optional, default: a CDK generated description)

Description for this parameter group.

---

parameters?

Type: { [string]: string } (optional, default: None)

The parameters in this parameter group.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The 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: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addParameter(key, value)	Add a parameter to this parameter 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.
toString()	Returns a string representation of this construct.
static fromParameterGroupName(scope, id, parameterGroupName)	Imports a parameter group.

---

addParameter(key, value)

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

Parameters

• key string — The key of the parameter to be added.
• value string — The value of the parameter to be added.

Returns

• boolean

Add a parameter to this parameter group.

---

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.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromParameterGroupName(scope, id, parameterGroupName)

public static fromParameterGroupName(scope: Construct, id: string, parameterGroupName: string): IParameterGroup

Parameters

• scope Construct
• id string
• parameterGroupName string

Returns

• IParameterGroup

Imports a parameter group.