Skip to main content

Component: documentdb

This component is responsible for provisioning DocumentDB clusters.


Stack Level: Regional

Here is an example snippet for how to use this component:

workspace_key_prefix: documentdb
enabled: true
cluster_size: 3
engine: docdb
engine_version: 3.6.0
cluster_family: docdb3.6
retention_period: 35


terraform>= 1.0.0
aws>= 3.0
random>= 3.0


aws>= 3.0
random>= 3.0






additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
apply_immediatelySpecifies whether any cluster modifications are applied immediately, or during the next maintenance windowbooltrueno
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
auto_minor_version_upgradeSpecifies whether any minor engine upgrades will be applied automatically to the DB instance during the maintenance window or notbooltrueno
cluster_familyThe family of the DocumentDB cluster parameter group. For more details, see"docdb3.6"no
cluster_parametersList of DB parameters to apply
apply_method = string
name = string
value = string
cluster_sizeNumber of DB instances to create in the clusternumber3no
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
db_portDocumentDB portnumber27017no
deletion_protection_enabledA value that indicates whether the DB cluster has deletion protection enabledboolfalseno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
eks_security_group_ingress_enabledWhether to add the Security Group managed by the EKS cluster in the same regional stack to the ingress allowlist of the DocumentDB cluster.booltrueno
enabledSet to false to prevent the module from creating any resourcesboolnullno
enabled_cloudwatch_logs_exportsList of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquerylist(string)[]no
encryption_enabledSpecifies whether the DB cluster is encryptedbooltrueno
engineThe name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdbstring"docdb"no
engine_versionThe version number of the database engine to usestring"3.6.0"no
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
instance_classThe instance class to use. For more details, see"db.r4.large"no
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
master_username(Required unless a snapshot_identifier is provided) Username for the master DB userstring"admin1"no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
preferred_backup_windowDaily time range during which the backups happenstring"07:00-09:00"no
preferred_maintenance_windowThe window to perform maintenance in. Syntax: ddd:hh24:mi-ddd:hh24:mi.string"Mon:22:00-Mon:23:00"no
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Region.stringn/ayes
retention_periodNumber of days to retain backups fornumber5no
skip_final_snapshotDetermines whether a final DB snapshot is created before the DB cluster is deletedbooltrueno
snapshot_identifierSpecifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshotstring""no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


arnAmazon Resource Name (ARN) of the cluster
cluster_nameCluster Identifier
endpointEndpoint of the DocumentDB cluster
master_hostDB master hostname
master_usernameUsername for the master DB user
reader_endpointA read-only endpoint of the DocumentDB cluster, automatically load-balanced across replicas
replicas_hostDB replicas hostname
security_group_arnARN of the DocumentDB cluster Security Group
security_group_idID of the DocumentDB cluster Security Group
security_group_nameName of the DocumentDB cluster Security Group