docs: updating the readme in the repo

README.md

@@ -315,10 +315,10 @@ module "network_inspection_vpc_admin" {
 | <a name="input_enable_egress"></a> [enable\_egress](#input\_enable\_egress) | Indicates the inspectio vpc should have egress enabled | `bool` | `false` | no |
 | <a name="input_enable_policy_change_protection"></a> [enable\_policy\_change\_protection](#input\_enable\_policy\_change\_protection) | Indicates the firewall policy should be protected from changes | `bool` | `false` | no |
 | <a name="input_enable_subnet_change_protection"></a> [enable\_subnet\_change\_protection](#input\_enable\_subnet\_change\_protection) | Indicates the firewall subnets should be protected from changes | `bool` | `false` | no |
-| <a name="input_external_rule_groups"></a> [external\_rule\_groups](#input\_external\_rule\_groups) | A collection of additional rule groups to add to the policy | <pre>list(object({<br>    priority = number<br>    arn      = string<br>  }))</pre> | `null` | no |
-| <a name="input_firewall_rules"></a> [firewall\_rules](#input\_firewall\_rules) | A collection of firewall rules to add to the policy | <pre>list(object({<br>    name    = string<br>    content = string<br>  }))</pre> | `null` | no |
-| <a name="input_ip_prefixes"></a> [ip\_prefixes](#input\_ip\_prefixes) | A collection of ip sets which can be referenced by the rules | <pre>map(object({<br>    name           = string<br>    address_family = string<br>    max_entries    = number<br>    description    = string<br>    entries = list(object({<br>      cidr        = string<br>      description = string<br>    }))<br>  }))</pre> | `{}` | no |
-| <a name="input_network_cidr_blocks"></a> [network\_cidr\_blocks](#input\_network\_cidr\_blocks) | List of CIDR blocks defining the aws environment | `list(string)` | <pre>[<br>  "10.0.0.0/8",<br>  "192.168.0.0/24"<br>]</pre> | no |
+| <a name="input_external_rule_groups"></a> [external\_rule\_groups](#input\_external\_rule\_groups) | A collection of additional rule groups to add to the policy | <pre>list(object({<br/>    priority = number<br/>    arn      = string<br/>  }))</pre> | `null` | no |
+| <a name="input_firewall_rules"></a> [firewall\_rules](#input\_firewall\_rules) | A collection of firewall rules to add to the policy | <pre>list(object({<br/>    name    = string<br/>    content = string<br/>  }))</pre> | `null` | no |
+| <a name="input_ip_prefixes"></a> [ip\_prefixes](#input\_ip\_prefixes) | A collection of ip sets which can be referenced by the rules | <pre>map(object({<br/>    name           = string<br/>    address_family = string<br/>    max_entries    = number<br/>    description    = string<br/>    entries = list(object({<br/>      cidr        = string<br/>      description = string<br/>    }))<br/>  }))</pre> | `{}` | no |
+| <a name="input_network_cidr_blocks"></a> [network\_cidr\_blocks](#input\_network\_cidr\_blocks) | List of CIDR blocks defining the aws environment | `list(string)` | <pre>[<br/>  "10.0.0.0/8",<br/>  "192.168.0.0/24"<br/>]</pre> | no |
 | <a name="input_policy_variables"></a> [policy\_variables](#input\_policy\_variables) | A map of policy variables made available to the suricata rules | `map(list(string))` | `{}` | no |
 | <a name="input_private_subnet_id_by_az"></a> [private\_subnet\_id\_by\_az](#input\_private\_subnet\_id\_by\_az) | If reusing an existing VPC, provider a map of az to subnet id | `map(string)` | `{}` | no |
 | <a name="input_private_subnet_netmask"></a> [private\_subnet\_netmask](#input\_private\_subnet\_netmask) | Netmask for the private subnets | `number` | `24` | no |

examples/existing_no_egress/README.md

@@ -33,7 +33,7 @@ No resources.
 | <a name="input_name"></a> [name](#input\_name) | Name of the environment to deploy into | `string` | `"inspection"` | no |
 | <a name="input_private_subnet_netmask"></a> [private\_subnet\_netmask](#input\_private\_subnet\_netmask) | Netmask for the private subnets | `number` | `24` | no |
 | <a name="input_ram_principals"></a> [ram\_principals](#input\_ram\_principals) | A list of principals to share the firewall policy with | `map(string)` | `{}` | no |
-| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources | `map(string)` | <pre>{<br>  "GitRepo": "https://github.com/appvia/terraform-aws-firewall",<br>  "Project": "CloudPlatform",<br>  "Provisioner": "terraform",<br>  "Team": "CloudPlatform"<br>}</pre> | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources | `map(string)` | <pre>{<br/>  "GitRepo": "https://github.com/appvia/terraform-aws-firewall",<br/>  "Project": "CloudPlatform",<br/>  "Provisioner": "terraform",<br/>  "Team": "CloudPlatform"<br/>}</pre> | no |
 | <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | CIDR block for the VPC | `string` | `"100.64.0.0/21"` | no |
 
 ## Outputs

examples/existing_with_egress/README.md

@@ -34,7 +34,7 @@ No resources.
 | <a name="input_private_subnet_netmask"></a> [private\_subnet\_netmask](#input\_private\_subnet\_netmask) | Netmask for the private subnets | `number` | `24` | no |
 | <a name="input_public_subnet_netmask"></a> [public\_subnet\_netmask](#input\_public\_subnet\_netmask) | Netmask for the public subnets | `number` | `24` | no |
 | <a name="input_ram_principals"></a> [ram\_principals](#input\_ram\_principals) | A list of principals to share the firewall policy with | `map(string)` | `{}` | no |
-| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources | `map(string)` | <pre>{<br>  "GitRepo": "https://github.com/appvia/terraform-aws-firewall",<br>  "Project": "CloudPlatform",<br>  "Provisioner": "terraform",<br>  "Team": "CloudPlatform"<br>}</pre> | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources | `map(string)` | <pre>{<br/>  "GitRepo": "https://github.com/appvia/terraform-aws-firewall",<br/>  "Project": "CloudPlatform",<br/>  "Provisioner": "terraform",<br/>  "Team": "CloudPlatform"<br/>}</pre> | no |
 | <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | CIDR block for the VPC | `string` | `"100.64.0.0/21"` | no |
 
 ## Outputs

examples/inspection/README.md

@@ -31,10 +31,10 @@ No resources.
 | <a name="input_cloudwatch_retention_in_days"></a> [cloudwatch\_retention\_in\_days](#input\_cloudwatch\_retention\_in\_days) | Number of days to retain CloudWatch logs | `number` | `30` | no |
 | <a name="input_create_kms_key"></a> [create\_kms\_key](#input\_create\_kms\_key) | Create a KMS key for CloudWatch logs | `bool` | `false` | no |
 | <a name="input_enable_dashboard"></a> [enable\_dashboard](#input\_enable\_dashboard) | Indicates we should deploy the CloudWatch Insights dashboard | `bool` | `false` | no |
-| <a name="input_ip_prefixes"></a> [ip\_prefixes](#input\_ip\_prefixes) | A collection of ip sets which can be referenced by the rules | <pre>map(object({<br>    name           = string<br>    address_family = string<br>    max_entries    = number<br>    description    = string<br>    entries = list(object({<br>      cidr        = string<br>      description = string<br>    }))<br>  }))</pre> | `{}` | no |
+| <a name="input_ip_prefixes"></a> [ip\_prefixes](#input\_ip\_prefixes) | A collection of ip sets which can be referenced by the rules | <pre>map(object({<br/>    name           = string<br/>    address_family = string<br/>    max_entries    = number<br/>    description    = string<br/>    entries = list(object({<br/>      cidr        = string<br/>      description = string<br/>    }))<br/>  }))</pre> | `{}` | no |
 | <a name="input_name"></a> [name](#input\_name) | Name of the environment to deploy into | `string` | `"inspection"` | no |
 | <a name="input_ram_principals"></a> [ram\_principals](#input\_ram\_principals) | A list of principals to share the firewall policy with | `map(string)` | `{}` | no |
-| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to all resources | `map(string)` | <pre>{<br>  "GitRepo": "https://github.com/appvia/terraform-aws-firewall",<br>  "Project": "CloudPlatform",<br>  "Provisioner": "terraform",<br>  "Team": "CloudPlatform"<br>}</pre> | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to all resources | `map(string)` | <pre>{<br/>  "GitRepo": "https://github.com/appvia/terraform-aws-firewall",<br/>  "Project": "CloudPlatform",<br/>  "Provisioner": "terraform",<br/>  "Team": "CloudPlatform"<br/>}</pre> | no |
 | <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | CIDR block for the VPC | `string` | `"100.64.0.0/21"` | no |
 
 ## Outputs