AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ParameterGroup

A parameter group. Represents both a cluster parameter group (AWS::RDS::DBClusterParameterGroup), and an instance parameter group (AWS::RDS::DBParameterGroup).

Import

import { ParameterGroup } from 'aws-cdk-lib/aws-rds';

Or use the module namespace:

import * as rds from 'aws-cdk-lib/aws-rds';
// rds.ParameterGroup

Properties

Configuration passed to the constructor as ParameterGroupProps.

engineRequired
IEngine

The database engine for this parameter group.

descriptionOptional
string

Description for this parameter group.

Default: a CDK generated description

nameOptional
string

The name of this parameter group.

Default: - CloudFormation-generated name

parametersOptional
{ [key: string]: string }

The parameters in this parameter group.

Default: - None

removalPolicyOptional
RemovalPolicy

The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Default: - RemovalPolicy.DESTROY

Get the Amazon RDS Cheat Sheet

Everything you need to know about Amazon RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)
Moduleaws-rds
Properties5

Related Constructs

Explore This Service

External Links