https://github.com/rhythmictech/terraform-aws-elasticache
Terraform ElastiCache Module: Simple and Sensibly Opinionated
https://github.com/rhythmictech/terraform-aws-elasticache
aws elasticache redis terraform terraform-module
Last synced: about 2 months ago
JSON representation
Terraform ElastiCache Module: Simple and Sensibly Opinionated
- Host: GitHub
- URL: https://github.com/rhythmictech/terraform-aws-elasticache
- Owner: rhythmictech
- License: mit
- Created: 2020-05-15T14:17:27.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-21T17:45:48.000Z (almost 3 years ago)
- Last Synced: 2026-04-16T18:18:08.540Z (2 months ago)
- Topics: aws, elasticache, redis, terraform, terraform-module
- Language: HCL
- Homepage: https://registry.terraform.io/modules/rhythmictech/elasticache/aws
- Size: 56.6 KB
- Stars: 1
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# terraform-aws-elasticache
Terraform ElastiCache Module: Simple and Sensibly Opinionated
[](https://github.com/rhythmictech/terraform-aws-elasticache/actions?query=workflow%3Atflint+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-elasticache/actions?query=workflow%3Atfsec+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-elasticache/actions?query=workflow%3Ayamllint+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-elasticache/actions?query=workflow%3Amisspell+event%3Apush+branch%3Amaster)
[](https://github.com/rhythmictech/terraform-aws-elasticache/actions?query=workflow%3Apre-commit-check+event%3Apush+branch%3Amaster)
## Example
Here's what using the module will look like
```terraform
module "example" {
source = "rhythmictech/terraform-aws-elasticache"
version = "0.0.1
}
```
## About
aws.amazon.com/elasticache/
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 0.12.20 |
| [aws](#requirement\_aws) | >= 5 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | 5.10.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_elasticache_cluster.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_cluster) | resource |
| [aws_elasticache_replication_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group) | resource |
| [aws_elasticache_subnet_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_subnet_group) | resource |
| [aws_route53_record.elasticache](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
| [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
| [aws_security_group_rule.egress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
| [aws_security_group_rule.ingress_cidr](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
| [aws_security_group_rule.ingress_sg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [apply\_immediately](#input\_apply\_immediately) | Specifies whether any modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no |
| [auto\_minor\_version\_upgrade](#input\_auto\_minor\_version\_upgrade) | Specifies whether a minor engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. | `bool` | `true` | no |
| [cluster\_size](#input\_cluster\_size) | Number of nodes in Elasticache cluster | `number` | `4` | no |
| [create](#input\_create) | If false, this module does nothing | `bool` | `true` | no |
| [dns\_cname\_record\_name](#input\_dns\_cname\_record\_name) | The name of the record, eg test.example.com. Must be specified with `route53_zone_id` | `string` | `null` | no |
| [egress\_security\_group\_rule\_description](#input\_egress\_security\_group\_rule\_description) | Description for Egress rule | `string` | `null` | no |
| [engine](#input\_engine) | memcached or redis | `string` | `"redis"` | no |
| [engine\_version](#input\_engine\_version) | Elasticache engine version | `string` | `null` | no |
| [ingress\_cidr\_sg\_rule\_description](#input\_ingress\_cidr\_sg\_rule\_description) | Description for CIDR-block Ingress rule | `string` | `null` | no |
| [ingress\_rule\_cidr\_blocks](#input\_ingress\_rule\_cidr\_blocks) | List of CIDR blocks that are allowed ingress to ElastiCache | `list(string)` | `[]` | no |
| [ingress\_sg\_sg\_rule\_description](#input\_ingress\_sg\_sg\_rule\_description) | Description for Security Group Ingress rule | `string` | `null` | no |
| [instance\_type](#input\_instance\_type) | Type of ec2 instance for elasticache | `string` | `"cache.t2.micro"` | no |
| [log\_delivery\_configuration](#input\_log\_delivery\_configuration) | n/a | `list` | `[]` | no |
| [maintenance\_window](#input\_maintenance\_window) | Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: sun:05:00-sun:09:00 | `string` | `"sun:03:00-sun:04:00"` | no |
| [name](#input\_name) | Moniker to apply to all resources in the module | `string` | n/a | yes |
| [notification\_topic\_arn](#input\_notification\_topic\_arn) | An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: arn:aws:sns:us-east-1:012345678999:my\_sns\_topic | `string` | `null` | no |
| [parameter\_group\_name](#input\_parameter\_group\_name) | Elasticache parameter group name | `string` | `null` | no |
| [port](#input\_port) | Elasticache port | `number` | `null` | no |
| [replication\_group\_description](#input\_replication\_group\_description) | Description for ElastiCache Replication Group | `string` | `null` | no |
| [route53\_zone\_id](#input\_route53\_zone\_id) | The ID of the hosted zone to contain this record. | `string` | `""` | no |
| [security\_group\_ids](#input\_security\_group\_ids) | Security Groups that are allowed ingress to ElastiCache | `list(string)` | `[]` | no |
| [snapshot\_window](#input\_snapshot\_window) | (Optional, Redis only) The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: 05:00-09:00 | `string` | `"02:00-03:00"` | no |
| [subnet\_ids](#input\_subnet\_ids) | List of subnet IDs to make Elasticache available on | `list(string)` | n/a | yes |
| [tags](#input\_tags) | User-Defined tags | `map(string)` | `{}` | no |
| [vpc\_id](#input\_vpc\_id) | VPC ID to create cluster in | `string` | n/a | yes |
## Outputs
| Name | Description |
|------|-------------|
| [cluster\_address](#output\_cluster\_address) | (Memcached only) The DNS name of the cache cluster without the port appended. |
| [elasticache\_cluster\_id](#output\_elasticache\_cluster\_id) | ElastiCache cluster ID |
| [elasticache\_fqdn](#output\_elasticache\_fqdn) | Fully Qualified Domain Name of Elasticache: the endpoint or the CNAME if used |
| [elasticache\_replication\_group\_id](#output\_elasticache\_replication\_group\_id) | elasticache\_replication\_group resource |
| [elasticache\_route53\_record\_id](#output\_elasticache\_route53\_record\_id) | aws route53 record resource |
| [primary\_endpoint\_address](#output\_primary\_endpoint\_address) | (Redis only) The address of the endpoint for the primary node in the replication group, if the cluster mode is disabled. |
| [security\_group\_id](#output\_security\_group\_id) | aws\_security\_group resource |
## The Giants underneath this module
- pre-commit.com/
- www.terraform.io/
- github.com/tfutils/tfenv
- github.com/segmentio/terraform-docs