Skip to content

Commit bd46ff2

Browse files
committed
update README.md
1 parent cf2c353 commit bd46ff2

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<p align="center">
1515

1616
<a href="https://www.terraform.io">
17-
<img src="https://img.shields.io/badge/terraform-v0.13-green" alt="Terraform">
17+
<img src="https://img.shields.io/badge/terraform-v0.14-green" alt="Terraform">
1818
</a>
1919
<a href="LICENSE.md">
2020
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
@@ -72,10 +72,10 @@ Here are some examples of how you can use this module in your inventory structur
7272
### Redis
7373
```hcl
7474
module "redis" {
75-
source = "clouddrove/elasticache/aws"
76-
version = "0.13.0"
75+
source = "clouddrove/elasticache/aws
76+
version = "0.14.0"
7777
name = "redis"
78-
application = "clouddrove"
78+
repository = "https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"
7979
environment = "test"
8080
label_order = ["environment", "application", "name"]
8181
engine = "redis"
@@ -94,10 +94,10 @@ Here are some examples of how you can use this module in your inventory structur
9494
### Redis Cluster
9595
```hcl
9696
module "redis-cluster" {
97-
source = "clouddrove/elasticache/aws"
98-
version = "0.13.0"
97+
source = "clouddrove/elasticache/aws
98+
version = "0.14.0"
9999
name = "cluster"
100-
application = "clouddrove"
100+
repository = "https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"
101101
environment = "test"
102102
label_order = ["environment", "application", "name"]
103103
cluster_replication_enabled = true
@@ -108,7 +108,7 @@ Here are some examples of how you can use this module in your inventory structur
108108
node_type = "cache.t2.micro"
109109
subnet_ids = module.subnets.public_subnet_id
110110
security_group_ids = [module.redis-sg.security_group_ids]
111-
availability_zones = ["eu-west-1a","eu-west-1b" ]
111+
availability_zones = ["eu-west-1a","eu-west-1b" ]
112112
auto_minor_version_upgrade = true
113113
replicas_per_node_group = 2
114114
num_node_groups = 1
@@ -118,10 +118,10 @@ Here are some examples of how you can use this module in your inventory structur
118118
### Memcache
119119
```hcl
120120
module "memcached" {
121-
source = "clouddrove/elasticache/aws"
122-
version = "0.13.0"
121+
source = "clouddrove/elasticache/aws
122+
version = "0.14.0"
123123
name = "memcached"
124-
application = "clouddrove"
124+
repository = "https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"
125125
environment = "test"
126126
label_order = ["environment", "application", "name"]
127127
cluster_enabled = true
@@ -147,11 +147,10 @@ Here are some examples of how you can use this module in your inventory structur
147147

148148
| Name | Description | Type | Default | Required |
149149
|------|-------------|------|---------|:--------:|
150-
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
151150
| apply\_immediately | Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is false. | `bool` | `false` | no |
152-
| at\_rest\_encryption\_enabled | Enable encryption at rest. | `bool` | `false` | no |
153-
| attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no |
154-
| auth\_token | The password used to access a password protected server. Can be specified only if transit\_encryption\_enabled = true. | `any` | `null` | no |
151+
| at\_rest\_encryption\_enabled | Enable encryption at rest. | `bool` | `true` | no |
152+
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
153+
| auth\_token | The password used to access a password protected server. Can be specified only if transit\_encryption\_enabled = true. | `string` | `"gihweisdjhewiuei"` | no |
155154
| 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 |
156155
| 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` | `false` | no |
157156
| 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 |
@@ -165,7 +164,7 @@ Here are some examples of how you can use this module in your inventory structur
165164
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
166165
| family | (Required) The family of the ElastiCache parameter group. | `string` | `""` | no |
167166
| 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 |
168-
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
167+
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
169168
| maintenance\_window | Maintenance window. | `string` | `"sun:05:00-sun:06:00"` | no |
170169
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"anmol@clouddrove.com"` | no |
171170
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
@@ -179,15 +178,16 @@ Here are some examples of how you can use this module in your inventory structur
179178
| replicas\_per\_node\_group | Replicas per Shard. | `string` | `""` | no |
180179
| replication\_enabled | (Redis only) Enabled or disabled replication\_group for redis standalone instance. | `bool` | `false` | no |
181180
| replication\_group\_id | The replication group identifier This parameter is stored as a lowercase string. | `string` | `""` | no |
181+
| repository | Terraform current module repo | `string` | `"https://registry.terraform.io/modules/clouddrove/elasticache/aws/0.14.0"` | no |
182182
| security\_group\_ids | One or more VPC security groups associated with the cache cluster. | `list` | `[]` | no |
183183
| security\_group\_names | A list of cache security group names to associate with this replication group. | `any` | `null` | no |
184184
| 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 |
185185
| 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 |
186-
| 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. | `number` | `0` | no |
186+
| 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. | `any` | `null` | no |
187187
| 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. | `any` | `null` | no |
188188
| subnet\_ids | List of VPC Subnet IDs for the cache subnet group. | `list` | `[]` | no |
189-
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no |
190-
| transit\_encryption\_enabled | Whether to enable encryption in transit. | `bool` | `false` | no |
189+
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
190+
| transit\_encryption\_enabled | Whether to enable encryption in transit. | `bool` | `true` | no |
191191

192192
## Outputs
193193

0 commit comments

Comments
 (0)