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
+9-25Lines changed: 9 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -207,26 +207,19 @@ Here are some examples of how you can use this module in your inventory structur
207
207
| alias | The display name of the alias. The name must start with the word `alias` followed by a forward slash. |`string`|`"alias/redis"`| no |
208
208
| allowed\_ip | List of allowed ip. |`list(any)`|`[]`| no |
209
209
| allowed\_ports | List of allowed ingress ports |`list(any)`|`[]`| no |
210
-
| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. |`bool`|`false`| no |
211
-
| at\_rest\_encryption\_enabled | Enable encryption at rest. |`bool`|`true`| no |
212
-
| auth\_token | The password used to access a password protected server. Can be specified only if transit\_encryption\_enabled = true. |`string`|`null`| no |
213
-
| auto\_minor\_version\_upgrade | Specifies whether a minor engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Defaults to true. |`bool`|`true`| no |
214
-
| automatic\_failover\_enabled | Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group. Must be enabled for Redis (cluster mode enabled) replication groups. Defaults to false. |`bool`|`true`| no |
210
+
| auth\_token | The password used to access a password protected server. Can be specified only if transit\_encryption\_enabled = true. Find auto generated auth\_token in terraform.tfstate or in AWS SSM Parameter Store. |`string`|`null`| no |
211
+
| auth\_token\_enable | Flag to specify whether to create auth token (password) protected cluster. Can be specified only if transit\_encryption\_enabled = true. |`bool`|`true`| no |
215
212
| availability\_zones | A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important. |`list(string)`| n/a | yes |
216
213
| az\_mode | (Memcached only) Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are single-az or cross-az, default is single-az. If you want to choose cross-az, num\_cache\_nodes must be greater than 1. |`string`|`"single-az"`| no |
217
214
| cluster\_enabled | (Memcache only) Enabled or disabled cluster. |`bool`|`false`| no |
218
215
| cluster\_replication\_enabled | (Redis only) Enabled or disabled replication\_group for redis cluster. |`bool`|`false`| no |
219
216
| customer\_master\_key\_spec | Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: SYMMETRIC\_DEFAULT, RSA\_2048, RSA\_3072, RSA\_4096, ECC\_NIST\_P256, ECC\_NIST\_P384, ECC\_NIST\_P521, or ECC\_SECG\_P256K1. Defaults to SYMMETRIC\_DEFAULT. |`string`|`"SYMMETRIC_DEFAULT"`| no |
220
217
| deletion\_window\_in\_days | Duration in days after which the key is deleted after destruction of the resource. |`number`|`7`| no |
221
-
| dns\_record\_name | The name of the record. |`string`|`""`| no |
222
218
| egress\_rule | Enable to create egress rule |`bool`|`true`| no |
223
219
| enable | Enable or disable of elasticache |`bool`|`true`| no |
224
220
| enable\_key\_rotation | Specifies whether key rotation is enabled. |`string`|`true`| no |
225
221
| enable\_security\_group | Enable default Security Group with only Egress traffic allowed. |`bool`|`true`| no |
226
-
| engine | The name of the cache engine to be used for the clusters in this replication group. e.g. redis. |`string`|`""`| no |
227
-
| engine\_version | The version number of the cache engine to be used for the cache clusters in this replication group. |`string`|`""`| no |
| existing\_sg\_id | Provide existing security group id for updating existing rule |`string`|`null`| no |
230
223
| extra\_tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). |`map(string)`|`{}`| no |
231
224
| is\_enabled | Specifies whether the key is enabled. |`bool`|`true`| no |
232
225
| is\_external | enable to udated existing security Group |`bool`|`false`| no |
@@ -235,51 +228,42 @@ Here are some examples of how you can use this module in your inventory structur
235
228
| kms\_key\_enabled | Specifies whether the kms is enabled or disabled. |`bool`|`true`| no |
236
229
| 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 |
237
230
| kms\_multi\_region | Indicates whether the KMS key is a multi-Region (true) or regional (false) key. |`bool`|`false`| no |
238
-
| label\_order | Label order, e.g. `name`,`application`. |`list(any)`|`[]`| no |
231
+
| label\_order | Label order, e.g. `name`,`application`. |`list(any)`| <pre>[<br> "environment",<br> "name"<br>]</pre> | no |
232
+
| length | n/a |`number`|`25`| no |
239
233
| log\_delivery\_configuration | The log\_delivery\_configuration block allows the streaming of Redis SLOWLOG or Redis Engine Log to CloudWatch Logs or Kinesis Data Firehose. Max of 2 blocks. |`list(map(any))`|`[]`| no |
240
-
| maintenance\_window | Maintenance window. |`string`|`"sun:05:00-sun:06:00"`| no |
241
234
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. |`string`|`"anmol@clouddrove.com"`| no |
242
235
| memcached\_route53\_record\_enabled | Whether to create Route53 record memcached set. |`bool`|`false`| no |
243
236
| memcached\_ssm\_parameter\_endpoint\_enabled | Name of the parameter. |`bool`|`false`| no |
244
-
| multi\_az\_enabled | Specifies whether to enable Multi-AZ Support for the replication group. If true, automatic\_failover\_enabled must also be enabled. Defaults to false. |`bool`|`false`| no |
245
237
| name | Name (e.g. `app` or `cluster`). |`string`|`""`| no |
246
-
| node\_type | The compute and memory capacity of the nodes in the node group. |`string`|`"cache.t2.small"`| no |
247
-
| notification\_topic\_arn | An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. |`string`|`""`| no |
248
-
| num\_cache\_clusters | (Required for Cluster Mode Disabled) The number of cache clusters (primary and replicas) this replication group will have. If Multi-AZ is enabled, the value of this parameter must be at least 2. Updates will occur before other modifications. |`number`|`1`| no |
249
238
| num\_cache\_nodes | (Required unless replication\_group\_id is provided) The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcache, this value must be between 1 and 20. If this number is reduced on subsequent runs, the highest numbered nodes will be removed. |`number`|`1`| no |
250
-
| parameter\_group\_name | The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. |`string`|`"default.redis5.0"`| no |
251
-
| port | the port number on which each of the cache nodes will accept connections. |`string`|`""`| no |
252
239
| protocol | The protocol. If not icmp, tcp, udp, or all use the. |`string`|`"tcp"`| no |
253
-
| replication\_group\_description|Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource. |`string`|`"User-created description for the replication group."`| no |
240
+
| replication\_group |n/a |`map(any)`|`{}`| no |
254
241
| repository | Terraform current module repo |`string`|`"https://github.com/clouddrove/terraform-aws-elasticache"`| no |
255
242
| retention\_in\_days | Specifies the number of days you want to retain log events in the specified log group. |`number`|`0`| no |
243
+
| route53 | Route53 Configurations. |`map(any)`|`{}`| no |
256
244
| route53\_record\_enabled | Whether to create Route53 record set. |`bool`|`false`| no |
257
-
| route53\_ttl | (Required for non-alias records) The TTL of the record. |`string`|`""`| no |
258
-
| route53\_type | The record type. Valid values are A, AAAA, CAA, CNAME, MX, NAPTR, NS, PTR, SOA, SPF, SRV and TXT. |`string`|`""`| no |
259
-
| route53\_zone\_id | Zone ID. |`string`| n/a | yes |
260
245
| security\_group\_names | A list of cache security group names to associate with this replication group. |`list(string)`|`null`| no |
261
246
| sg\_description | The security group description. |`string`|`"Instance default security group (only egress access is allowed)."`| no |
262
247
| sg\_egress\_description | Description of the egress and ingress rule |`string`|`"Description of the rule."`| no |
263
248
| sg\_egress\_ipv6\_description | Description of the egress\_ipv6 rule |`string`|`"Description of the rule."`| no |
264
249
| sg\_ids | of the security group id. |`list(any)`|`[]`| no |
265
250
| sg\_ingress\_description | Description of the ingress rule |`string`|`"Description of the ingress rule use elasticache."`| no |
266
251
| snapshot\_arns | A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. |`list(string)`|`null`| no |
267
-
| snapshot\_name | The name of a snapshot from which to restore data into the new node group. Changing the snapshot\_name forces a new resource. |`string`|`""`| no |
268
-
| snapshot\_retention\_limit | (Redis only) 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 |
269
-
| snapshot\_window | (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. |`string`|`null`| no |
252
+
| special | n/a |`bool`|`false`| no |
270
253
| ssm\_parameter\_description | SSM Parameters can be imported using. |`string`|`"Description of the parameter."`| no |
271
254
| ssm\_parameter\_endpoint\_enabled | Name of the parameter. |`bool`|`false`| no |
272
255
| ssm\_parameter\_type | Type of the parameter. |`string`|`"SecureString"`| no |
273
256
| subnet\_group\_description | Description for the cache subnet group. Defaults to `Managed by Terraform`. |`string`|`"The Description of the ElastiCache Subnet Group."`| no |
274
257
| subnet\_ids | List of VPC Subnet IDs for the cache subnet group. |`list(any)`|`[]`| no |
275
-
|transit\_encryption\_enabled|Whether to enable encryption in transit. |`bool`|`true`| no |
258
+
|user\_group\_ids|User Group ID to associate with the replication group. |`list(string)`|`null`| no |
276
259
| vpc\_id | The ID of the VPC that the instance security group belongs to. |`string`|`""`| no |
277
260
278
261
## Outputs
279
262
280
263
| Name | Description |
281
264
|------|-------------|
282
265
| Memcached\_ssm\_name | A list of all of the parameter values |
0 commit comments