CfnDBClusterParameterGroupProps

class aws_cdk.aws_docdb.CfnDBClusterParameterGroupProps(*, description, family, parameters, name=None, tags=None)

Bases: object

Properties for defining a CfnDBClusterParameterGroup.

Parameters
  • description (str) – The description for the cluster parameter group.

  • family (str) – The cluster parameter group family name.

  • parameters (Any) – Provides a list of parameters for the cluster parameter group.

  • name (Optional[str]) – The name of the DB cluster parameter group. Constraints: - Must not match the name of an existing DBClusterParameterGroup . .. epigraph:: This value is stored as a lowercase string.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to be assigned to the cluster parameter group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-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_docdb as docdb

# parameters: Any

cfn_dBCluster_parameter_group_props = docdb.CfnDBClusterParameterGroupProps(
    description="description",
    family="family",
    parameters=parameters,

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

Attributes

description

The description for the cluster parameter group.

Link

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

Return type

str

family

The cluster parameter group family name.

Link

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

Return type

str

name

The name of the DB cluster parameter group.

Constraints:

  • Must not match the name of an existing DBClusterParameterGroup .

This value is stored as a lowercase string.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-name

Return type

Optional[str]

parameters

Provides a list of parameters for the cluster parameter group.

Link

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

Return type

Any

tags

The tags to be assigned to the cluster parameter group.

Link

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

Return type

Optional[List[CfnTag]]