Skip to content

Commit 3697bfc

Browse files
committed
update README.md
1 parent 6bcc833 commit 3697bfc

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/io.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
| allowed\_ports | List of allowed ingress ports | `list(any)` | `[]` | no |
88
| 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 |
99
| 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 |
10+
| auth\_token\_update\_strategy | (Optional) Strategy to use when updating the auth\_token. Valid values are SET, ROTATE, and DELETE. Required if auth\_token is set. Defaults to ROTATE | `string` | `null` | no |
11+
| auto\_generate\_auth\_token | Whether to automatically generate the authentication token using Terraform. If set to false, you must provide your own token via the 'auth\_token' variable. | `bool` | `true` | no |
1012
| 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 |
1113
| 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 |
1214
| cluster\_enabled | (Memcache only) Enabled or disabled cluster. | `bool` | `false` | no |
@@ -15,6 +17,7 @@
1517
| deletion\_window\_in\_days | Duration in days after which the key is deleted after destruction of the resource. | `number` | `7` | no |
1618
| egress\_rule | Enable to create egress rule | `bool` | `true` | no |
1719
| enable | Enable or disable of elasticache | `bool` | `true` | no |
20+
| enable\_aws\_ssm\_parameter | Whether to create the AWS SSM parameter for the auth token | `bool` | `false` | no |
1821
| enable\_key\_rotation | Specifies whether key rotation is enabled. | `string` | `true` | no |
1922
| enable\_security\_group | Enable default Security Group with only Egress traffic allowed. | `bool` | `true` | no |
2023
| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
@@ -63,14 +66,23 @@
6366
|------|-------------|
6467
| Memcached\_ssm\_name | A list of all of the parameter values |
6568
| auth\_token | Auth token generated value |
69+
| elasticache\_arn | Elasticache arn |
70+
| elasticache\_cache\_nodes | List of node objects |
71+
| elasticache\_cluster\_address | (Memcached only) DNS name of the cache cluster |
72+
| elasticache\_cluster\_enabled | Indicates if cluster mode is enabled. |
73+
| elasticache\_configuration\_endpoint\_address | Address of the replication group configuration endpoint when cluster mode is enabled. |
74+
| elasticache\_endpoint | Elasticache endpoint address. |
75+
| elasticache\_engine\_version | Running version of the cache engine. |
76+
| elasticache\_engine\_version\_actual | Running version of the cache engine |
77+
| elasticache\_member\_clusters | Identifiers of all the nodes that are part of this replication group. |
78+
| elasticache\_reader\_endpoint\_address | Address of the endpoint for the reader node in the replication group, if cluster mode is disabled. |
79+
| elasticache\_tags\_all | Map of tags assigned to the resource, including inherited ones. |
6680
| hostname | DNS hostname |
67-
| id | Redis cluster id. |
81+
| id | Elasticache cluster id. |
6882
| memcached\_arn | Memcached arn |
6983
| memcached\_endpoint | Memcached endpoint address. |
7084
| memcached\_hostname | DNS hostname |
7185
| port | Redis port. |
72-
| redis\_arn | Redis arn |
73-
| redis\_endpoint | Redis endpoint address. |
7486
| redis\_ssm\_name | A list of all of the parameter values |
7587
| sg\_id | n/a |
7688
| tags | A mapping of tags to assign to the resource. |

0 commit comments

Comments
 (0)