terraform-aws-elasticache-redis

Terraform module to provision an ElastiCache Redis Cluster

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

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 "vpc" {
    source     = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.8.1"
    namespace  = var.namespace
    stage      = var.stage
    name       = var.name
    cidr_block = "172.16.0.0/16"
  }

  module "subnets" {
    source               = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=tags/0.18.1"
    availability_zones   = var.availability_zones
    namespace            = var.namespace
    stage                = var.stage
    name                 = var.name
    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
  }

  module "redis" {
    source                     = "git::https://github.com/cloudposse/terraform-aws-elasticache-redis.git?ref=master"
    availability_zones         = var.availability_zones
    namespace                  = var.namespace
    stage                      = var.stage
    name                       = var.name
    zone_id                    = var.zone_id
    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
    apply_immediately          = true
    automatic_failover         = false
    engine_version             = var.engine_version
    family                     = var.family
    at_rest_encryption_enabled = var.at_rest_encryption_enabled
    transit_encryption_enabled = var.transit_encryption_enabled

    parameter = [
      {
        name  = "notify-keyspace-events"
        value = "lK"
      }
    ]
  }

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

Inputs

Name	Description	Type	Default	Required
alarm_actions	Alarm action list	list(string)	`<list>`	no
alarm_cpu_threshold_percent	CPU threshold alarm level	number	`75`	no
alarm_memory_threshold_bytes	Ram threshold alarm level	number	`10000000`	no
allowed_cidr_blocks	List of CIDR blocks that are allowed ingress to the cluster's Security Group created in the module	list(string)	`<list>`	no
allowed_security_groups	List of Security Group IDs that are allowed ingress to the cluster's Security Group created in the module	list(string)	`<list>`	no
apply_immediately	Apply changes immediately	bool	`true`	no
at_rest_encryption_enabled	Enable encryption at rest	bool	`false`	no
attributes	Additional attributes (e.g. "1")	list(string)	`<list>`	no
auth_token	Auth token for password protecting redis, `transit_encryption_enabled` must be set to `true`. Password must be longer than 16 chars	string	`null`	no
automatic_failover_enabled	Automatic failover (Not available for T1/T2 instances)	bool	`false`	no
availability_zones	Availability zone IDs	list(string)	`<list>`	no
cluster_mode_enabled	Flag to enable/disable creation of a native redis cluster. `automatic_failover_enabled` must be set to `true`. Only 1 `cluster_mode` block is allowed	bool	`false`	no
cluster_mode_num_node_groups	Number of node groups (shards) for this Redis replication group. Changing this number will trigger an online resizing operation before other settings modifications	number	`0`	no
cluster_mode_replicas_per_node_group	Number of replica nodes in each node group. Valid values are 0 to 5. Changing this number will force a new resource	number	`0`	no
cluster_size	Number of nodes in cluster. Ignored when `cluster_mode_enabled` == `true`	number	`1`	no
delimiter	Delimiter between `name`, `namespace`, `stage` and `attributes`	string	`-`	no
dns_subdomain	The subdomain to use for the CNAME record. If not provided then the CNAME record will use var.name.	string	``	no
elasticache_subnet_group_name	Subnet group name for the ElastiCache instance	string	``	no
enabled	Set to false to prevent the module from creating any resources	bool	`true`	no
engine_version	Redis engine version	string	`4.0.10`	no
existing_security_groups	List of existing Security Group IDs to place the cluster into. Set `use_existing_security_groups` to `true` to enable using `existing_security_groups` as Security Groups for the cluster	list(string)	`<list>`	no
family	Redis family	string	`redis4.0`	no
instance_type	Elastic cache instance type	string	`cache.t2.micro`	no
maintenance_window	Maintenance window	string	`wed:03:00-wed:04:00`	no
name	Name of the application	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	``	no
notification_topic_arn	Notification topic arn	string	``	no
ok_actions	The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN)	list(string)	`<list>`	no
parameter	A list of Redis parameters to apply. Note that parameters may differ from one Redis family to another	object	`<list>`	no
port	Redis port	number	`6379`	no
replication_group_id	Replication group ID with the following constraints: A name must contain from 1 to 20 alphanumeric characters or hyphens. The first character must be a letter. A name cannot end with a hyphen or contain two consecutive hyphens.	string	``	no
snapshot_retention_limit	The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them.	number	`0`	no
snapshot_window	The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.	string	`06:30-07:30`	no
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	``	no
subnets	Subnet IDs	list(string)	`<list>`	no
tags	Additional tags (e.g. map("BusinessUnit","ABC")	map(string)	`<map>`	no
transit_encryption_enabled	Enable TLS	bool	`true`	no
use_existing_security_groups	Flag to enable/disable creation of Security Group in the module. 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	bool	`false`	no
vpc_id	VPC ID	string	-	yes
zone_id	Route53 DNS Zone ID	string	``	no

Outputs

Name	Description
endpoint	Redis primary endpoint
host	Redis hostname
id	Redis cluster ID
port	Redis port
security_group_id	Security group ID

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

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.

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

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

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!

Copyright

License

See LICENSE for full details.

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.