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!
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.
// Generate a random string for auth token, no special chars
resource "random_string" "auth_token" {
length = 64
special = false
}
module "example_redis" {
source = "git::https://github.com/cloudposse/terraform-aws-elasticache-redis.git?ref=master"
namespace = "eg"
stage = "dev"
name = "redis"
zone_id = var.route53_zone_id
security_groups = [var.security_group_id]
auth_token = random_string.auth_token.result
vpc_id = var.vpc_id
subnets = var.private_subnets
maintenance_window = "wed:03:00-wed:04:00"
cluster_size = 2
instance_type = "cache.t2.micro"
engine_version = "4.0.10"
alarm_cpu_threshold_percent = var.cache_alarm_cpu_threshold_percent
alarm_memory_threshold_bytes = var.cache_alarm_memory_threshold_bytes
apply_immediately = true
availability_zones = var.availability_zones
automatic_failover = false
}
output "auth_token" {
value = random_string.auth_token.result
}Review the complete example to see how to use this module.
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| 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 |
| 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 | `` | no |
| automatic_failover | Automatic failover (Not available for T1/T2 instances) | bool | false |
no |
| availability_zones | Availability zone IDs | list(string) | <list> |
no |
| cluster_size | Count of nodes in cluster | number | 1 |
no |
| delimiter | Delimiter between name, namespace, stage and attributes |
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 |
| 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 |
| security_groups | A list of security group IDs that are allowed ingress to the cluster | list(string) | <list> |
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 |
| vpc_id | VPC ID | string | - | yes |
| zone_id | Route53 DNS Zone ID | string | `` | no |
| Name | Description |
|---|---|
| host | Redis host |
| id | Redis cluster ID |
| port | Redis port |
| security_group_id | Security group ID |
Got a question?
File a GitHub issue, send us an email or join our Slack Community.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
- Questions. We'll use a Shared Slack channel between your team and ours.
- Troubleshooting. We'll help you triage why things aren't working.
- Code Reviews. We'll review your Pull Requests and provide constructive feedback.
- Bug Fixes. We'll rapidly work to fix any bugs in our projects.
- Build New Terraform Modules. We'll develop original modules to provision infrastructure.
- Cloud Architecture. We'll assist with your cloud strategy and design.
- Implementation. We'll provide hands-on support to implement our reference architectures.
Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.
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.
Signup 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.
Please use the issue tracker to report any bugs or file feature requests.
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 © 2017-2019 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Igor Rodionov |
 Andriy Knysh |
 Daren Desjardins |
 Max Moon |
 Christopher Riley |
|---|