This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::DocDB::DBClusterParameterGroup
<a name="aws-resource-docdb-dbclusterparametergroup"></a>

The `AWS::DocDB::DBClusterParameterGroup`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup. For more information, see [DBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html) in the *Amazon DocumentDB Developer Guide*.

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. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover.

**Important**  
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the `character_set_database` parameter.

## Syntax
<a name="aws-resource-docdb-dbclusterparametergroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-docdb-dbclusterparametergroup-syntax.json"></a>

```
{
  "Type" : "AWS::DocDB::DBClusterParameterGroup",
  "Properties" : {
      "[Description](#cfn-docdb-dbclusterparametergroup-description)" : String,
      "[Family](#cfn-docdb-dbclusterparametergroup-family)" : String,
      "[Name](#cfn-docdb-dbclusterparametergroup-name)" : String,
      "[Parameters](#cfn-docdb-dbclusterparametergroup-parameters)" : Json,
      "[Tags](#cfn-docdb-dbclusterparametergroup-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-docdb-dbclusterparametergroup-syntax.yaml"></a>

```
Type: AWS::DocDB::DBClusterParameterGroup
Properties:
  [Description](#cfn-docdb-dbclusterparametergroup-description): String
  [Family](#cfn-docdb-dbclusterparametergroup-family): String
  [Name](#cfn-docdb-dbclusterparametergroup-name): String
  [Parameters](#cfn-docdb-dbclusterparametergroup-parameters): Json
  [Tags](#cfn-docdb-dbclusterparametergroup-tags): 
    - Tag
```

## Properties
<a name="aws-resource-docdb-dbclusterparametergroup-properties"></a>

`Description`  <a name="cfn-docdb-dbclusterparametergroup-description"></a>
The description for the cluster parameter group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Family`  <a name="cfn-docdb-dbclusterparametergroup-family"></a>
The cluster parameter group family name.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-docdb-dbclusterparametergroup-name"></a>
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.
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Parameters`  <a name="cfn-docdb-dbclusterparametergroup-parameters"></a>
Provides a list of parameters for the cluster parameter group.  
*Required*: Yes  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-docdb-dbclusterparametergroup-tags"></a>
The tags to be assigned to the cluster parameter group.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-docdb-dbclusterparametergroup-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-docdb-dbclusterparametergroup-return-values"></a>

### Ref
<a name="aws-resource-docdb-dbclusterparametergroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBClusterParameterGroup's name, such as `sample-db-cluster-param-group`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-docdb-dbclusterparametergroup-return-values-fn--getatt"></a>

## Examples
<a name="aws-resource-docdb-dbclusterparametergroup--examples"></a>



### 
<a name="aws-resource-docdb-dbclusterparametergroup--examples--"></a>



#### JSON
<a name="aws-resource-docdb-dbclusterparametergroup--examples----json"></a>

```
{
   "Type" : "AWS::DocDB::DBClusterParameterGroup",
   "Properties" : {
      "Description" : "description",
      "Family" : "docdb3.6",
      "Name" : "sampleParameterGroup",
      "Parameters" :  {
        "audit_logs": "disabled",
        "tls": "enabled",
        "ttl_monitor": "enabled"
     },
      "Tags" : [{ "Key": "String","Value": "String" }]
   }
}
```

#### YAML
<a name="aws-resource-docdb-dbclusterparametergroup--examples----yaml"></a>

```
Type: "AWS::DocDB::DBClusterParameterGroup"
Properties:
   Description: "description"
   Family: "docdb3.6"
   Name: "sampleParameterGroup"
   Parameters: 
        audit_logs: "disabled"
        tls: "enabled"
        ttl_monitor: "enabled"
   Tags: 
      - 
         Key: "String"
         Value: "String"
```

## See also
<a name="aws-resource-docdb-dbclusterparametergroup--seealso"></a>
+  [DBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html) 
+  [CreateDBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBClusterParameterGroup.html) 
+  [DeleteDBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DeleteDBClusterParameterGroup.html) 
+  [DescribeDBClusterParameterGroups](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterParameterGroups.html) 
+  [ModifyDBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterParameterGroup.html) 



# AWS::DocDB::DBClusterParameterGroup Tag
<a name="aws-properties-docdb-dbclusterparametergroup-tag"></a>

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

## Syntax
<a name="aws-properties-docdb-dbclusterparametergroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-docdb-dbclusterparametergroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-docdb-dbclusterparametergroup-tag-key)" : String,
  "[Value](#cfn-docdb-dbclusterparametergroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-docdb-dbclusterparametergroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-docdb-dbclusterparametergroup-tag-key): String
  [Value](#cfn-docdb-dbclusterparametergroup-tag-value): String
```

## Properties
<a name="aws-properties-docdb-dbclusterparametergroup-tag-properties"></a>

`Key`  <a name="cfn-docdb-dbclusterparametergroup-tag-key"></a>
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, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-docdb-dbclusterparametergroup-tag-value"></a>
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, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)