CfnDBParameterGroupProps

class aws_cdk.aws_rds.CfnDBParameterGroupProps(*, description, family, parameters=None, tags=None)

Bases: object

Properties for defining a CfnDBParameterGroup.

Parameters
  • description (str) – Provides the customer-specified description for this DB Parameter Group.

  • family (str) – The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. .. epigraph:: The DB parameter group family can’t be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. For more information, see [CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) .

  • parameters (Union[IResolvable, Mapping[str, str], None]) – An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional. For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide . For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide . .. epigraph:: AWS CloudFormation doesn’t support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

  • tags (Optional[Sequence[CfnTag]]) – Tags to assign to the DB parameter group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_rds as rds

cfn_dBParameter_group_props = rds.CfnDBParameterGroupProps(
    description="description",
    family="family",

    # the properties below are optional
    parameters={
        "parameters_key": "parameters"
    },
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

Provides the customer-specified description for this DB Parameter Group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description

Return type

str

family

The DB parameter group family name.

A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family. .. epigraph:

The DB parameter group family can't be changed when updating a DB parameter group.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

The output contains duplicates.

For more information, see [CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family

Return type

str

parameters

An array of parameter names and values for the parameter update.

At least one parameter name and value must be supplied. Subsequent arguments are optional.

For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide .

For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide . .. epigraph:

AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters

Return type

Union[IResolvable, Mapping[str, str], None]

tags

Tags to assign to the DB parameter group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags

Return type

Optional[List[CfnTag]]