Skip to content

Commit 7538271

Browse files
committed
docs: updating the documentation
1 parent 210b713 commit 7538271

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ The `terraform-docs` utility is used to generate this README. Follow the below s
349349
| <a name="input_enable_transit_gateway_subnet_natgw"></a> [enable\_transit\_gateway\_subnet\_natgw](#input\_enable\_transit\_gateway\_subnet\_natgw) | Indicates if the transit gateway subnets should be connected to a nat gateway | `bool` | `false` | no |
350350
| <a name="input_exclude_route53_resolver_rules"></a> [exclude\_route53\_resolver\_rules](#input\_exclude\_route53\_resolver\_rules) | List of resolver rules to exclude from association | `list(string)` | `[]` | no |
351351
| <a name="input_ipam_pool_id"></a> [ipam\_pool\_id](#input\_ipam\_pool\_id) | An optional pool id to use for IPAM pool to use | `string` | `null` | no |
352-
| <a name="input_nacl_rules"></a> [nacl\_rules](#input\_nacl\_rules) | Map of NACL rules to apply to different subnet types. Each rule requires from\_port, to\_port, protocol, rule\_action, cidr\_block, and rule\_number | <pre>map(object({<br/> inbound_rules = list(object({<br/> cidr_block = string<br/> from_port = number<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = string<br/> rule_number = number<br/> to_port = number<br/> }))<br/> outbound_rules = list(object({<br/> cidr_block = string<br/> from_port = number<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = string<br/> rule_number = number<br/> to_port = number<br/> }))<br/> }))</pre> | `{}` | no |
352+
| <a name="input_nacl_rules"></a> [nacl\_rules](#input\_nacl\_rules) | Map of NACL rules to apply to different subnet types. Each rule requires from\_port, to\_port, protocol, rule\_action, cidr\_block, and rule\_number | <pre>map(object({<br/> inbound = list(object({<br/> cidr_block = string<br/> from_port = optional(number, null)<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = optional(string, "allow")<br/> rule_number = number<br/> to_port = optional(number, null)<br/> }))<br/> outbound = list(object({<br/> cidr_block = string<br/> from_port = optional(number, null)<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = optional(string, "allow")<br/> rule_number = number<br/> to_port = optional(number, null)<br/> }))<br/> }))</pre> | `{}` | no |
353353
| <a name="input_nat_gateway_mode"></a> [nat\_gateway\_mode](#input\_nat\_gateway\_mode) | The configuration mode of the NAT gateways | `string` | `"none"` | no |
354354
| <a name="input_private_subnet_netmask"></a> [private\_subnet\_netmask](#input\_private\_subnet\_netmask) | The netmask for the private subnets | `number` | `0` | no |
355355
| <a name="input_private_subnet_tags"></a> [private\_subnet\_tags](#input\_private\_subnet\_tags) | Additional tags for the private subnets | `map(string)` | `{}` | no |

modules/nacls/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
| <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids) | The subnet IDs to apply the NACL to | `list(string)` | n/a | yes |
1515
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to apply to the NACL | `map(string)` | n/a | yes |
1616
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The VPC ID to create the NACL in | `string` | n/a | yes |
17-
| <a name="input_inbound_rules"></a> [inbound\_rules](#input\_inbound\_rules) | The inbound rules to apply to the NACL | <pre>list(object({<br/> cidr_block = string<br/> from_port = optional(number, null)<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = optional(string, "allow")<br/> rule_number = number<br/> to_port = optional(number, nu)<br/> }))</pre> | `[]` | no |
18-
| <a name="input_outbound_rules"></a> [outbound\_rules](#input\_outbound\_rules) | The outbound rules to apply to the NACL | <pre>list(object({<br/> cidr_block = string<br/> from_port = optional(number, null)<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = optional(string, "allow")<br/> rule_number = number<br/> to_port = optional(number, null)<br/> }))</pre> | `[]` | no |
17+
| <a name="input_inbound"></a> [inbound](#input\_inbound) | The inbound rules to apply to the NACL | <pre>list(object({<br/> cidr_block = string<br/> from_port = optional(number, null)<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = optional(string, "allow")<br/> rule_number = number<br/> to_port = optional(number, null)<br/> }))</pre> | `[]` | no |
18+
| <a name="input_outbound"></a> [outbound](#input\_outbound) | The outbound rules to apply to the NACL | <pre>list(object({<br/> cidr_block = string<br/> from_port = optional(number, null)<br/> icmp_code = optional(number, 0)<br/> icmp_type = optional(number, 0)<br/> ipv6_cidr_block = optional(string, null)<br/> protocol = optional(number, -1)<br/> rule_action = optional(string, "allow")<br/> rule_number = number<br/> to_port = optional(number, null)<br/> }))</pre> | `[]` | no |
1919

2020
## Outputs
2121

0 commit comments

Comments
 (0)