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::GlobalCluster
<a name="aws-resource-docdb-globalcluster"></a>

A data type representing an Amazon DocumentDB global cluster.

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

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

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

```
{
  "Type" : "AWS::DocDB::GlobalCluster",
  "Properties" : {
      "[DeletionProtection](#cfn-docdb-globalcluster-deletionprotection)" : Boolean,
      "[Engine](#cfn-docdb-globalcluster-engine)" : String,
      "[EngineVersion](#cfn-docdb-globalcluster-engineversion)" : String,
      "[GlobalClusterIdentifier](#cfn-docdb-globalcluster-globalclusteridentifier)" : String,
      "[SourceDBClusterIdentifier](#cfn-docdb-globalcluster-sourcedbclusteridentifier)" : String,
      "[StorageEncrypted](#cfn-docdb-globalcluster-storageencrypted)" : Boolean,
      "[Tags](#cfn-docdb-globalcluster-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::DocDB::GlobalCluster
Properties:
  [DeletionProtection](#cfn-docdb-globalcluster-deletionprotection): Boolean
  [Engine](#cfn-docdb-globalcluster-engine): String
  [EngineVersion](#cfn-docdb-globalcluster-engineversion): String
  [GlobalClusterIdentifier](#cfn-docdb-globalcluster-globalclusteridentifier): String
  [SourceDBClusterIdentifier](#cfn-docdb-globalcluster-sourcedbclusteridentifier): String
  [StorageEncrypted](#cfn-docdb-globalcluster-storageencrypted): Boolean
  [Tags](#cfn-docdb-globalcluster-tags): 
    - Tag
```

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

`DeletionProtection`  <a name="cfn-docdb-globalcluster-deletionprotection"></a>
The deletion protection setting for the new global cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Engine`  <a name="cfn-docdb-globalcluster-engine"></a>
The Amazon DocumentDB database engine used by the global cluster.   
*Required*: No  
*Type*: String  
*Allowed values*: `docdb`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EngineVersion`  <a name="cfn-docdb-globalcluster-engineversion"></a>
Indicates the database engine version.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GlobalClusterIdentifier`  <a name="cfn-docdb-globalcluster-globalclusteridentifier"></a>
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceDBClusterIdentifier`  <a name="cfn-docdb-globalcluster-sourcedbclusteridentifier"></a>
The Amazon Resource Name (ARN) to use as the primary cluster of the global cluster. This parameter is optional.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageEncrypted`  <a name="cfn-docdb-globalcluster-storageencrypted"></a>
The storage encryption setting for the global cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-docdb-globalcluster-tags"></a>
The tags to be assigned to the Amazon DocumentDB resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-docdb-globalcluster-tag.md)  
*Maximum*: `50`  
*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-globalcluster-return-values"></a>

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

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

#### 
<a name="aws-resource-docdb-globalcluster-return-values-fn--getatt-fn--getatt"></a>

`GlobalClusterArn`  <a name="GlobalClusterArn-fn::getatt"></a>
The Amazon Resource Name (ARN) for the global cluster.

`GlobalClusterResourceId`  <a name="GlobalClusterResourceId-fn::getatt"></a>
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed. 

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

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

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

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

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

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

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

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

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

`Key`  <a name="cfn-docdb-globalcluster-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  
*Minimum*: `1`  
*Maximum*: `128`  
*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-globalcluster-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  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)