DocDB / Client / create_db_cluster_parameter_group

create_db_cluster_parameter_group#

DocDB.Client.create_db_cluster_parameter_group(**kwargs)#

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

See also: AWS API Documentation

Request Syntax

response = client.create_db_cluster_parameter_group(
    DBClusterParameterGroupName='string',
    DBParameterGroupFamily='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DBClusterParameterGroupName (string) –

    [REQUIRED]

    The name of the cluster parameter group.

    Constraints:

    • Must not match the name of an existing DBClusterParameterGroup.

    Note

    This value is stored as a lowercase string.

  • DBParameterGroupFamily (string) –

    [REQUIRED]

    The cluster parameter group family name.

  • Description (string) –

    [REQUIRED]

    The description for the cluster parameter group.

  • Tags (list) –

    The tags to be assigned to the cluster parameter group.

    • (dict) –

      Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

      • Key (string) –

        The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

      • Value (string) –

        The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterParameterGroup': {
        'DBClusterParameterGroupName': 'string',
        'DBParameterGroupFamily': 'string',
        'Description': 'string',
        'DBClusterParameterGroupArn': 'string'
    }
}

Response Structure

  • (dict) –

    • DBClusterParameterGroup (dict) –

      Detailed information about a cluster parameter group.

      • DBClusterParameterGroupName (string) –

        Provides the name of the cluster parameter group.

      • DBParameterGroupFamily (string) –

        Provides the name of the parameter group family that this cluster parameter group is compatible with.

      • Description (string) –

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

      • DBClusterParameterGroupArn (string) –

        The Amazon Resource Name (ARN) for the cluster parameter group.

Exceptions