Awesome

Terraform module to provision an ElastiCache Memcached Cluster

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Usage

For a complete example, see examples/complete.

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

  provider "aws" {
    region = var.region
  }

  module "this" {
    source  = "cloudposse/label/null"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
  }

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

    cidr_block = "172.16.0.0/16"

    context = module.this.context
  }

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

    availability_zones   = var.availability_zones
    vpc_id               = module.vpc.vpc_id
    igw_id               = module.vpc.igw_id
    cidr_block           = module.vpc.vpc_cidr_block
    nat_gateway_enabled  = true
    nat_instance_enabled = false

    context = module.this.context
  }

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

    availability_zones      = var.availability_zones
    vpc_id                  = module.vpc.vpc_id
    allowed_security_groups = [module.vpc.vpc_default_security_group_id]
    subnets                 = module.subnets.private_subnet_ids
    cluster_size            = var.cluster_size
    instance_type           = var.instance_type
    engine_version          = var.engine_version
    apply_immediately       = true
    zone_id                 = var.zone_id

    elasticache_parameter_group_family = var.elasticache_parameter_group_family

    context = module.this.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.

Examples

Review the complete example to see how to use 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
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 5.16
<a name="requirement_null"></a> null	>= 3.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 5.16
<a name="provider_null"></a> null	>= 3.0

Modules

Name	Source	Version
<a name="module_aws_security_group"></a> aws_security_group	cloudposse/security-group/aws	2.2.0
<a name="module_dns"></a> dns	cloudposse/route53-cluster-hostname/aws	0.13.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_metric_alarm.cache_cpu	resource
aws_cloudwatch_metric_alarm.cache_memory	resource
aws_elasticache_cluster.default	resource
aws_elasticache_parameter_group.default	resource
aws_elasticache_subnet_group.default	resource
null_resource.cluster_urls	resource

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_security_group_rules"></a> additional_security_group_rules	A list of Security Group rule objects to add to the created security group, in addition to the ones<br/>this module normally creates. (To suppress the module's rules, set `create_security_group` to false<br/>and supply your own security group via `associated_security_group_ids`.)<br/>The keys and values of the objects are fully compatible with the `aws_security_group_rule` resource, except<br/>for `security_group_id` which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.<br/>To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .	`list(any)`	`[]`	no
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_alarm_actions"></a> alarm_actions	Alarm actions	`list(string)`	`[]`	no
<a name="input_alarm_cpu_threshold_percent"></a> alarm_cpu_threshold_percent	CPU threshold alarm level	`number`	`75`	no
<a name="input_alarm_memory_threshold_bytes"></a> alarm_memory_threshold_bytes	Alarm memory threshold bytes	`number`	`10000000`	no
<a name="input_allow_all_egress"></a> allow_all_egress	If `true`, the created security group will allow egress on all ports and protocols to all IP address.<br/>If this is false and no egress rules are otherwise specified, then no egress will be allowed.	`bool`	`true`	no
<a name="input_allowed_cidr_blocks"></a> allowed_cidr_blocks	A list of IPv4 CIDRs to allow access to the security group created by this module.<br/>The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
<a name="input_allowed_ipv6_cidr_blocks"></a> allowed_ipv6_cidr_blocks	A list of IPv6 CIDRs to allow access to the security group created by this module.<br/>The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
<a name="input_allowed_ipv6_prefix_list_ids"></a> allowed_ipv6_prefix_list_ids	A list of IPv6 Prefix Lists IDs to allow access to the security group created by this module.<br/>The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
<a name="input_allowed_security_group_ids"></a> allowed_security_group_ids	A list of IDs of Security Groups to allow access to the security group created by this module.<br/>The length of this list must be known at "plan" time.	`list(string)`	`[]`	no
<a name="input_allowed_security_groups"></a> allowed_security_groups	DEPRECATED: Use `allowed_security_group_ids` instead.	`list(string)`	`[]`	no
<a name="input_apply_immediately"></a> apply_immediately	Specifies whether any database modifications are applied immediately, or during the next maintenance window	`bool`	`true`	no
<a name="input_associated_security_group_ids"></a> associated_security_group_ids	A list of IDs of Security Groups to associate the created resource with, in addition to the created security group.<br/>These security groups will not be modified and, if `create_security_group` is `false`, must have rules providing the desired access.	`list(string)`	`[]`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_availability_zone"></a> availability_zone	The Availability Zone of the cluster. az_mode must be set to single-az when used.	`string`	`""`	no
<a name="input_availability_zones"></a> availability_zones	List of Availability Zones for the cluster. az_mode must be set to cross-az when used.	`list(string)`	`[]`	no
<a name="input_az_mode"></a> az_mode	Enable or disable multiple AZs, eg: single-az or cross-az	`string`	`"single-az"`	no
<a name="input_cloudwatch_metric_alarms_enabled"></a> cloudwatch_metric_alarms_enabled	Boolean flag to enable/disable CloudWatch metrics alarms	`bool`	`false`	no
<a name="input_cluster_size"></a> cluster_size	Cluster size	`number`	`1`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_create_security_group"></a> create_security_group	Set `true` to create and configure a new security group. If false, `associated_security_group_ids` must be provided.	`bool`	`true`	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_dns_subdomain"></a> dns_subdomain	The subdomain to use for the CNAME record. If not provided then the CNAME record will use var.name.	`string`	`""`	no
<a name="input_elasticache_parameter_group_family"></a> elasticache_parameter_group_family	ElastiCache parameter group family	`string`	`"memcached1.5"`	no
<a name="input_elasticache_subnet_group_name"></a> elasticache_subnet_group_name	Subnet group name for the ElastiCache instance	`string`	`""`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_engine_version"></a> engine_version	Memcached engine version. For more info, see https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/supported-engine-versions.html	`string`	`"1.5.16"`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_existing_security_groups"></a> existing_security_groups	DEPRECATED: Use `associated_security_group_ids` instead.<br/>Historical description: List of existing Security Group IDs to place the cluster into.<br/>Set `use_existing_security_groups` to `true` to enable using `existing_security_groups` as Security Groups for the cluster.	`list(string)`	`[]`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_instance_type"></a> instance_type	Elastic cache instance type	`string`	`"cache.t2.micro"`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_maintenance_window"></a> maintenance_window	Maintenance window	`string`	`"wed:03:00-wed:04:00"`	no
<a name="input_max_item_size"></a> max_item_size	Max item size	`number`	`10485760`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> 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
<a name="input_network_type"></a> network_type	The network type of the cluster. Valid values: ipv4, ipv6, dual_stack.	`string`	`"ipv4"`	no
<a name="input_notification_topic_arn"></a> notification_topic_arn	Notification topic arn	`string`	`""`	no
<a name="input_port"></a> port	Memcached port	`number`	`11211`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_security_group_create_before_destroy"></a> security_group_create_before_destroy	Set `true` to enable Terraform `create_before_destroy` behavior on the created security group.<br/>We only recommend setting this `false` if you are upgrading this module and need to keep<br/>the existing security group from being replaced.<br/>Note that changing this value will always cause the security group to be replaced.	`bool`	`true`	no
<a name="input_security_group_create_timeout"></a> security_group_create_timeout	How long to wait for the security group to be created.	`string`	`"10m"`	no
<a name="input_security_group_delete_timeout"></a> security_group_delete_timeout	How long to retry on `DependencyViolation` errors during security group deletion.	`string`	`"15m"`	no
<a name="input_security_group_description"></a> security_group_description	The description to assign to the created Security Group.<br/>Warning: Changing the description causes the security group to be replaced.	`string`	`"Security group for Elasticache Memcached"`	no
<a name="input_security_group_name"></a> security_group_name	The name to assign to the created security group. Must be unique within the VPC.<br/>If not provided, will be derived from the `null-label.context` passed in.<br/>If `create_before_destroy` is true, will be used as a name prefix.	`list(string)`	`[]`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_subnets"></a> subnets	AWS subnet ids	`list(string)`	`[]`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_transit_encryption_enabled"></a> transit_encryption_enabled	Boolean flag to enable transit encryption (requires Memcached version 1.6.12+)	`bool`	`false`	no
<a name="input_use_existing_security_groups"></a> use_existing_security_groups	DEPRECATED: Use `create_security_group` instead.<br/>Historical description: Flag to enable/disable creation of Security Group in the module.<br/>Set to `true` to disable Security Group creation and provide a list of existing security Group IDs in `existing_security_groups` to place the cluster into.<br/>Historical default: `false`	`bool`	`null`	no
<a name="input_vpc_id"></a> vpc_id	VPC ID	`string`	`""`	no
<a name="input_zone_id"></a> zone_id	Route53 DNS Zone ID	`string`	`""`	no

Outputs

Name	Description
<a name="output_cluster_address"></a> cluster_address	Cluster address
<a name="output_cluster_configuration_endpoint"></a> cluster_configuration_endpoint	Cluster configuration endpoint
<a name="output_cluster_id"></a> cluster_id	Cluster ID
<a name="output_cluster_urls"></a> cluster_urls	Cluster URLs
<a name="output_hostname"></a> hostname	Cluster hostname
<a name="output_security_group_arn"></a> security_group_arn	The ARN of the created security group
<a name="output_security_group_id"></a> security_group_id	The ID of the created security group
<a name="output_security_group_name"></a> security_group_name	The name of the created security group

Related Projects

Check out these related projects.

terraform-aws-elasticache-redis - Terraform module to provision an ElastiCache Redis Cluster
terraform-aws-elasticache-cloudwatch-sns-alarms - Terraform module that configures CloudWatch SNS alerts for ElastiCache

[!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. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticache-memcached&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
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.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticache-memcached&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

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.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticache-memcached&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ 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 <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-elasticache-memcached&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

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

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

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.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.