Skip to main content
Sponsor @cloudposse

Module: memorydb

This module allows an engineer to provision MemoryDB clusters along with an admin user, subnet group, and parameter group. MemoryDB is a real-time in-memory database with API compatibility for Redis.

Introduction​

AWS MemoryDB is a fully managed, Redis-compatible, in-memory database service that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB also boasts the fastest vector search recall rates in the industry. With single-digit millisecond latency, MemoryDB can work with vector data at real-time speeds for AI models that demand performance.

Usage​

For a complete example, see the examples/complete directory.

For automated tests of the complete example using Terratest (which tests and deploys the example on AWS), see the test directory.

provider "aws" {
  region = "us-west-2"
}

# Create a standard label resource. See [null-label](https://github.com/cloudposse/terraform-null-label/#terraform-null-label--)
module "label" {
  source = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  namespace   = "eg"
  environment = "usw2"
  stage       = "sandbox"
  name        = "memorydb"
}

module "example" {
  source = "cloudposse/memorydb/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  ssm_parameter_name = "${module.label.id}/admin_password"

  context = module.label.context
}

Quick Start​

This module relies on two other AWS services:

  • AWS VPC (Virtual Private Cloud)
  • AWS SSM (Systems Manager)

Make sure you either have a default VPC already made or have subnet IDs for any other VPC. At a minimum specify these variables:

  • ssm_parameter_name - the name of the SSM parameter that stores the admin password for the MemoryDB cluster
  • subnet_ids - required if not using a default VPC, this is a list of subnet IDs where the MemoryDB cluster will be deployed
  • security_group_ids - required if not using default security groups, this is a list of security group IDs to attach to the MemoryDB cluster

See our VPC module for creating a VPC. See our Security Group module for creating security groups.

Examples​

Here is an example of using this module:

Variables​

Required Variables​

Optional Variables​

additional_users (list(string)) optional

List of additional users to create for the MemoryDB cluster


Default value: [ ]

admin_password (string) optional

The password for the MemoryDB user. If empty, a random password will be generated.


Default value: ""

admin_username (string) optional

The username for the MemoryDB admin


Default value: "admin"

auto_minor_version_upgrade (bool) optional

Indicates that minor engine upgrades will be applied automatically to the cluster during the maintenance window


Default value: true

create_admin_user (bool) optional

Indicates whether to create an admin user for the MemoryDB cluster


Default value: true

engine_version (string) optional

The version of the Redis engine to use


Default value: "6.2"

maintenance_window (string) optional

The weekly time range during which system maintenance can occur


Default value: null

node_type (string) optional

Node type for the MemoryDB cluster


Default value: "db.r6g.large"

num_replicas_per_shard (number) optional

The number of replicas per shard


Default value: 1

num_shards (number) optional

The number of shards in the cluster


Default value: 1

parameter_group_family (string) optional

The name of the parameter group family


Default value: "memorydb_redis6"

parameter_group_name (string) optional

The name of the parameter group to associate with this cluster.


Default value: null

parameters (map(string)) optional

Key-value mapping of parameters to apply to the parameter group


Default value: { }

port (number) optional

The port on which the cluster accepts connections


Default value: 6379

security_group_ids (list(string)) optional

List of security group IDs to associate with the MemoryDB cluster


Default value: [ ]

snapshot_arns (list(string)) optional

List of ARNs for the snapshots to be restored. NOTE: destroys the existing cluster. Use for restoring.


Default value: [ ]

snapshot_retention_limit (number) optional

The number of days for which MemoryDB retains automatic snapshots before deleting them


Default value: null

snapshot_window (string) optional

The daily time range during which MemoryDB begins taking daily snapshots


Default value: null

sns_topic_arn (string) optional

The ARN of the SNS topic to send notifications to


Default value: null

ssm_kms_key_id (string) optional

The KMS key ID to use for SSM parameter encryption. If not specified, the default key will be used.


Default value: null

ssm_parameter_name (string) optional

The name of the SSM parameter to store the password in. If not specified, the password will not be stored.


Default value: ""

subnet_ids (list(string)) optional

List of subnet IDs for the MemoryDB cluster. Leave empty to use the default VPC subnets.


Default value: [ ]

tls_enabled (bool) optional

Indicates whether Transport Layer Security (TLS) encryption is enabled for the cluster


Default value: true

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​

admin_acl_arn

The ARN of the MemoryDB user's ACL

admin_arn

The ARN of the MemoryDB user

admin_password_ssm_parameter_name

The name of the SSM parameter storing the password for the MemoryDB user

admin_username

The username for the MemoryDB user

arn

The ARN of the MemoryDB cluster

cluster_endpoint

The endpoint of the MemoryDB cluster

engine_patch_version

The Redis engine version

id

The name of the MemoryDB cluster

parameter_group_arn

The ARN of the MemoryDB parameter group

parameter_group_id

The name of the MemoryDB parameter group

shards

The shard details for the MemoryDB cluster

subnet_group_arn

The ARN of the MemoryDB subnet group

subnet_group_id

The name of the MemoryDB subnet group

Dependencies​

Requirements​

  • terraform, version: >= 1.1
  • aws, version: >= 5.0
  • random, version: >= 2.2

Providers​

  • aws, version: >= 5.0
  • random, version: >= 2.2

Modules​

NameVersionSourceDescription
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: