You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A Terraform module to create a Redis ElastiCache cluster.
2
-
===========
1
+
# A Terraform module to create a Redis ElastiCache cluster
3
2
4
3
A terraform module providing a Redis ElastiCache cluster in AWS.
5
4
@@ -8,31 +7,7 @@ This module
8
7
- Creates Redis ElastiCache clusters
9
8
- Creates, manages, and exports a security group
10
9
11
-
----------------------
12
-
#### Required
13
-
-`env` - env to deploy into, should typically be dev/staging/prod
14
-
-`name` - Name for the Redis replication group i.e. UserObject
15
-
-`redis_clusters` - Number of Redis cache clusters (nodes) to create
16
-
-`subnets` - List of VPC Subnet IDs for the cache subnet group
17
-
-`vpc_id` - VPC ID
18
-
19
-
20
-
#### Optional
21
-
22
-
-`apply_immediately` - Specifies whether any modifications are applied immediately, or during the next maintenance window. Defaults to false.
23
-
-`allowed_cidr` - A list of Security Group ID's to allow access to. Defaults to localhost.
24
-
-`allowed_security_groups` - A list of Security Group ID's to allow access to. Defaults to empty list.
25
-
-`redis_failover` - Defaults to false. For failover to work, node type must larger than t2, and redis_cluster must be greater than 1.
26
-
-`redis_node_type` - Instance type to use for creating the Redis cache clusters. Defaults to cache.m3.medium.
27
-
-`redis_port` - Defaults to 6379.
28
-
-`redis_version` - Redis version to use, defaults to 3.2.10.
29
-
-`redis_parameters` - The additional parameters modifyed in parameter group.
30
-
-`redis_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.
31
-
-`redis_snapshot_window` - 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.
32
-
-`redis_snapshot_retention_limit` - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro or cache.t2.* cache nodes.
33
-
34
-
Usage
35
-
-----
10
+
## Usage
36
11
37
12
```hcl
38
13
module "redis" {
@@ -46,8 +21,7 @@ module "redis" {
46
21
}
47
22
```
48
23
49
-
Usage with redis_parameters
50
-
-----
24
+
## Usage with redis_parameters
51
25
52
26
```hcl
53
27
variable "redis_parameters" {
@@ -72,24 +46,46 @@ module "redis" {
72
46
}
73
47
```
74
48
75
-
Outputs
76
-
=======
77
-
78
-
-`redis_security_group_id`
79
-
-`parameter_group`
80
-
-`redis_subnet_group_name`
81
-
-`redis_subnet_group_ids`
82
-
-`id`
83
-
-`port`
84
-
-`endpoint`
85
-
86
-
87
-
Authors
88
-
=======
89
-
90
-
[Tim Hartmann](https://github.com/tfhartmann)
91
-
92
-
License
93
-
=======
49
+
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
50
+
## Inputs
51
+
52
+
| Name | Description | Type | Default | Required |
53
+
|------|-------------|:----:|:-----:|:-----:|
54
+
| allowed\_cidr | A list of Security Group ID's to allow access to. | list |`[ "127.0.0.1/32" ]`| no |
55
+
| allowed\_security\_groups | A list of Security Group ID's to allow access to. | list |`[]`| no |
56
+
| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. | string |`"false"`| no |
57
+
| env | env to deploy into, should typically dev/staging/prod | string | n/a | yes |
58
+
| name | Name for the Redis replication group i.e. UserObject | string | n/a | yes |
59
+
| redis\_clusters | Number of Redis cache clusters (nodes) to create | string | n/a | yes |
60
+
| redis\_failover || string |`"false"`| no |
61
+
| redis\_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 | string |`"fri:08:00-fri:09:00"`| no |
62
+
| redis\_node\_type | Instance type to use for creating the Redis cache clusters | string |`"cache.m3.medium"`| no |
63
+
| redis\_parameters | additional parameters modifyed in parameter group | list |`[]`| no |
64
+
| redis\_port || string |`"6379"`| no |
65
+
| redis\_snapshot\_retention\_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot_retention_limit is not supported on cache.t1.micro or cache.t2.* cache nodes | string |`"0"`| no |
66
+
| redis\_snapshot\_window | 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 | string |`"06:30-07:30"`| no |
67
+
| redis\_version | Redis version to use, defaults to 3.2.10 | string |`"3.2.10"`| no |
68
+
| subnets | List of VPC Subnet IDs for the cache subnet group | list | n/a | yes |
69
+
| tags | Tags for redis nodes | map |`{}`| no |
70
+
| vpc\_id | VPC ID | string | n/a | yes |
71
+
72
+
## Outputs
73
+
74
+
| Name | Description |
75
+
|------|-------------|
76
+
| endpoint ||
77
+
| id ||
78
+
| parameter\_group ||
79
+
| port ||
80
+
| redis\_security\_group\_id ||
81
+
| redis\_subnet\_group\_name ||
82
+
83
+
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
84
+
85
+
## Authors
86
+
87
+
Created by [Tim Hartmann](https://github.com/tfhartmann). Maintained by [Anton Babenko](https://github.com/antonbabenko) and [these awesome contributors](https://github.com/terraform-community-modules/tf_aws_elasticache_redis/graphs/contributors).
0 commit comments