Skip to content

Commit 2c960b8

Browse files
clouddrove-ciclouddrove-ci
committed
update README.md
1 parent 742117c commit 2c960b8

File tree

1 file changed

+65
-52
lines changed

1 file changed

+65
-52
lines changed

‎README.md

Lines changed: 65 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,14 @@
1313

1414
<p align="center">
1515

16-
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/terraform-v1.1.7-green" alt="Terraform">
18-
</a>
19-
<a href="LICENSE.md">
20-
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
16+
<a href="https://github.com/clouddrove/terraform-aws-elasticache/releases/latest">
17+
<img src="https://img.shields.io/github/release/clouddrove/terraform-aws-elasticache.svg" alt="Latest Release">
2118
</a>
2219
<a href="https://github.com/clouddrove/terraform-aws-elasticache/actions/workflows/tfsec.yml">
2320
<img src="https://github.com/clouddrove/terraform-aws-elasticache/actions/workflows/tfsec.yml/badge.svg" alt="tfsec">
2421
</a>
25-
<a href="https://github.com/clouddrove/terraform-aws-elasticache/actions/workflows/terraform.yml">
26-
<img src="https://github.com/clouddrove/terraform-aws-elasticache/actions/workflows/terraform.yml/badge.svg" alt="static-checks">
22+
<a href="LICENSE.md">
23+
<img src="https://img.shields.io/badge/License-APACHE-blue.svg" alt="Licence">
2724
</a>
2825

2926

@@ -74,17 +71,16 @@ Here are some examples of how you can use this module in your inventory structur
7471
module "redis" {
7572
source = "clouddrove/elasticache/aws
7673
version = "1.3.0"
77-
74+
7875
name = "redis"
7976
environment = "test"
8077
label_order = ["name", "environment"]
81-
78+
8279
vpc_id = module.vpc.vpc_id
8380
allowed_ip = [module.vpc.vpc_cidr_block]
8481
allowed_ports = [6379]
85-
82+
8683
cluster_replication_enabled = true
87-
replication_enabled = true
8884
engine = "redis"
8985
engine_version = "7.0"
9086
parameter_group_name = "default.redis7"
@@ -95,41 +91,47 @@ Here are some examples of how you can use this module in your inventory structur
9591
automatic_failover_enabled = false
9692
multi_az_enabled = false
9793
num_cache_clusters = 1
98-
replicas_per_node_group = 1
9994
retention_in_days = 0
10095
snapshot_retention_limit = 7
101-
96+
10297
log_delivery_configuration = [
103-
{
104-
destination_type = "cloudwatch-logs"
105-
log_format = "json"
106-
log_type = "slow-log"
107-
},
108-
{
109-
destination_type = "cloudwatch-logs"
110-
log_format = "json"
111-
log_type = "engine-log"
112-
}
98+
{
99+
destination_type = "cloudwatch-logs"
100+
log_format = "json"
101+
log_type = "slow-log"
102+
},
103+
{
104+
destination_type = "cloudwatch-logs"
105+
log_format = "json"
106+
log_type = "engine-log"
107+
}
113108
]
114109
extra_tags = {
115-
Application = "CloudDrove"
110+
Application = "CloudDrove"
116111
}
112+
route53_record_enabled = true
113+
ssm_parameter_endpoint_enabled = true
114+
dns_record_name = "prod"
115+
route53_ttl = "300"
116+
route53_type = "CNAME"
117+
route53_zone_id = "Z017xxxxDLxxx0GH04"
118+
}
117119
118120
```
119121
### Redis Cluster
120122
```hcl
121123
module "redis-cluster" {
122124
source = "clouddrove/elasticache/aws
123125
version = "1.3.0"
124-
126+
125127
name = "redis-cluster"
126128
environment = "test"
127129
label_order = ["environment", "name"]
128-
130+
129131
vpc_id = module.vpc.vpc_id
130132
allowed_ip = [module.vpc.vpc_cidr_block]
131133
allowed_ports = [6379]
132-
134+
133135
cluster_replication_enabled = true
134136
engine = "redis"
135137
engine_version = "7.0"
@@ -138,42 +140,59 @@ Here are some examples of how you can use this module in your inventory structur
138140
node_type = "cache.t2.micro"
139141
subnet_ids = module.subnets.public_subnet_id
140142
availability_zones = ["eu-west-1a", "eu-west-1b"]
141-
replicas_per_node_group = 2
142143
num_cache_nodes = 1
143144
snapshot_retention_limit = 7
144145
automatic_failover_enabled = true
145146
extra_tags = {
146-
Application = "CloudDrove"
147+
Application = "CloudDrove"
147148
}
149+
150+
route53_record_enabled = false
151+
ssm_parameter_endpoint_enabled = false
152+
dns_record_name = "prod"
153+
route53_ttl = "300"
154+
route53_type = "CNAME"
155+
route53_zone_id = "SERFxxxx6XCsY9Lxxxxx"
156+
}
148157
```
149158
### Memcache
150159
```hcl
151160
module "memcached" {
152161
source = "clouddrove/elasticache/aws
153162
version = "1.3.0"
154-
163+
155164
name = "memcached"
156165
environment = "test"
157166
label_order = ["name", "environment"]
158-
167+
159168
vpc_id = module.vpc.vpc_id
160169
allowed_ip = [module.vpc.vpc_cidr_block]
161170
allowed_ports = [11211]
162-
163-
cluster_enabled = true
164-
engine = "memcached"
165-
engine_version = "1.6.17"
166-
family = "memcached1.5"
167-
parameter_group_name = ""
168-
az_mode = "cross-az"
169-
port = 11211
170-
node_type = "cache.t2.micro"
171-
num_cache_nodes = 2
172-
subnet_ids = module.subnets.public_subnet_id
173-
availability_zones = ["eu-west-1a", "eu-west-1b"]
171+
172+
cluster_enabled = true
173+
memcached_ssm_parameter_endpoint_enabled = true
174+
memcached_route53_record_enabled = true
175+
engine = "memcached"
176+
engine_version = "1.6.17"
177+
family = "memcached1.5"
178+
parameter_group_name = ""
179+
az_mode = "cross-az"
180+
port = 11211
181+
node_type = "cache.t2.micro"
182+
num_cache_nodes = 2
183+
subnet_ids = module.subnets.public_subnet_id
184+
availability_zones = ["eu-west-1a", "eu-west-1b"]
174185
extra_tags = {
175-
Application = "CloudDrove"
186+
Application = "CloudDrove"
176187
}
188+
route53_record_enabled = false
189+
ssm_parameter_endpoint_enabled = false
190+
dns_record_name = "prod"
191+
route53_ttl = "300"
192+
route53_type = "CNAME"
193+
route53_zone_id = "SERFxxxx6XCsY9Lxxxxx"
194+
195+
}
177196
```
178197

179198

@@ -190,7 +209,6 @@ Here are some examples of how you can use this module in your inventory structur
190209
| allowed\_ports | List of allowed ingress ports | `list(any)` | `[]` | no |
191210
| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. | `bool` | `false` | no |
192211
| at\_rest\_encryption\_enabled | Enable encryption at rest. | `bool` | `true` | no |
193-
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
194212
| auth\_token | The password used to access a password protected server. Can be specified only if transit\_encryption\_enabled = true. | `string` | `null` | no |
195213
| 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 |
196214
| 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,7 +228,6 @@ Here are some examples of how you can use this module in your inventory structur
210228
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
211229
| existing\_sg\_id | Provide existing security group id for updating existing rule | `string` | `null` | no |
212230
| extra\_tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(string)` | `{}` | no |
213-
| family | (Required) The family of the ElastiCache parameter group. | `string` | `""` | no |
214231
| is\_enabled | Specifies whether the key is enabled. | `bool` | `true` | no |
215232
| is\_external | enable to udated existing security Group | `bool` | `false` | no |
216233
| key\_usage | Specifies the intended use of the key. Defaults to ENCRYPT\_DECRYPT, and only symmetric encryption and decryption are supported. | `string` | `"ENCRYPT_DECRYPT"` | no |
@@ -233,28 +250,24 @@ Here are some examples of how you can use this module in your inventory structur
233250
| 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 |
234251
| port | the port number on which each of the cache nodes will accept connections. | `string` | `""` | no |
235252
| protocol | The protocol. If not icmp, tcp, udp, or all use the. | `string` | `"tcp"` | no |
236-
| replicas\_per\_node\_group | Replicas per Shard. | `number` | `2` | no |
237253
| replication\_group\_description | Name of either the CloudWatch Logs LogGroup or Kinesis Data Firehose resource. | `string` | `"User-created description for the replication group."` | no |
238-
| replication\_group\_id | The replication group identifier This parameter is stored as a lowercase string. | `string` | `""` | no |
239254
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-elasticache"` | no |
240255
| retention\_in\_days | Specifies the number of days you want to retain log events in the specified log group. | `number` | `0` | no |
241256
| route53\_record\_enabled | Whether to create Route53 record set. | `bool` | `false` | no |
242257
| route53\_ttl | (Required for non-alias records) The TTL of the record. | `string` | `""` | no |
243258
| route53\_type | The record type. Valid values are A, AAAA, CAA, CNAME, MX, NAPTR, NS, PTR, SOA, SPF, SRV and TXT. | `string` | `""` | no |
244259
| route53\_zone\_id | Zone ID. | `string` | n/a | yes |
245-
| security\_group\_names | A list of cache security group names to associate with this replication group. | `any` | `null` | no |
260+
| security\_group\_names | A list of cache security group names to associate with this replication group. | `list(string)` | `null` | no |
246261
| sg\_description | The security group description. | `string` | `"Instance default security group (only egress access is allowed)."` | no |
247262
| sg\_egress\_description | Description of the egress and ingress rule | `string` | `"Description of the rule."` | no |
248263
| sg\_egress\_ipv6\_description | Description of the egress\_ipv6 rule | `string` | `"Description of the rule."` | no |
249264
| sg\_ids | of the security group id. | `list(any)` | `[]` | no |
250265
| sg\_ingress\_description | Description of the ingress rule | `string` | `"Description of the ingress rule use elasticache."` | no |
251-
| snapshot\_arns | A single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. | `any` | `null` | no |
266+
| 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 |
252267
| 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 |
253268
| 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 |
254269
| 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 |
255-
| ssm\_paramete\_kms\_key\_id | KMS key ID or ARN for encrypting a SecureString. | `string` | `""` | no |
256270
| ssm\_parameter\_description | SSM Parameters can be imported using. | `string` | `"Description of the parameter."` | no |
257-
| ssm\_parameter\_enabled | Name of the parameter. | `bool` | `true` | no |
258271
| ssm\_parameter\_endpoint\_enabled | Name of the parameter. | `bool` | `false` | no |
259272
| ssm\_parameter\_type | Type of the parameter. | `string` | `"SecureString"` | no |
260273
| subnet\_group\_description | Description for the cache subnet group. Defaults to `Managed by Terraform`. | `string` | `"The Description of the ElastiCache Subnet Group."` | no |

0 commit comments

Comments
 (0)