CfnDBClusterParameterGroupProps

class aws_cdk.aws_rds.CfnDBClusterParameterGroupProps(*, description, family, parameters, db_cluster_parameter_group_name=None, tags=None)

Bases: object

Properties for defining a CfnDBClusterParameterGroup.

Parameters:

description (str) – The description for the DB cluster parameter group.
family (str) – The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7 , aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 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 Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql .. epigraph:: The output contains duplicates. The following are the valid DB engine values: - aurora-mysql - aurora-postgresql - mysql - postgres
parameters (Any) – Provides a list of parameters for the DB cluster parameter group.
db_cluster_parameter_group_name (Optional[str]) – The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DB cluster parameter group. .. epigraph:: This value is stored as a lowercase string.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the DB cluster parameter group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.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_dBCluster_parameter_group_props = rds.CfnDBClusterParameterGroupProps(
    description="description",
    family="family",
    parameters=parameters,

    # the properties below are optional
    db_cluster_parameter_group_name="dbClusterParameterGroupName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

db_cluster_parameter_group_name

The name of the DB cluster parameter group.

Constraints:

Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-dbclusterparametergroupname

description

The description for the DB cluster parameter group.

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

family

The DB cluster parameter group family name.

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

Aurora MySQL

Example: aurora-mysql5.7 , aurora-mysql8.0

Aurora PostgreSQL

Example: aurora-postgresql14

RDS for MySQL

Example: mysql8.0

RDS for PostgreSQL

Example: postgres13

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 Aurora PostgreSQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

aurora-mysql
aurora-postgresql
mysql
postgres

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

parameters

Provides a list of parameters for the DB cluster parameter group.

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

tags

Tags to assign to the DB cluster parameter group.

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