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
Copy file name to clipboardExpand all lines: README.md
+70-29Lines changed: 70 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,6 @@
2
2
3
3
A Terraform module to create an AWS Redis ElastiCache cluster
4
4
5
-
## Resources created
6
-
7
-
8
5
## Terraform versions
9
6
10
7
Terraform 0.12. Pin module version to `~> v1.0`. Submit pull-requests to `master` branch.
@@ -14,8 +11,39 @@ Terraform 0.12. Pin module version to `~> v1.0`. Submit pull-requests to `master
14
11
```hcl
15
12
module "redis" {
16
13
source = "umotif-public/elasticache-redis/aws"
17
-
version = "~> 1.0"
14
+
version = "~> 1.0.0"
15
+
16
+
name_prefix = "core-example"
17
+
number_cache_clusters = 2
18
+
node_type = "cache.t3.small"
19
+
20
+
engine_version = "5.0.6"
21
+
port = 6379
22
+
maintenance_window = "mon:03:00-mon:04:00"
23
+
snapshot_window = "04:00-06:00"
24
+
snapshot_retention_limit = 7
25
+
26
+
automatic_failover_enabled = true
27
+
28
+
at_rest_encryption_enabled = true
29
+
transit_encryption_enabled = true
30
+
auth_token = "1234567890asdfghjkl"
31
+
32
+
apply_immediately = true
33
+
family = "redis5.0"
34
+
description = "Test elasticache redis."
18
35
36
+
subnet_ids = module.vpc.private_subnets
37
+
vpc_id = module.vpc.vpc_id
38
+
39
+
ingress_cidr_blocks = ["0.0.0.0/0"]
40
+
41
+
parameter = [
42
+
{
43
+
name = "repl-backlog-size"
44
+
value = "16384"
45
+
}
46
+
]
19
47
20
48
tags = {
21
49
Project = "Test"
@@ -36,34 +64,44 @@ Module is to be used with Terraform > 0.12.
36
64
Module managed by [Marcin Cuber](https://github.com/marcincuber)[linkedin](https://www.linkedin.com/in/marcincuber/).
37
65
38
66
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
67
+
## Requirements
68
+
69
+
No requirements.
70
+
71
+
## Providers
72
+
73
+
| Name | Version |
74
+
|------|---------|
75
+
| aws | n/a |
76
+
39
77
## Inputs
40
78
41
79
| Name | Description | Type | Default | Required |
42
-
|------|-------------|:----:|:-----:|:-----:|
43
-
| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. | bool |`"false"`| no |
44
-
| at\_rest\_encryption\_enabled | Whether to enable encryption at rest. | bool |`"true"`| no |
45
-
| auth\_token | The password used to access a password protected server. Can be specified only if `transit\_encryption\_enabled = true`. | string |`""`| no |
46
-
| auto\_minor\_version\_upgrade || string |`"true"`| no |
47
-
| automatic\_failover\_enabled | Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. | bool |`"true"`| no |
48
-
| description | The description of the all resources. | string |`"Managed by Terraform"`| no |
49
-
| engine\_version | The version number of the cache engine to be used for the cache clusters in this replication group. | string |`"5.0.6"`| no |
50
-
| family | The family of the ElastiCache parameter group. | string |`"redis5.0"`| no |
51
-
| ingress\_cidr\_blocks | List of Ingress CIDR blocks. | list(string) |`[]`| no |
52
-
| kms\_key\_id | The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at\_rest\_encryption\_enabled = true`| string |`""`| no |
53
-
| maintenance\_window | Specifies the weekly time range for when maintenance on the cache cluster is performed. | string |`""`| no |
54
-
| name\_prefix | The replication group identifier. This parameter is stored as a lowercase string. | string | n/a | yes |
55
-
| node\_type | The compute and memory capacity of the nodes in the node group. | string | n/a | yes |
56
-
| 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 |`""`| no |
57
-
| number\_cache\_clusters | The number of cache clusters \(primary and replicas\) this replication group will have. | number | n/a | yes |
58
-
| parameter | A list of Redis parameters to apply. Note that parameters may differ from one Redis family to another | object |`[]`| no |
59
-
| port | The port number on which each of the cache nodes will accept connections. | number |`"6379"`| no |
60
-
| security\_group\_ids | List of Security Groups. | list(string) |`[]`| no |
61
-
| snapshot\_retention\_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. | number |`"30"`| no |
62
-
| snapshot\_window | The daily time range \(in UTC\) during which ElastiCache will begin taking a daily snapshot of your cache cluster. | string |`""`| no |
63
-
| subnet\_ids | List of VPC Subnet IDs for the cache subnet group. | list(string) | n/a | yes |
64
-
| tags | A mapping of tags to assign to all resources. | map(string) |`{}`| no |
65
-
| transit\_encryption\_enabled | Whether to enable encryption in transit. | bool |`"true"`| no |
66
-
| vpc\_id | VPC Id to associate with Redis ElastiCache. | string | n/a | yes |
| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. |`bool`|`false`| no |
82
+
| at\_rest\_encryption\_enabled | Whether to enable encryption at rest. |`bool`|`true`| no |
83
+
| auth\_token | The password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`. |`string`|`""`| no |
84
+
| auto\_minor\_version\_upgrade |n/a|`string`|`true`| no |
85
+
| automatic\_failover\_enabled | Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. |`bool`|`true`| no |
86
+
| description | The description of the all resources. |`string`|`"Managed by Terraform"`| no |
87
+
| engine\_version | The version number of the cache engine to be used for the cache clusters in this replication group. |`string`|`"5.0.6"`| no |
88
+
| family | The family of the ElastiCache parameter group. |`string`|`"redis5.0"`| no |
89
+
| ingress\_cidr\_blocks | List of Ingress CIDR blocks. |`list(string)`|`[]`| no |
90
+
| kms\_key\_id | The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true`|`string`|`""`| no |
91
+
| maintenance\_window | Specifies the weekly time range for when maintenance on the cache cluster is performed. |`string`|`""`| no |
92
+
| name\_prefix | The replication group identifier. This parameter is stored as a lowercase string. |`string`| n/a | yes |
93
+
| node\_type | The compute and memory capacity of the nodes in the node group. |`string`| n/a | yes |
94
+
| 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`|`""`| no |
95
+
| number\_cache\_clusters | The number of cache clusters (primary and replicas) this replication group will have. |`number`| n/a | yes |
96
+
| parameter | A list of Redis parameters to apply. Note that parameters may differ from one Redis family to another |<pre>list(object({<br> name = string<br> value = string<br> }))</pre>|`[]`| no |
97
+
| port | The port number on which each of the cache nodes will accept connections. |`number`|`6379`| no |
98
+
| security\_group\_ids | List of Security Groups. |`list(string)`|`[]`| no |
99
+
| snapshot\_retention\_limit | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. |`number`|`30`| no |
100
+
| snapshot\_window | The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. |`string`|`""`| no |
101
+
| subnet\_ids | List of VPC Subnet IDs for the cache subnet group. |`list(string)`| n/a | yes |
102
+
| tags | A mapping of tags to assign to all resources. |`map(string)`|`{}`| no |
103
+
| transit\_encryption\_enabled | Whether to enable encryption in transit. |`bool`|`true`| no |
104
+
| vpc\_id | VPC Id to associate with Redis ElastiCache. |`string`| n/a | yes |
0 commit comments