CfnDBParameterGroupProps

class aws_cdk.aws_rds.CfnDBParameterGroupProps(*, description, family, db_parameter_group_name=None, 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 database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql .. epigraph:: The output contains duplicates. The following are the valid DB engine values: - aurora-mysql - aurora-postgresql - db2-ae - db2-se - mysql - oracle-ee - oracle-ee-cdb - oracle-se2 - oracle-se2-cdb - postgres - sqlserver-ee - sqlserver-se - sqlserver-ex - sqlserver-web

  • db_parameter_group_name (Optional[str]) – The name of the DB parameter group. Constraints: - Must be 1 to 255 letters, numbers, or hyphens. - First character must be a letter - Can’t end with a hyphen or contain two consecutive hyphens If you don’t specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. .. epigraph:: This value is stored as a lowercase string.

  • parameters (Any) –

    An array of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide , or Working with 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[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the DB parameter group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-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.
from aws_cdk import aws_rds as rds

# parameters: Any

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

    # the properties below are optional
    db_parameter_group_name="dbParameterGroupName",
    parameters=parameters,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

db_parameter_group_name

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Can’t end with a hyphen or contain two consecutive hyphens

If you don’t specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group. .. epigraph:

This value is stored as a lowercase string.
See:

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

description

Provides the customer-specified description for this DB parameter group.

See:

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

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 database engine and engine version compatible with that DB parameter group family.

To list all of the available parameter group families for a DB engine, use the following command:

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

For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

  • aurora-mysql

  • aurora-postgresql

  • db2-ae

  • db2-se

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

See:

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

parameters

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

You must specify at least one parameter name and value.

For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide , or Working with 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.
See:

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

tags

Tags to assign to the DB parameter group.

See:

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