interface ParameterGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.RDS.ParameterGroupProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#ParameterGroupProps
Java	software.amazon.awscdk.services.rds.ParameterGroupProps
Python	aws_cdk.aws_rds.ParameterGroupProps
TypeScript (source)	aws-cdk-lib » aws_rds » ParameterGroupProps

Properties for a parameter group.

Example

const parameterGroup = rds.ParameterGroup.forInstance(this, 'InstanceParameterGroup', {
  engine: rds.DatabaseInstanceEngine.mysql({
    version: rds.MysqlEngineVersion.VER_8_0_35,
  }),
  description: 'Parameter group for MySQL',
  parameters: {
    max_connections: '150',
    slow_query_log: '1',
  },
});

Properties

Name	Type	Description
engine	IEngine	The database engine for this parameter group.
description?	string	Description for this parameter group.
name?	string	The name of this parameter group.
parameters?	{ [string]: string }	The parameters in this parameter group.
removalPolicy?	RemovalPolicy	The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

---

engine

Type: IEngine

The database engine for this parameter group.

---

description?

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

Description for this parameter group.

---

name?

Type: string (optional, default: CloudFormation-generated name)

The name of this parameter group.

---

parameters?

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

The parameters in this parameter group.

---

removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

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