AWS CDK Reference

Appearance

v2.274.0

ParameterGroupProps Struct ​

Properties for a parameter group.

Source
aws-rds/lib/parameter-group.ts
Type last changed
v2.141.0 · 8 May 2024

Example ​

ts
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 ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
Description for this parameter group.

Default: a CDK generated description

engineIEngineengineIEngineengineIEngineEngineIEngineEngineIEnginerequired#
The database engine for this parameter group.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of this parameter group.

Default: CloudFormation-generated name

parametersoptional{ [key: string]: string }parametersoptionaltyping.Mapping[str, str]parametersoptionalMap<String, String>ParametersoptionalIDictionary<string, string>Parametersoptional*map[string]*string= None#
The parameters in this parameter group.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#
The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.