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).

# Amazon DocumentDB (with MongoDB compatibility)
<a name="AWS_DocDB"></a>

**Resource types**
+ [AWS::DocDB::DBCluster](aws-resource-docdb-dbcluster.md)
+ [AWS::DocDB::DBClusterParameterGroup](aws-resource-docdb-dbclusterparametergroup.md)
+ [AWS::DocDB::DBInstance](aws-resource-docdb-dbinstance.md)
+ [AWS::DocDB::DBSubnetGroup](aws-resource-docdb-dbsubnetgroup.md)
+ [AWS::DocDB::EventSubscription](aws-resource-docdb-eventsubscription.md)
+ [AWS::DocDB::GlobalCluster](aws-resource-docdb-globalcluster.md)

# AWS::DocDB::DBCluster
<a name="aws-resource-docdb-dbcluster"></a>

The `AWS::DocDB::DBCluster`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see [DBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html) in the *Amazon DocumentDB Developer Guide*. 

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

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

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

```
{
  "Type" : "AWS::DocDB::DBCluster",
  "Properties" : {
      "[AvailabilityZones](#cfn-docdb-dbcluster-availabilityzones)" : [ String, ... ],
      "[BackupRetentionPeriod](#cfn-docdb-dbcluster-backupretentionperiod)" : Integer,
      "[CopyTagsToSnapshot](#cfn-docdb-dbcluster-copytagstosnapshot)" : Boolean,
      "[DBClusterIdentifier](#cfn-docdb-dbcluster-dbclusteridentifier)" : String,
      "[DBClusterParameterGroupName](#cfn-docdb-dbcluster-dbclusterparametergroupname)" : String,
      "[DBSubnetGroupName](#cfn-docdb-dbcluster-dbsubnetgroupname)" : String,
      "[DeletionProtection](#cfn-docdb-dbcluster-deletionprotection)" : Boolean,
      "[EnableCloudwatchLogsExports](#cfn-docdb-dbcluster-enablecloudwatchlogsexports)" : [ String, ... ],
      "[EngineVersion](#cfn-docdb-dbcluster-engineversion)" : String,
      "[GlobalClusterIdentifier](#cfn-docdb-dbcluster-globalclusteridentifier)" : String,
      "[KmsKeyId](#cfn-docdb-dbcluster-kmskeyid)" : String,
      "[ManageMasterUserPassword](#cfn-docdb-dbcluster-managemasteruserpassword)" : Boolean,
      "[MasterUsername](#cfn-docdb-dbcluster-masterusername)" : String,
      "[MasterUserPassword](#cfn-docdb-dbcluster-masteruserpassword)" : String,
      "[MasterUserSecretKmsKeyId](#cfn-docdb-dbcluster-masterusersecretkmskeyid)" : String,
      "[NetworkType](#cfn-docdb-dbcluster-networktype)" : String,
      "[Port](#cfn-docdb-dbcluster-port)" : Integer,
      "[PreferredBackupWindow](#cfn-docdb-dbcluster-preferredbackupwindow)" : String,
      "[PreferredMaintenanceWindow](#cfn-docdb-dbcluster-preferredmaintenancewindow)" : String,
      "[RestoreToTime](#cfn-docdb-dbcluster-restoretotime)" : String,
      "[RestoreType](#cfn-docdb-dbcluster-restoretype)" : String,
      "[RotateMasterUserPassword](#cfn-docdb-dbcluster-rotatemasteruserpassword)" : Boolean,
      "[ServerlessV2ScalingConfiguration](#cfn-docdb-dbcluster-serverlessv2scalingconfiguration)" : ServerlessV2ScalingConfiguration,
      "[SnapshotIdentifier](#cfn-docdb-dbcluster-snapshotidentifier)" : String,
      "[SourceDBClusterIdentifier](#cfn-docdb-dbcluster-sourcedbclusteridentifier)" : String,
      "[StorageEncrypted](#cfn-docdb-dbcluster-storageencrypted)" : Boolean,
      "[StorageType](#cfn-docdb-dbcluster-storagetype)" : String,
      "[Tags](#cfn-docdb-dbcluster-tags)" : [ Tag, ... ],
      "[UseLatestRestorableTime](#cfn-docdb-dbcluster-uselatestrestorabletime)" : Boolean,
      "[VpcSecurityGroupIds](#cfn-docdb-dbcluster-vpcsecuritygroupids)" : [ String, ... ]
    }
}
```

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

```
Type: AWS::DocDB::DBCluster
Properties:
  [AvailabilityZones](#cfn-docdb-dbcluster-availabilityzones): 
    - String
  [BackupRetentionPeriod](#cfn-docdb-dbcluster-backupretentionperiod): Integer
  [CopyTagsToSnapshot](#cfn-docdb-dbcluster-copytagstosnapshot): Boolean
  [DBClusterIdentifier](#cfn-docdb-dbcluster-dbclusteridentifier): String
  [DBClusterParameterGroupName](#cfn-docdb-dbcluster-dbclusterparametergroupname): String
  [DBSubnetGroupName](#cfn-docdb-dbcluster-dbsubnetgroupname): String
  [DeletionProtection](#cfn-docdb-dbcluster-deletionprotection): Boolean
  [EnableCloudwatchLogsExports](#cfn-docdb-dbcluster-enablecloudwatchlogsexports): 
    - String
  [EngineVersion](#cfn-docdb-dbcluster-engineversion): String
  [GlobalClusterIdentifier](#cfn-docdb-dbcluster-globalclusteridentifier): String
  [KmsKeyId](#cfn-docdb-dbcluster-kmskeyid): String
  [ManageMasterUserPassword](#cfn-docdb-dbcluster-managemasteruserpassword): Boolean
  [MasterUsername](#cfn-docdb-dbcluster-masterusername): String
  [MasterUserPassword](#cfn-docdb-dbcluster-masteruserpassword): String
  [MasterUserSecretKmsKeyId](#cfn-docdb-dbcluster-masterusersecretkmskeyid): String
  [NetworkType](#cfn-docdb-dbcluster-networktype): String
  [Port](#cfn-docdb-dbcluster-port): Integer
  [PreferredBackupWindow](#cfn-docdb-dbcluster-preferredbackupwindow): String
  [PreferredMaintenanceWindow](#cfn-docdb-dbcluster-preferredmaintenancewindow): String
  [RestoreToTime](#cfn-docdb-dbcluster-restoretotime): String
  [RestoreType](#cfn-docdb-dbcluster-restoretype): String
  [RotateMasterUserPassword](#cfn-docdb-dbcluster-rotatemasteruserpassword): Boolean
  [ServerlessV2ScalingConfiguration](#cfn-docdb-dbcluster-serverlessv2scalingconfiguration): 
    ServerlessV2ScalingConfiguration
  [SnapshotIdentifier](#cfn-docdb-dbcluster-snapshotidentifier): String
  [SourceDBClusterIdentifier](#cfn-docdb-dbcluster-sourcedbclusteridentifier): String
  [StorageEncrypted](#cfn-docdb-dbcluster-storageencrypted): Boolean
  [StorageType](#cfn-docdb-dbcluster-storagetype): String
  [Tags](#cfn-docdb-dbcluster-tags): 
    - Tag
  [UseLatestRestorableTime](#cfn-docdb-dbcluster-uselatestrestorabletime): Boolean
  [VpcSecurityGroupIds](#cfn-docdb-dbcluster-vpcsecuritygroupids): 
    - String
```

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

`AvailabilityZones`  <a name="cfn-docdb-dbcluster-availabilityzones"></a>
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BackupRetentionPeriod`  <a name="cfn-docdb-dbcluster-backupretentionperiod"></a>
The number of days for which automated backups are retained. You must specify a minimum value of 1.  
Default: 1  
Constraints:  
+ Must be a value from 1 to 35.
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CopyTagsToSnapshot`  <a name="cfn-docdb-dbcluster-copytagstosnapshot"></a>
Set to `true` to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise `false`. The default is `false`.  
*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)

`DBClusterIdentifier`  <a name="cfn-docdb-dbcluster-dbclusteridentifier"></a>
The cluster identifier. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens. 
+ The first character must be a letter.
+ Cannot end with a hyphen or contain two consecutive hyphens. 
Example: `my-cluster`  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DBClusterParameterGroupName`  <a name="cfn-docdb-dbcluster-dbclusterparametergroupname"></a>
The name of the cluster parameter group to associate with this cluster.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DBSubnetGroupName`  <a name="cfn-docdb-dbcluster-dbsubnetgroupname"></a>
A subnet group to associate with this cluster.  
Constraints: Must match the name of an existing `DBSubnetGroup`. Must not be default.  
Example: `mySubnetgroup`  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeletionProtection`  <a name="cfn-docdb-dbcluster-deletionprotection"></a>
Protects clusters from being accidentally deleted. If enabled, the cluster cannot be deleted unless it is modified and `DeletionProtection` is disabled.  
*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)

`EnableCloudwatchLogsExports`  <a name="cfn-docdb-dbcluster-enablecloudwatchlogsexports"></a>
The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see [Auditing Amazon DocumentDB Events](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) and [Profiling Amazon DocumentDB Operations](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EngineVersion`  <a name="cfn-docdb-dbcluster-engineversion"></a>
The version number of the database engine to use. The `--engine-version` will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.  
If you intend to trigger an in-place upgrade, please refer to [Amazon DocumentDB in-place major version upgrade](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-mvu.html). Note that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN template.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GlobalClusterIdentifier`  <a name="cfn-docdb-dbcluster-globalclusteridentifier"></a>
The cluster identifier of the new global cluster.  
*Required*: No  
*Type*: String  
*Pattern*: `[A-Za-z][0-9A-Za-z-:._]*`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyId`  <a name="cfn-docdb-dbcluster-kmskeyid"></a>
The AWS KMS key identifier for an encrypted cluster.  
The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.  
If an encryption key is not specified in `KmsKeyId`:   
+ If the `StorageEncrypted` parameter is `true`, Amazon DocumentDB uses your default encryption key. 
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Regions.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ManageMasterUserPassword`  <a name="cfn-docdb-dbcluster-managemasteruserpassword"></a>
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.  
Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if `MasterUserPassword` is specified.  
*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)

`MasterUsername`  <a name="cfn-docdb-dbcluster-masterusername"></a>
The name of the master user for the cluster.  
Constraints:  
+ Must be from 1 to 63 letters or numbers.
+ The first character must be a letter.
+ Cannot be a reserved word for the chosen database engine. 
*Required*: Conditional  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MasterUserPassword`  <a name="cfn-docdb-dbcluster-masteruserpassword"></a>
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).  
Constraints: Must contain from 8 to 100 characters.  
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MasterUserSecretKmsKeyId`  <a name="cfn-docdb-dbcluster-masterusersecretkmskeyid"></a>
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.  
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.  
If you don't specify `MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.  
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NetworkType`  <a name="cfn-docdb-dbcluster-networktype"></a>
The network type of the cluster.  
The network type is determined by the `DBSubnetGroup` specified for the cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).  
For more information, see [DocumentDB clusters in a VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) in the Amazon DocumentDB Developer Guide.  
Valid Values: `IPV4` \$1 `DUAL`  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Port`  <a name="cfn-docdb-dbcluster-port"></a>
Specifies the port that the database engine is listening on.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PreferredBackupWindow`  <a name="cfn-docdb-dbcluster-preferredbackupwindow"></a>
The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.   
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.   
Constraints:  
+ Must be in the format `hh24:mi-hh24:mi`.
+ Must be in Universal Coordinated Time (UTC).
+ Must not conflict with the preferred maintenance window. 
+ Must be at least 30 minutes.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PreferredMaintenanceWindow`  <a name="cfn-docdb-dbcluster-preferredmaintenancewindow"></a>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).  
Format: `ddd:hh24:mi-ddd:hh24:mi`  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.  
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun  
Constraints: Minimum 30-minute window.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestoreToTime`  <a name="cfn-docdb-dbcluster-restoretotime"></a>
The date and time to restore the cluster to.  
Valid values: A time in Universal Coordinated Time (UTC) format.  
Constraints:  
+ Must be before the latest restorable time for the instance.
+ Must be specified if the `UseLatestRestorableTime` parameter is not provided.
+ Cannot be specified if the `UseLatestRestorableTime` parameter is `true`.
+ Cannot be specified if the `RestoreType` parameter is `copy-on-write`.
Example: `2015-03-07T23:45:00Z`  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestoreType`  <a name="cfn-docdb-dbcluster-restoretype"></a>
The type of restore to be performed. You can specify one of the following values:  
+ `full-copy` - The new DB cluster is restored as a full copy of the source DB cluster.
+ `copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1.11.  
If you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RotateMasterUserPassword`  <a name="cfn-docdb-dbcluster-rotatemasteruserpassword"></a>
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.  
This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.  
Constraint: You must apply the change immediately when rotating the master user password.  
*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)

`ServerlessV2ScalingConfiguration`  <a name="cfn-docdb-dbcluster-serverlessv2scalingconfiguration"></a>
Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.  
*Required*: No  
*Type*: [ServerlessV2ScalingConfiguration](aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotIdentifier`  <a name="cfn-docdb-dbcluster-snapshotidentifier"></a>
The identifier for the snapshot or cluster snapshot to restore from.  
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.  
Constraints:  
+ Must match the identifier of an existing snapshot.
*Required*: No  
*Type*: String  
*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-dbcluster-sourcedbclusteridentifier"></a>
The identifier of the source cluster from which to restore.  
Constraints:  
+ Must match the identifier of an existing `DBCluster`.
*Required*: No  
*Type*: String  
*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-dbcluster-storageencrypted"></a>
Specifies whether the cluster is encrypted.  
If you specify `SourceDBClusterIdentifier` or `SnapshotIdentifier` and don’t specify `StorageEncrypted`, the encryption property is inherited from the source cluster or snapshot (unless `KMSKeyId` is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and `StorageEncrypted` is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the `KMSKeyId` property as well). If the source is unencrypted and `StorageEncrypted` is specified to be true, then the `KMSKeyId` property must be specified. If the source is encrypted, don’t specify `StorageEncrypted` to be false as opting out of encryption is not allowed.  
*Required*: Conditional  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageType`  <a name="cfn-docdb-dbcluster-storagetype"></a>
The storage type to associate with the DB cluster.  
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the *Amazon DocumentDB Developer Guide*.  
Valid values for storage type - `standard | iopt1`  
Default value is `standard `  
When you create an Amazon DocumentDB cluster with the storage type set to `iopt1`, the storage type is returned in the response. The storage type isn't returned when you set it to `standard`.
*Required*: No  
*Type*: String  
*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-dbcluster-tags"></a>
The tags to be assigned to the cluster.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-docdb-dbcluster-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UseLatestRestorableTime`  <a name="cfn-docdb-dbcluster-uselatestrestorabletime"></a>
A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise.   
Default: `false`  
Constraints: Cannot be specified if the `RestoreToTime` parameter is provided.  
*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)

`VpcSecurityGroupIds`  <a name="cfn-docdb-dbcluster-vpcsecuritygroupids"></a>
A list of EC2 VPC security groups to associate with this cluster.   
*Required*: No  
*Type*: Array of String  
*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-dbcluster-return-values"></a>

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBClusterIdentifier, such as `mycluster`.

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-dbcluster-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

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

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

`ClusterResourceId`  <a name="ClusterResourceId-fn::getatt"></a>
The resource id for the cluster; for example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies. 

`Endpoint`  <a name="Endpoint-fn::getatt"></a>
The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com`.

`Port`  <a name="Port-fn::getatt"></a>
The port number on which the cluster accepts connections. For example: `27017`.

`ReadEndpoint`  <a name="ReadEndpoint-fn::getatt"></a>
The reader endpoint for the cluster. For example: `sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com`.

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



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



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

```
{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Resources" : {
      "myDBInstance" : {
         "Type" : "AWS::DocDB::DBCluster",
         "Properties" : {
            "BackupRetentionPeriod" : 8,
            "DBClusterIdentifier" : "sample-cluster",
            "DBClusterParameterGroupName" : "default.docdb3.6",
            "DBSubnetGroupName" : "default",
            "KmsKeyId" : "your-kms-key-id",
            "MasterUsername" : "your-master-username",
            "MasterUserPassword" : "your-master-user-password",
            "Port" : "27017",
            "PreferredBackupWindow" : "07:34-08:04",
            "PreferredMaintenanceWindow" : "sat:04:51-sat:05:21",
            "SnapshotIdentifier" : "sample-cluster-snapshot-id",
            "StorageEncrypted" : true,
            "Tags" : [ {"Key" : "String", "Value" : "String"} ]
         }
      }
   }  
}
```

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

```
AWSTemplateFormatVersion: "2010-09-09"
Resources: 
   myDBInstance: 
      Type: "AWS::DocDB::DBCluster"
      Properties: 
         BackupRetentionPeriod : 8
         DBClusterIdentifier : "sample-cluster"
         DBClusterParameterGroupName : "default.docdb3.6"
         DBSubnetGroupName : "default"
         KmsKeyId : "your-kms-key-id"
         MasterUsername : "your-master-username"
         MasterUserPassword : "your-master-user-password"
         Port : "27017"
         PreferredBackupWindow : "07:34-08:04"
         PreferredMaintenanceWindow : "sat:04:51-sat:05:21"
         SnapshotIdentifier : "sample-cluster-snapshot-id"
         StorageEncrypted : true
         Tags: 
            - 
               Key: "String"
               Value: "String"
```

## See also
<a name="aws-resource-docdb-dbcluster--seealso"></a>
+  [DBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html) 
+  [CreateDBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBCluster.html) 
+  [DeleteDBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DeleteDBCluster.html) 
+  [DescribeDBClusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html) 
+  [ModifyDBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBCluster.html) 



# AWS::DocDB::DBCluster ServerlessV2ScalingConfiguration
<a name="aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration"></a>

Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.

## Syntax
<a name="aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration-syntax"></a>

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

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

```
{
  "[MaxCapacity](#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-maxcapacity)" : Number,
  "[MinCapacity](#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-mincapacity)" : Number
}
```

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

```
  [MaxCapacity](#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-maxcapacity): Number
  [MinCapacity](#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-mincapacity): Number
```

## Properties
<a name="aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration-properties"></a>

`MaxCapacity`  <a name="cfn-docdb-dbcluster-serverlessv2scalingconfiguration-maxcapacity"></a>
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinCapacity`  <a name="cfn-docdb-dbcluster-serverlessv2scalingconfiguration-mincapacity"></a>
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

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

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

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

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

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

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

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

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

`Key`  <a name="cfn-docdb-dbcluster-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-dbcluster-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)

# 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)

# AWS::DocDB::DBInstance
<a name="aws-resource-docdb-dbinstance"></a>

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

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

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

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

```
{
  "Type" : "AWS::DocDB::DBInstance",
  "Properties" : {
      "[AutoMinorVersionUpgrade](#cfn-docdb-dbinstance-autominorversionupgrade)" : Boolean,
      "[AvailabilityZone](#cfn-docdb-dbinstance-availabilityzone)" : String,
      "[CACertificateIdentifier](#cfn-docdb-dbinstance-cacertificateidentifier)" : String,
      "[CertificateRotationRestart](#cfn-docdb-dbinstance-certificaterotationrestart)" : Boolean,
      "[DBClusterIdentifier](#cfn-docdb-dbinstance-dbclusteridentifier)" : String,
      "[DBInstanceClass](#cfn-docdb-dbinstance-dbinstanceclass)" : String,
      "[DBInstanceIdentifier](#cfn-docdb-dbinstance-dbinstanceidentifier)" : String,
      "[EnablePerformanceInsights](#cfn-docdb-dbinstance-enableperformanceinsights)" : Boolean,
      "[PreferredMaintenanceWindow](#cfn-docdb-dbinstance-preferredmaintenancewindow)" : String,
      "[Tags](#cfn-docdb-dbinstance-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::DocDB::DBInstance
Properties:
  [AutoMinorVersionUpgrade](#cfn-docdb-dbinstance-autominorversionupgrade): Boolean
  [AvailabilityZone](#cfn-docdb-dbinstance-availabilityzone): String
  [CACertificateIdentifier](#cfn-docdb-dbinstance-cacertificateidentifier): String
  [CertificateRotationRestart](#cfn-docdb-dbinstance-certificaterotationrestart): Boolean
  [DBClusterIdentifier](#cfn-docdb-dbinstance-dbclusteridentifier): String
  [DBInstanceClass](#cfn-docdb-dbinstance-dbinstanceclass): String
  [DBInstanceIdentifier](#cfn-docdb-dbinstance-dbinstanceidentifier): String
  [EnablePerformanceInsights](#cfn-docdb-dbinstance-enableperformanceinsights): Boolean
  [PreferredMaintenanceWindow](#cfn-docdb-dbinstance-preferredmaintenancewindow): String
  [Tags](#cfn-docdb-dbinstance-tags): 
    - Tag
```

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

`AutoMinorVersionUpgrade`  <a name="cfn-docdb-dbinstance-autominorversionupgrade"></a>
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.  
Default: `false`  
*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)

`AvailabilityZone`  <a name="cfn-docdb-dbinstance-availabilityzone"></a>
The Amazon EC2 Availability Zone that the instance is created in.   
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.  
Example: `us-east-1d`  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CACertificateIdentifier`  <a name="cfn-docdb-dbinstance-cacertificateidentifier"></a>
The identifier of the CA certificate for this DB instance.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CertificateRotationRestart`  <a name="cfn-docdb-dbinstance-certificaterotationrestart"></a>
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.  
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.  
Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, see [Updating Your Amazon DocumentDB TLS Certificates](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) and [ Encrypting Data in Transit](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) in the *Amazon DocumentDB Developer Guide*.  
*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)

`DBClusterIdentifier`  <a name="cfn-docdb-dbinstance-dbclusteridentifier"></a>
The identifier of the cluster that the instance will belong to.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DBInstanceClass`  <a name="cfn-docdb-dbinstance-dbinstanceclass"></a>
The compute and memory capacity of the instance; for example, `db.m4.large`. If you change the class of an instance there can be some interruption in the cluster's service.  
*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)

`DBInstanceIdentifier`  <a name="cfn-docdb-dbinstance-dbinstanceidentifier"></a>
The instance identifier. This parameter is stored as a lowercase string.  
Constraints:  
+ Must contain from 1 to 63 letters, numbers, or hyphens.
+ The first character must be a letter.
+ Cannot end with a hyphen or contain two consecutive hyphens.
Example: `mydbinstance`  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EnablePerformanceInsights`  <a name="cfn-docdb-dbinstance-enableperformanceinsights"></a>
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).  
*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)

`PreferredMaintenanceWindow`  <a name="cfn-docdb-dbinstance-preferredmaintenancewindow"></a>
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).  
 Format: `ddd:hh24:mi-ddd:hh24:mi`  
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.   
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun  
Constraints: Minimum 30-minute window.  
*Required*: No  
*Type*: String  
*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-dbinstance-tags"></a>
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-docdb-dbinstance-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-dbinstance-return-values"></a>

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

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

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-dbinstance-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

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

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

`Endpoint`  <a name="Endpoint-fn::getatt"></a>
The connection endpoint for the instance. For example: `sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com`.

`Port`  <a name="Port-fn::getatt"></a>
The port number on which the database accepts connections, such as `27017`.

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



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



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

```
{
   "Type" : "AWS::DocDB::DBInstance",
   "Properties" : {
      "AutoMinorVersionUpgrade" : true,
      "AvailabilityZone" : "us-east-1c",
      "DBClusterIdentifier" : "sample-cluster",
      "DBInstanceClass" : "db.r5.large",
      "DBInstanceIdentifier" : "sample-cluster-instance-0",
      "PreferredMaintenanceWindow" : "sat:06:54-sat:07:24",
      "Tags" : [{ "Key": "String","Value": "String" }]
   }
}
```

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

```
Type: "AWS::DocDB::DBInstance"
Properties:
   AutoMinorVersionUpgrade: true
   AvailabilityZone: "us-east-1c"
   DBClusterIdentifier: "sample-cluster"
   DBInstanceClass: "db.r5.large"
   DBInstanceIdentifier: "sample-cluster-instance-0"
   PreferredMaintenanceWindow: "sat:06:54-sat:07:24"
   Tags:
      - 
         Key: "String"
         Value: "String"
```

## See also
<a name="aws-resource-docdb-dbinstance--seealso"></a>
+  [DBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html) 
+  [CreateDBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBInstance.html) 
+  [DeleteDBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DeleteDBInstance.html) 
+  [DescribeDBInstances](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBInstances.html) 
+  [ModifyDBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBInstance.html) 



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

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

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

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

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

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

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

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

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

`Key`  <a name="cfn-docdb-dbinstance-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-dbinstance-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)

# AWS::DocDB::DBSubnetGroup
<a name="aws-resource-docdb-dbsubnetgroup"></a>

The `AWS::DocDB::DBSubnetGroup`Amazon DocumentDB (with MongoDB compatibility) resource describes a DBSubnetGroup. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region. For more information, see [DBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html) in the *Amazon DocumentDB Developer Guide*. 

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

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

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

```
{
  "Type" : "AWS::DocDB::DBSubnetGroup",
  "Properties" : {
      "[DBSubnetGroupDescription](#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription)" : String,
      "[DBSubnetGroupName](#cfn-docdb-dbsubnetgroup-dbsubnetgroupname)" : String,
      "[SubnetIds](#cfn-docdb-dbsubnetgroup-subnetids)" : [ String, ... ],
      "[Tags](#cfn-docdb-dbsubnetgroup-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::DocDB::DBSubnetGroup
Properties:
  [DBSubnetGroupDescription](#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription): String
  [DBSubnetGroupName](#cfn-docdb-dbsubnetgroup-dbsubnetgroupname): String
  [SubnetIds](#cfn-docdb-dbsubnetgroup-subnetids): 
    - String
  [Tags](#cfn-docdb-dbsubnetgroup-tags): 
    - Tag
```

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

`DBSubnetGroupDescription`  <a name="cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription"></a>
The description for the subnet group.  
*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)

`DBSubnetGroupName`  <a name="cfn-docdb-dbsubnetgroup-dbsubnetgroupname"></a>
The name for the subnet group. This value is stored as a lowercase string.  
Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.  
Example: `mySubnetgroup`  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubnetIds`  <a name="cfn-docdb-dbsubnetgroup-subnetids"></a>
The Amazon EC2 subnet IDs for the subnet group.  
*Required*: Yes  
*Type*: Array of String  
*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-dbsubnetgroup-tags"></a>
The tags to be assigned to the subnet group.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-docdb-dbsubnetgroup-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-dbsubnetgroup-return-values"></a>

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the DBSubnetGroup's name, such as `default`.

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-dbsubnetgroup-return-values-fn--getatt"></a>

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



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



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

```
{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Resources" : {
      "myDBSubnetGroup" : {
         "Type" : "AWS::DocDB::DBSubnetGroup",
         "Properties" : {
            "DBSubnetGroupDescription" : "description",
            "SubnetIds" : [ "subnet-7b5b4112", "subnet-7b5b4115" ],
            "Tags" : [ {"Key" : "String", "Value" : "String"} ]
         }
      }
   }
}
```

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

```
AWSTemplateFormatVersion: "2010-09-09"
Resources: 
   myDBSubnetGroup: 
      Type: "AWS::DocDB::DBSubnetGroup"
      Properties: 
         DBSubnetGroupDescription: "description"
         SubnetIds: 
            - "subnet-7b5b4112"
            - "subnet-7b5b4115"
         Tags: 
            - 
               Key: "String"
               Value: "String"
```

## See also
<a name="aws-resource-docdb-dbsubnetgroup--seealso"></a>
+  [Subnet](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_Subnet.html) 
+  [DBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html) 
+  [CreateDBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBSubnetGroup.html) 
+  [DeleteDBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DeleteDBSubnetGroup.html) 
+  [DescribeDBSubnetGroups](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBSubnetGroups.html) 
+  [ModifyDBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBSubnetGroup.html) 



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

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

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

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

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

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

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

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

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

`Key`  <a name="cfn-docdb-dbsubnetgroup-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-dbsubnetgroup-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)

# AWS::DocDB::EventSubscription
<a name="aws-resource-docdb-eventsubscription"></a>

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (`SourceType`) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (`SourceIds`) that trigger the events, and you can provide a list of event categories (`EventCategories`) for events that you want to be notified of. For example, you can specify `SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` and `EventCategories = Availability, Backup`.

If you specify both the `SourceType` and `SourceIds` (such as `SourceType = db-instance` and `SourceIdentifier = myDBInstance1`), you are notified of all the `db-instance` events for the specified source. If you specify a `SourceType` but do not specify a `SourceIdentifier`, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the `SourceType` or the `SourceIdentifier`, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

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

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

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

```
{
  "Type" : "AWS::DocDB::EventSubscription",
  "Properties" : {
      "[Enabled](#cfn-docdb-eventsubscription-enabled)" : Boolean,
      "[EventCategories](#cfn-docdb-eventsubscription-eventcategories)" : [ String, ... ],
      "[SnsTopicArn](#cfn-docdb-eventsubscription-snstopicarn)" : String,
      "[SourceIds](#cfn-docdb-eventsubscription-sourceids)" : [ String, ... ],
      "[SourceType](#cfn-docdb-eventsubscription-sourcetype)" : String,
      "[SubscriptionName](#cfn-docdb-eventsubscription-subscriptionname)" : String
    }
}
```

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

```
Type: AWS::DocDB::EventSubscription
Properties:
  [Enabled](#cfn-docdb-eventsubscription-enabled): Boolean
  [EventCategories](#cfn-docdb-eventsubscription-eventcategories): 
    - String
  [SnsTopicArn](#cfn-docdb-eventsubscription-snstopicarn): String
  [SourceIds](#cfn-docdb-eventsubscription-sourceids): 
    - String
  [SourceType](#cfn-docdb-eventsubscription-sourcetype): String
  [SubscriptionName](#cfn-docdb-eventsubscription-subscriptionname): String
```

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

`Enabled`  <a name="cfn-docdb-eventsubscription-enabled"></a>
 A Boolean value; set to `true` to activate the subscription, set to `false` to create the subscription but not active it.   
*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)

`EventCategories`  <a name="cfn-docdb-eventsubscription-eventcategories"></a>
 A list of event categories for a `SourceType` that you want to subscribe to.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnsTopicArn`  <a name="cfn-docdb-eventsubscription-snstopicarn"></a>
The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceIds`  <a name="cfn-docdb-eventsubscription-sourceids"></a>
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.  
Constraints:  
+ If `SourceIds` are provided, `SourceType` must also be provided.
+ If the source type is an instance, a `DBInstanceIdentifier` must be provided.
+ If the source type is a security group, a `DBSecurityGroupName` must be provided.
+ If the source type is a parameter group, a `DBParameterGroupName` must be provided.
+ If the source type is a snapshot, a `DBSnapshotIdentifier` must be provided.
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceType`  <a name="cfn-docdb-eventsubscription-sourcetype"></a>
The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to `db-instance`. If this value is not specified, all events are returned.  
Valid values: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubscriptionName`  <a name="cfn-docdb-eventsubscription-subscriptionname"></a>
The name of the subscription.  
Constraints: The name must be fewer than 255 characters.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

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

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

# 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)