Amazon DocumentDB Cluster settings - Amazon DocumentDB

Amazon DocumentDB Cluster settings

When you create or modify a cluster, it is important to understand which parameters are immutable and which are modifiable after the cluster has been created. The following table lists all the settings, or parameters, that are specific to a cluster. As specified in the table, some are modifiable, others are not.

Note

These settings should not be confused with Amazon DocumentDB cluster parameter groups and their parameters. For more information about cluster parameter groups, see Managing Amazon DocumentDB cluster parameter groups.

Parameter Modifiable Notes
DBClusterIdentifier Yes

Naming constraints:

  • Length is [1—63] letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters across Amazon Amazon RDS, Amazon Neptune, and Amazon DocumentDB per AWS account, per Region.
Engine No Must be docdb.
BackupRetentionPeriod Yes Must be between [1-35] days.
DBClusterParameterGroupName Yes

Naming constraints:

  • Length is [1—255] alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.
DBSubnetGroupName No After a cluster has been created, you cannot modify the cluster's subnet.
EngineVersion No Value can be 5.0.0 (default), 4.0.0, or 3.6.0.
KmsKeyId No If you choose to encrypt your cluster, you cannot change the AWS KMS key that you used to encrypt your cluster.
MasterUsername No

After a cluster has been created, you cannot modify the MasterUsername.

Naming constraints:

  • Length is [1—63] alphanumeric characters.

  • First character must be a letter.

  • Cannot be a word reserved by the database engine.
MasterUserPassword Yes

Constraints:

  • Length is [8—100] printable ASCII characters.

  • Can use any printable ASCII characters except for the following:

    • / (forward slash)

    • " (double quotation mark)

    • @ (at symbol)
Port Yes The port number applies to all instances in the cluster.
PreferredBackupWindow Yes
PreferredMaintenanceWindow Yes
StorageEncrypted No If you choose to encrypt your cluster, it cannot be unencrypted.
StorageType Yes

The storage type for the DB cluster: Standard (standard) or I/O-Optimized (iopt1).

Default: standard

This parameter can be configured with CreateDBCluster and ModifyDBCluster.

For more information, see Amazon DocumentDB cluster storage configurations.
Tags Yes
VpcSecurityGroupIds No After a cluster has been created, you cannot modify the VPC that the cluster resides in.