Skip to content

Commit 02c4de8

Browse files
committed
docs: Updated docs with pre-commit
1 parent 25b8ae2 commit 02c4de8

File tree

3 files changed

+30
-18
lines changed

3 files changed

+30
-18
lines changed

.pre-commit-config.yaml

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
repos:
2-
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.40.0
4-
hooks:
5-
- id: terraform_fmt
6-
- id: terraform_docs
7-
- id: terraform_tflint
8-
args:
9-
- '--args=--config=__GIT_WORKING_DIR__/.tflint.hcl'
10-
- repo: git://github.com/pre-commit/pre-commit-hooks
11-
rev: v3.2.0
12-
hooks:
13-
- id: check-merge-conflict
2+
- repo: git://github.com/antonbabenko/pre-commit-terraform
3+
rev: v1.43.0
4+
hooks:
5+
- id: terraform_fmt
6+
- id: terraform_docs
7+
- id: terraform_tflint
8+
args:
9+
- '--args=--only=terraform_deprecated_interpolation'
10+
- '--args=--only=terraform_deprecated_index'
11+
- '--args=--only=terraform_unused_declarations'
12+
- '--args=--only=terraform_comment_syntax'
13+
- '--args=--only=terraform_documented_outputs'
14+
- '--args=--only=terraform_documented_variables'
15+
- '--args=--only=terraform_typed_variables'
16+
- '--args=--only=terraform_module_pinned_source'
17+
- '--args=--only=terraform_naming_convention'
18+
- '--args=--only=terraform_required_version'
19+
- '--args=--only=terraform_required_providers'
20+
- '--args=--only=terraform_standard_module_structure'
21+
- '--args=--only=terraform_workspace_remote'
22+
- repo: git://github.com/pre-commit/pre-commit-hooks
23+
rev: v3.2.0
24+
hooks:
25+
- id: check-merge-conflict

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway
465465
| enable\_states\_endpoint | Should be true if you want to provision a Step Function endpoint to the VPC | `bool` | `false` | no |
466466
| enable\_storagegateway\_endpoint | Should be true if you want to provision a Storage Gateway endpoint to the VPC | `bool` | `false` | no |
467467
| enable\_sts\_endpoint | Should be true if you want to provision a STS endpoint to the VPC | `bool` | `false` | no |
468-
| enable\_textract\_endpoint | Should be true if you want to provision a Textract endpoint to the VPC | `bool` | `false` | no |
468+
| enable\_textract\_endpoint | Should be true if you want to provision an Textract endpoint to the VPC | `bool` | `false` | no |
469469
| enable\_transfer\_endpoint | Should be true if you want to provision a Transfer endpoint to the VPC | `bool` | `false` | no |
470470
| enable\_transferserver\_endpoint | Should be true if you want to provision a Transfer Server endpoint to the VPC | `bool` | `false` | no |
471471
| enable\_vpn\_gateway | Should be true if you want to create a new VPN Gateway resource and attach it to the VPC | `bool` | `false` | no |
@@ -615,7 +615,7 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway
615615
| sts\_endpoint\_security\_group\_ids | The ID of one or more security groups to associate with the network interface for STS endpoint | `list(string)` | `[]` | no |
616616
| sts\_endpoint\_subnet\_ids | The ID of one or more subnets in which to create a network interface for STS endpoint. Only a single subnet within an AZ is supported. If omitted, private subnets will be used. | `list(string)` | `[]` | no |
617617
| tags | A map of tags to add to all resources | `map(string)` | `{}` | no |
618-
| textract\_endpoint\_private\_dns\_enabled | Whether or not to associate a private hosted zone with the specified VPC for Textract | `bool` | `false` | no |
618+
| textract\_endpoint\_private\_dns\_enabled | Whether or not to associate a private hosted zone with the specified VPC for Textract endpoint | `bool` | `false` | no |
619619
| textract\_endpoint\_security\_group\_ids | The ID of one or more security groups to associate with the network interface for Textract endpoint | `list(string)` | `[]` | no |
620620
| textract\_endpoint\_subnet\_ids | The ID of one or more subnets in which to create a network interface for Textract endpoint. Only a single subnet within an AZ is supported. If omitted, private subnets will be used. | `list(string)` | `[]` | no |
621621
| transfer\_endpoint\_private\_dns\_enabled | Whether or not to associate a private hosted zone with the specified VPC for Transfer endpoint | `bool` | `false` | no |
@@ -894,9 +894,9 @@ It is possible to integrate this VPC module with [terraform-aws-transit-gateway
894894
| vpc\_endpoint\_sts\_dns\_entry | The DNS entries for the VPC Endpoint for STS. |
895895
| vpc\_endpoint\_sts\_id | The ID of VPC endpoint for STS |
896896
| vpc\_endpoint\_sts\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for STS. |
897-
| vpc\_endpoint\_textract\_dns\_entry | The DNS entries for the VPC Endpoint for textract. |
898-
| vpc\_endpoint\_textract\_id | The ID of VPC endpoint for textract. |
899-
| vpc\_endpoint\_textract\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for textract. |
897+
| vpc\_endpoint\_textract\_dns\_entry | The DNS entries for the VPC Endpoint for Textract. |
898+
| vpc\_endpoint\_textract\_id | The ID of VPC endpoint for Textract |
899+
| vpc\_endpoint\_textract\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for Textract. |
900900
| vpc\_endpoint\_transfer\_dns\_entry | The DNS entries for the VPC Endpoint for Transfer. |
901901
| vpc\_endpoint\_transfer\_id | The ID of VPC endpoint for Transfer |
902902
| vpc\_endpoint\_transfer\_network\_interface\_ids | One or more network interfaces for the VPC Endpoint for Transfer. |

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1202,7 +1202,7 @@ variable "transfer_endpoint_security_group_ids" {
12021202
}
12031203

12041204
variable "transfer_endpoint_subnet_ids" {
1205-
description = "The ID of one or more subnets in which to create a network interface for Transfer endpoint. Only a single subnet within an AZ is supported. Ifomitted, private subnets will be used."
1205+
description = "The ID of one or more subnets in which to create a network interface for Transfer endpoint. Only a single subnet within an AZ is supported. If omitted, private subnets will be used."
12061206
type = list(string)
12071207
default = []
12081208
}

0 commit comments

Comments
 (0)