Open Source Ecosystems

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.

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.

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
}

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

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:

examples/complete - complete example of using this module

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 1.1
aws	>= 5.0
random	>= 2.2

Providers

Name	Version
aws	>= 5.0
random	>= 2.2

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_memorydb_acl.default	resource
aws_memorydb_cluster.default	resource
aws_memorydb_parameter_group.default	resource
aws_memorydb_subnet_group.default	resource
aws_memorydb_user.admin	resource
aws_ssm_parameter.admin_password	resource
random_password.password	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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 tagsand therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
additional_users	List of additional users to create for the MemoryDB cluster	`list(string)`	`[]`	no
admin_password	The password for the MemoryDB user. If empty, a random password will be generated.	`string`	`""`	no
admin_username	The username for the MemoryDB admin	`string`	`"admin"`	no
attributes	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 theend of the list. The elements of the list are joined by the `delimiter`and treated as a single ID element.	`list(string)`	`[]`	no
auto_minor_version_upgrade	Indicates that minor engine upgrades will be applied automatically to the cluster during the maintenance window	`bool`	`true`	no
context	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.	`any`	{ "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}	no
create_admin_user	Indicates whether to create an admin user for the MemoryDB cluster	`bool`	`true`	no
delimiter	Delimiter to be used between ID elements.Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	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 beidentical to how they appear in `id`.Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
engine_version	The version of the Redis engine to use	`string`	`"6.2"`	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
id_length_limit	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`.	`number`	`null`	no
label_key_case	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`.	`string`	`null`	no
label_order	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.	`list(string)`	`null`	no
label_value_case	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`.	`string`	`null`	no
labels_as_tags	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.	`set(string)`	[ "default"]	no
maintenance_window	The weekly time range during which system maintenance can occur	`string`	`null`	no
name	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.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
node_type	Node type for the MemoryDB cluster	`string`	`"db.r6g.large"`	no
num_replicas_per_shard	The number of replicas per shard	`number`	`1`	no
num_shards	The number of shards in the cluster	`number`	`1`	no
parameter_group_family	The name of the parameter group family	`string`	`"memorydb_redis6"`	no
parameter_group_name	The name of the parameter group to associate with this cluster.	`string`	`null`	no
parameters	Key-value mapping of parameters to apply to the parameter group	`map(string)`	`{}`	no
port	The port on which the cluster accepts connections	`number`	`6379`	no
regex_replace_chars	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.	`string`	`null`	no
security_group_ids	List of security group IDs to associate with the MemoryDB cluster	`list(string)`	`[]`	no
snapshot_arns	List of ARNs for the snapshots to be restored. NOTE: destroys the existing cluster. Use for restoring.	`list(string)`	`[]`	no
snapshot_retention_limit	The number of days for which MemoryDB retains automatic snapshots before deleting them	`number`	`null`	no
snapshot_window	The daily time range during which MemoryDB begins taking daily snapshots	`string`	`null`	no
sns_topic_arn	The ARN of the SNS topic to send notifications to	`string`	`null`	no
ssm_kms_key_id	The KMS key ID to use for SSM parameter encryption. If not specified, the default key will be used.	`string`	`null`	no
ssm_parameter_name	The name of the SSM parameter to store the password in. If not specified, the password will not be stored.	`string`	`""`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
subnet_ids	List of subnet IDs for the MemoryDB cluster. Leave empty to use the default VPC subnets.	`list(string)`	`[]`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
tls_enabled	Indicates whether Transport Layer Security (TLS) encryption is enabled for the cluster	`bool`	`true`	no

Outputs

Name	Description
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

Related Projects

Check out these related projects.

terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.
terraform-aws-security-group - Terraform module to create an AWS Security Group along with a set of Security Group Rules.

References

For additional context, refer to some of these links.

Cloud Posse Documentation - The Cloud Posse Developer Hub (documentation)
AWS MemoryDB resources - AWS MemoryDB resources
Vector search announcement for MemoryDB - AWS announces general availability for vector search with MemoryDB
Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support.

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.

Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.