ClusterParameterGroupProps

class aws_cdk.aws_docdb.ClusterParameterGroupProps(*, family, parameters, db_cluster_parameter_group_name=None, description=None)

Bases: object

Properties for a cluster parameter group.

Parameters
  • family (str) – Database family of this parameter group.

  • parameters (Mapping[str, str]) – The parameters in this parameter group.

  • db_cluster_parameter_group_name (Optional[str]) – The name of the cluster parameter group. Default: A CDK generated name for the cluster parameter group

  • description (Optional[str]) – Description for this parameter group. Default: a CDK generated description

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

cluster_parameter_group_props = docdb.ClusterParameterGroupProps(
    family="family",
    parameters={
        "parameters_key": "parameters"
    },

    # the properties below are optional
    db_cluster_parameter_group_name="dbClusterParameterGroupName",
    description="description"
)

Attributes

db_cluster_parameter_group_name

The name of the cluster parameter group.

Default

A CDK generated name for the cluster parameter group

Return type

Optional[str]

description

Description for this parameter group.

Default

a CDK generated description

Return type

Optional[str]

family

Database family of this parameter group.

Return type

str

parameters

The parameters in this parameter group.

Return type

Mapping[str, str]