ParameterGroupProps

class aws_cdk.aws_rds.ParameterGroupProps(*, engine, description=None, name=None, parameters=None, removal_policy=None)

Bases: object

Properties for a parameter group.

Parameters:
  • engine (IEngine) – The database engine for this parameter group.

  • description (Optional[str]) – Description for this parameter group. Default: a CDK generated description

  • name (Optional[str]) – The name of this parameter group. Default: - CloudFormation-generated name

  • parameters (Optional[Mapping[str, str]]) – The parameters in this parameter group. Default: - None

  • removal_policy (Optional[RemovalPolicy]) – The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. Default: - RemovalPolicy.DESTROY

ExampleMetadata:

infused

Example:

parameter_group = rds.ParameterGroup.for_instance(self, "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"
    }
)

Attributes

description

Description for this parameter group.

Default:

a CDK generated description

engine

The database engine for this parameter group.

name

The name of this parameter group.

Default:
  • CloudFormation-generated name

parameters

The parameters in this parameter group.

Default:
  • None

removal_policy

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

Default:
  • RemovalPolicy.DESTROY