Skip to content

Commit fc7dbf6

Browse files
bober2000vitalii-morvaniuk-airslatebryantbiggs
authored
docs: Update README to use correct argument for security groups (#15)
Co-authored-by: Vitalii Morvaniuk <[email protected]> Co-authored-by: Bryant Biggs <[email protected]>
1 parent 7e0ea95 commit fc7dbf6

File tree

11 files changed

+24
-24
lines changed

11 files changed

+24
-24
lines changed

‎.github/workflows/pre-commit.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ on:
77
- master
88

99
env:
10-
TERRAFORM_DOCS_VERSION: v0.16.0
11-
TFLINT_VERSION: v0.50.3
10+
TERRAFORM_DOCS_VERSION: v0.19.0
11+
TFLINT_VERSION: v0.53.0
1212

1313
jobs:
1414
collectInputs:

‎.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: https://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.88.2
3+
rev: v1.96.1
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_docs
@@ -24,7 +24,7 @@ repos:
2424
- '--args=--only=terraform_unused_required_providers'
2525
- id: terraform_validate
2626
- repo: https://github.com/pre-commit/pre-commit-hooks
27-
rev: v4.5.0
27+
rev: v4.6.0
2828
hooks:
2929
- id: check-merge-conflict
3030
- id: end-of-file-fixer

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ Examples codified under the [`examples`](https://github.com/terraform-aws-module
278278
- [Redis Global Replication Group](https://github.com/terraform-aws-modules/terraform-aws-elasticache/tree/master/examples/redis-global-replication-group)
279279
- [Redis Replication Group](https://github.com/terraform-aws-modules/terraform-aws-elasticache/tree/master/examples/redis-replication-group)
280280

281-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
281+
<!-- BEGIN_TF_DOCS -->
282282
## Requirements
283283

284284
| Name | Version |
@@ -344,7 +344,7 @@ No modules.
344344
| <a name="input_global_replication_group_id"></a> [global\_replication\_group\_id](#input\_global\_replication\_group\_id) | The ID of the global replication group to which this replication group should belong | `string` | `null` | no |
345345
| <a name="input_ip_discovery"></a> [ip\_discovery](#input\_ip\_discovery) | The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6` | `string` | `null` | no |
346346
| <a name="input_kms_key_arn"></a> [kms\_key\_arn](#input\_kms\_key\_arn) | 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` | `null` | no |
347-
| <a name="input_log_delivery_configuration"></a> [log\_delivery\_configuration](#input\_log\_delivery\_configuration) | (Redis only) Specifies the destination and format of Redis SLOWLOG or Redis Engine Log | `any` | <pre>{<br> "slow-log": {<br> "destination_type": "cloudwatch-logs",<br> "log_format": "json"<br> }<br>}</pre> | no |
347+
| <a name="input_log_delivery_configuration"></a> [log\_delivery\_configuration](#input\_log\_delivery\_configuration) | (Redis only) Specifies the destination and format of Redis SLOWLOG or Redis Engine Log | `any` | <pre>{<br/> "slow-log": {<br/> "destination_type": "cloudwatch-logs",<br/> "log_format": "json"<br/> }<br/>}</pre> | no |
348348
| <a name="input_maintenance_window"></a> [maintenance\_window](#input\_maintenance\_window) | Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC) | `string` | `null` | no |
349349
| <a name="input_multi_az_enabled"></a> [multi\_az\_enabled](#input\_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 |
350350
| <a name="input_network_type"></a> [network\_type](#input\_network\_type) | The IP versions for cache cluster connections. Valid values are `ipv4`, `ipv6` or `dual_stack` | `string` | `null` | no |
@@ -411,7 +411,7 @@ No modules.
411411
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
412412
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
413413
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
414-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
414+
<!-- END_TF_DOCS -->
415415

416416
## License
417417

‎examples/memcached-cluster/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ terraform apply
1414

1515
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
1616

17-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
17+
<!-- BEGIN_TF_DOCS -->
1818
## Requirements
1919

2020
| Name | Version |
@@ -73,6 +73,6 @@ No inputs.
7373
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
7474
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
7575
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
76-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
76+
<!-- END_TF_DOCS -->
7777

7878
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-elasticache/blob/master/LICENSE).

‎examples/redis-cluster-mode/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ $ terraform apply
1616

1717
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
1818

19-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
19+
<!-- BEGIN_TF_DOCS -->
2020
## Requirements
2121

2222
| Name | Version |
@@ -75,6 +75,6 @@ No inputs.
7575
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
7676
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
7777
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
78-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
78+
<!-- END_TF_DOCS -->
7979

8080
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-elasticache/blob/master/LICENSE).

‎examples/redis-cluster/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ terraform apply
1414

1515
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
1616

17-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
17+
<!-- BEGIN_TF_DOCS -->
1818
## Requirements
1919

2020
| Name | Version |
@@ -73,6 +73,6 @@ No inputs.
7373
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
7474
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
7575
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
76-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
76+
<!-- END_TF_DOCS -->
7777

7878
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-elasticache/blob/master/LICENSE).

‎examples/redis-global-replication-group/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ terraform apply
1818

1919
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
2020

21-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
21+
<!-- BEGIN_TF_DOCS -->
2222
## Requirements
2323

2424
| Name | Version |
@@ -80,6 +80,6 @@ No inputs.
8080
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
8181
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
8282
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
83-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
83+
<!-- END_TF_DOCS -->
8484

8585
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-elasticache/blob/master/LICENSE).

‎examples/redis-replication-group-with-cluster-replica/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ terraform apply
1414

1515
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
1616

17-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
17+
<!-- BEGIN_TF_DOCS -->
1818
## Requirements
1919

2020
| Name | Version |
@@ -74,6 +74,6 @@ No inputs.
7474
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
7575
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
7676
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
77-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
77+
<!-- END_TF_DOCS -->
7878

7979
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-elasticache/blob/master/LICENSE).

‎examples/redis-replication-group/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ terraform apply
1414

1515
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
1616

17-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
17+
<!-- BEGIN_TF_DOCS -->
1818
## Requirements
1919

2020
| Name | Version |
@@ -72,6 +72,6 @@ No inputs.
7272
| <a name="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn) | Amazon Resource Name (ARN) of the security group |
7373
| <a name="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id) | ID of the security group |
7474
| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
75-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
75+
<!-- END_TF_DOCS -->
7676

7777
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-elasticache/blob/master/LICENSE).

‎modules/serverless-cache/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ module "elasticache_serverless_cache" {
2929
kms_key_id = aws_kms_key.this.arn
3030
major_engine_version = "7"
3131
32-
security_group_rules = [module.sg.security_group_id]
32+
security_group_ids = [module.sg.security_group_id]
3333
3434
snapshot_retention_limit = 7
3535
subnet_ids = module.vpc.private_subnets
@@ -54,7 +54,7 @@ Examples codified under the [`examples`](https://github.com/terraform-aws-module
5454
- [Redis Replication Group](https://github.com/terraform-aws-modules/terraform-aws-elasticache/tree/master/examples/redis-replication-group)
5555
- [Serverless Cache](https://github.com/terraform-aws-modules/terraform-aws-elasticache/tree/master/examples/serverless-cache)
5656

57-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
57+
<!-- BEGIN_TF_DOCS -->
5858
## Requirements
5959

6060
| Name | Version |
@@ -109,7 +109,7 @@ No modules.
109109
| <a name="output_serverless_cache_major_engine_version"></a> [serverless\_cache\_major\_engine\_version](#output\_serverless\_cache\_major\_engine\_version) | The version number of the engine the serverless cache is compatible with |
110110
| <a name="output_serverless_cache_reader_endpoint"></a> [serverless\_cache\_reader\_endpoint](#output\_serverless\_cache\_reader\_endpoint) | Represents the information required for client programs to connect to a cache node |
111111
| <a name="output_serverless_cache_status"></a> [serverless\_cache\_status](#output\_serverless\_cache\_status) | The current status of the serverless cache. The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING |
112-
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
112+
<!-- END_TF_DOCS -->
113113

114114
## License
115115

0 commit comments

Comments
 (0)