documentdb

This component is responsible for provisioning DocumentDB clusters.

Usage

Stack Level: Regional

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

components:
  terraform:
    documentdb:
      backend:
        s3:
          workspace_key_prefix: documentdb
      vars:
        enabled: true
        cluster_size: 3
        engine: docdb
        engine_version: 3.6.0
        cluster_family: docdb3.6
        retention_period: 35

Variables

Required Variables

region (string) required

AWS Region.

Optional Variables

apply_immediately (bool) optional

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window

Default value: true

auto_minor_version_upgrade (bool) optional

Specifies whether any minor engine upgrades will be applied automatically to the DB instance during the maintenance window or not

Default value: true

cluster_family (string) optional

The family of the DocumentDB cluster parameter group. For more details, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html

Default value: "docdb3.6"

cluster_parameters optional

List of DB parameters to apply

Type:

list(object({
apply_method = string
name         = string
value        = string
}))

Default value: [ ]

cluster_size (number) optional

Number of DB instances to create in the cluster

Default value: 3

db_port (number) optional

DocumentDB port

Default value: 27017

deletion_protection_enabled (bool) optional

A value that indicates whether the DB cluster has deletion protection enabled

Default value: false

dns_gbl_delegated_environment_name (string) optional

The name of the environment where global dns_delegated is provisioned

Default value: "gbl"

eks_security_group_ingress_enabled (bool) optional

Whether to add the Security Group managed by the EKS cluster in the same regional stack to the ingress allowlist of the DocumentDB cluster.

Default value: true

enabled_cloudwatch_logs_exports (list(string)) optional

List of log types to export to cloudwatch. The following log types are supported: audit, error, general, slowquery

Default value: [ ]

encryption_enabled (bool) optional

Specifies whether the DB cluster is encrypted

Default value: true

engine (string) optional

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid values: docdb

Default value: "docdb"

engine_version (string) optional

The version number of the database engine to use

Default value: "3.6.0"

instance_class (string) optional

The instance class to use. For more details, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-classes.html#db-instance-class-specs

Default value: "db.r4.large"

master_username (string) optional

(Required unless a snapshot_identifier is provided) Username for the master DB user

Default value: "admin1"

preferred_backup_window (string) optional

Daily time range during which the backups happen

Default value: "07:00-09:00"

preferred_maintenance_window (string) optional

The window to perform maintenance in. Syntax: ddd:hh24:mi-ddd:hh24:mi.

Default value: "Mon:22:00-Mon:23:00"

retention_period (number) optional

Number of days to retain backups for

Default value: 5

skip_final_snapshot (bool) optional

Determines whether a final DB snapshot is created before the DB cluster is deleted

Default value: true

snapshot_identifier (string) optional

Specifies 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 snapshot

Default value: ""

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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

Required: No

Default value: { }

attributes (list(string)) optional

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

Required: No

Default value: [ ]

context (any) optional

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

Required: No

Default value:

{
  "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": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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

Required: No

Default value: null

label_key_case (string) optional

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

Required: No

Default value: null

label_order (list(string)) optional

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

Required: No

Default value: null

label_value_case (string) optional

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

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set 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.
Notes:
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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

arn

Amazon Resource Name (ARN) of the cluster

cluster_name

Cluster Identifier

endpoint

Endpoint of the DocumentDB cluster

master_host

DB master hostname

master_username

Username for the master DB user

reader_endpoint

A read-only endpoint of the DocumentDB cluster, automatically load-balanced across replicas

replicas_host

DB replicas hostname

security_group_arn

ARN of the DocumentDB cluster Security Group

security_group_id

ID of the DocumentDB cluster Security Group

security_group_name

Name of the DocumentDB cluster Security Group

Dependencies

Requirements

• terraform, version: >= 1.0.0
• aws, version: >= 3.0
• random, version: >= 3.0

Providers

• aws, version: >= 3.0
• random, version: >= 3.0

Modules

Name	Version	Source	Description
dns_delegated	1.8.0	cloudposse/stack-config/yaml//modules/remote-state	n/a
documentdb_cluster	0.14.0	cloudposse/documentdb-cluster/aws	n/a
eks	1.8.0	cloudposse/stack-config/yaml//modules/remote-state	n/a
iam_roles	latest	../account-map/modules/iam-roles	n/a
this	0.25.0	cloudposse/label/null	n/a
vpc	1.8.0	cloudposse/stack-config/yaml//modules/remote-state	n/a

Resources

The following resources are used by this module:

• aws_ssm_parameter.master_password (resource)
• aws_ssm_parameter.master_username (resource)
• random_password.master_password (resource)

Data Sources

The following data sources are used by this module:

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component