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) – A friendly description for this 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 DB engine and engine version compatible with that DB cluster parameter group family. .. epigraph:: The DB cluster parameter group family can’t be changed when updating a DB cluster 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 [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .
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. If you don’t specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. .. epigraph:: This value is stored as a lowercase string.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An optional array of key-value pairs to apply to this DB cluster parameter group.

Link:

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.
import aws_cdk.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.

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

This value is stored as a lowercase string.

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

description

A friendly description for this DB cluster parameter group.

Link:: 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 DB engine and engine version compatible with that DB cluster parameter group family. .. epigraph:

The DB cluster parameter group family can't be changed when updating a DB cluster 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 [CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html) .

Link:: 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.

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

tags

An optional array of key-value pairs to apply to this DB cluster parameter group.

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