ParameterGroup

class aws_cdk.aws_rds.ParameterGroup(scope, id, *, engine, description=None, parameters=None)

Bases: aws_cdk.core.Resource

A parameter group.

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

Resource

AWS::RDS::DBParameterGroup

Parameters

  • scope (Construct) –

  • id (str) –

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

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

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

Methods

add_parameter(key, value)

Add a parameter to this parameter group.

Parameters

  • key (str) – The key of the parameter to be added.

  • value (str) – The value of the parameter to be added.

Return type

bool

apply_removal_policy(policy)

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.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

bind_to_cluster()

Method called when this Parameter Group is used when defining a database cluster.

Return type

ParameterGroupClusterConfig

bind_to_instance()

Method called when this Parameter Group is used when defining a database instance.

Return type

ParameterGroupInstanceConfig

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_parameter_group_name(scope, id, parameter_group_name)

Imports a parameter group.

Parameters

  • scope (Construct) –

  • id (str) –

  • parameter_group_name (str) –

Return type

IParameterGroup

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool