docs: updating the readme to reflect the changes

README.md

@@ -328,19 +328,19 @@ The `terraform-docs` utility is used to generate this README. Follow the below s
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_amazon_side_asn"></a> [amazon\_side\_asn](#input\_amazon\_side\_asn) | The ASN for the transit gateway. | `number` | n/a | yes |
-| <a name="input_connectivity_config"></a> [connectivity\_config](#input\_connectivity\_config) | The type of connectivity options for the transit gateway. | <pre>object({<br>    inspection_with_all = optional(object({<br>      # The name of the inbound route table. Defaults to 'inbound'. <br>      network = optional(object({<br>        # Defines the configuration for the inspection network. <br>        availability_zones = number<br>        # The number of availablity zones to use for the inspection network. Required. Must match the <br>        # number of availability zones you use in the organization, due to symmetric routing requirements. <br>        name = optional(string, "inspection")<br>        # The name of the inspection network. Defaults to 'inspection'. <br>        private_netmask = optional(number, 24)<br>        # The netmask to use for the private network. Defaults to 24<br>        vpc_cidr = optional(string, "100.64.0.0/21")<br>        # The CIDR block to use for the VPC. Defaults to carrier-grade NAT space. <br>      }), null)<br>      return_route_table_name = optional(string, "inspection-return")<br>    }), null)<br><br>    trusted = optional(object({<br>      # Defines the configuration for the trusted routing<br>      trusted_attachments = optional(list(string), [])<br>      # The list of transit gateway attachments to trust e.g can see all the other untrusted networks. Defaults to an empty list.<br>      trusted_route_table_name = optional(string, "trusted")<br>      # The name of the trusted route table. Defaults to 'trusted'.<br>      trusted_core_route_table_name = optional(string, "trusted-core")<br>    }), null)<br>  })</pre> | n/a | yes |
+| <a name="input_connectivity_config"></a> [connectivity\_config](#input\_connectivity\_config) | The type of connectivity options for the transit gateway. | <pre>object({<br/>    inspection_with_all = optional(object({<br/>      # The name of the inbound route table. Defaults to 'inbound'. <br/>      network = optional(object({<br/>        # Defines the configuration for the inspection network. <br/>        availability_zones = number<br/>        # The number of availablity zones to use for the inspection network. Required. Must match the <br/>        # number of availability zones you use in the organization, due to symmetric routing requirements. <br/>        name = optional(string, "inspection")<br/>        # The name of the inspection network. Defaults to 'inspection'. <br/>        private_netmask = optional(number, 24)<br/>        # The netmask to use for the private network. Defaults to 24<br/>        vpc_cidr = optional(string, "100.64.0.0/21")<br/>        # The CIDR block to use for the VPC. Defaults to carrier-grade NAT space. <br/>      }), null)<br/>      return_route_table_name = optional(string, "inspection-return")<br/>    }), null)<br/><br/>    trusted = optional(object({<br/>      # Defines the configuration for the trusted routing<br/>      trusted_attachments = optional(map(string), {})<br/>      # The list of transit gateway attachments to trust e.g can see all the other untrusted networks. Defaults to an empty list.<br/>      trusted_route_table_name = optional(string, "trusted")<br/>      # The name of the trusted route table. Defaults to 'trusted'.<br/>      trusted_core_route_table_name = optional(string, "trusted-core")<br/>    }), null)<br/>  })</pre> | n/a | yes |
 | <a name="input_description"></a> [description](#input\_description) | The description of the transit gateway to provision. | `string` | n/a | yes |
 | <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to all resources. | `map(string)` | n/a | yes |
 | <a name="input_enable_dns_support"></a> [enable\_dns\_support](#input\_enable\_dns\_support) | Whether DNS support is enabled. | `bool` | `true` | no |
 | <a name="input_enable_external_principals"></a> [enable\_external\_principals](#input\_enable\_external\_principals) | Whether to enable external principals in the RAM share. | `bool` | `true` | no |
 | <a name="input_enable_multicast_support"></a> [enable\_multicast\_support](#input\_enable\_multicast\_support) | Whether multicast support is enabled. | `bool` | `false` | no |
 | <a name="input_enable_vpn_ecmp_support"></a> [enable\_vpn\_ecmp\_support](#input\_enable\_vpn\_ecmp\_support) | Whether VPN Equal Cost Multipath Protocol support is enabled. | `bool` | `false` | no |
 | <a name="input_name"></a> [name](#input\_name) | The name of the transit gateway to provision. | `string` | `"tgw"` | no |
-| <a name="input_prefix_lists"></a> [prefix\_lists](#input\_prefix\_lists) | Provides the ability to provision prefix lists, and share them with other accounts. | <pre>list(object({<br>    name = string<br>    entry = list(object({<br>      address_family = optional(string, "IPv4")<br>      cidr           = string<br>      description    = string<br>      max_entries    = number<br>    }))<br>  }))</pre> | `[]` | no |
+| <a name="input_prefix_lists"></a> [prefix\_lists](#input\_prefix\_lists) | Provides the ability to provision prefix lists, and share them with other accounts. | <pre>list(object({<br/>    name = string<br/>    entry = list(object({<br/>      address_family = optional(string, "IPv4")<br/>      cidr           = string<br/>      description    = string<br/>      max_entries    = number<br/>    }))<br/>  }))</pre> | `[]` | no |
 | <a name="input_prefix_ram_principals"></a> [prefix\_ram\_principals](#input\_prefix\_ram\_principals) | The list of organizational units or accounts to share the prefix lists with. | `list(string)` | `[]` | no |
 | <a name="input_ram_share_name"></a> [ram\_share\_name](#input\_ram\_share\_name) | The name of the RAM share to create for the transit gateway. | `string` | `"tgw-ram-share"` | no |
 | <a name="input_ram_share_principals"></a> [ram\_share\_principals](#input\_ram\_share\_principals) | The list of organizational units or accounts to share the transit gateway with. | `list(string)` | `[]` | no |
-| <a name="input_services"></a> [services](#input\_services) | A collection of features and services associated with this connectivity domain. | <pre>object({<br>    egress = optional(object({<br>      network = object({<br>        # Defines the configuration for an egress network. <br>        availability_zones = optional(number, 2)<br>        # The number of availablity zones to use for the egress network. Defaults to 2.<br>        ipam_pool_id = optional(string, null)<br>        # The ID of the IPAM pool to use for the egress network. Defaults to null. <br>        name = optional(string, "egress")<br>        # The name of the egress network. Defaults to 'egress'. <br>        private_netmask = optional(number, 28)<br>        # The netmask to use for the private network. Defaults to 28. <br>        public_netmask = optional(number, 28)<br>        # The netmask to use for the public network. Defaults to 28. <br>        vpc_cidr = optional(string, null)<br>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM<br>        vpc_netmask = optional(string, null)<br>        # The netmask to use for the VPC. Defaults to null, required when using IPAM<br>      })<br>    }), null)<br>    dns = optional(object({<br>      # The list of organizational units or accounts to share the domain rule with. <br>      resolver_name = optional(string, "dns-resolver")<br><br>      # Defines the configuration for the endpoints network. <br>      network = object({<br>        # Defines the configuration for the endpoints network. <br>        availability_zones = optional(number, 2)<br>        # The number of availablity zones to use for the endpoints network. Defaults to 2. <br>        ipam_pool_id = optional(string, null)<br>        # The ID of the IPAM pool to use for the endpoints network. Defaults to null. <br>        name = optional(string, "central-dns")<br>        # The name of the endpoints network. Defaults to 'endpoints'. <br>        private_netmask = optional(number, 24)<br>        # The netmask to use for the private network. Defaults to 24, ensure space for enough aws services. <br>        vpc_cidr = optional(string, null)<br>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM <br>        vpc_netmask = optional(string, null)<br>        # The netmask to use for the VPC. Defaults to null, required when using IPAM <br>      }),<br><br>      domain_rules = optional(list(object({<br>        ram_share_name = optional(string, "central-dns")<br>        # The name of the domain rule - this is mapped to the resource share name <br>        ram_principals = optional(map(string), {})<br>        # The name of the resolver to use. Defaults to 'dns-resolver'.<br>        rules = list(object({<br>          name = string<br>          # The name of the rule - the ram share name is domain.name + "-" + rule.name <br>          # The list of domain rules to apply to the domain. <br>          domain = string<br>          # The domain to apply the rule to. <br>          targets = optional(list(string), [])<br>          # The list of targets to apply the rule to - defaults to local resolver.<br>        }))<br>      })), [])<br>    }), null)<br><br>    endpoints = optional(object({<br>      # Defines the configuration for the endpoints network. <br>      network = object({<br>        # Defines the configuration for the endpoints network. <br>        availability_zones = optional(number, 2)<br>        # The number of availablity zones to use for the endpoints network. Defaults to 2. <br>        ipam_pool_id = optional(string, null)<br>        # The ID of the IPAM pool to use for the endpoints network. Defaults to null. <br>        name = optional(string, "endpoints")<br>        # The name of the endpoints network. Defaults to 'endpoints'. <br>        private_netmask = optional(number, 24)<br>        # The netmask to use for the private network. Defaults to 24, ensure space for enough aws services. <br>        vpc_cidr = optional(string, null)<br>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM <br>        vpc_netmask = optional(string, null)<br>        # The netmask to use for the VPC. Defaults to null, required when using IPAM <br>      })<br>      sharing = optional(object({<br>        # Defines the configuration for the sharing network via AWS RAM <br>        principals = optional(list(string), [])<br>        # The list of organizational units or accounts to share the endpoints resolvers rules with. Defaults to an empty list.<br>      }), null)<br>      services = optional(map(object({<br>        # Defines the configuration for the private endpoints in the shared network. <br>        private_dns_enabled = optional(bool, true)<br>        # Whether private DNS is enabled. Defaults to true. <br>        service_type = optional(string, "Interface")<br>        # The type of service, i.e. Gateway or Interface. Defaults to 'Interface'<br>        service = string<br>        # The name of the service i.e. ec2, ec2messages, ssm, ssmmessages, logs, kms, secretsmanager, s3.awsamazon.com<br>        policy = optional(string, null)<br>        # An optional IAM policy to use for the endpoint. Defaults to null.<br>        })), {<br>        ec2messages = {<br>          service = "ec2messages"<br>        },<br>        ssm = {<br>          service = "ssm"<br>        },<br>        ssmmessages = {<br>          service = "ssmmessages"<br>        },<br>      })<br>    }), null)<br>    ingress = optional(object({<br>      # Defines the configuration for the ingress network. <br>      network = object({<br>        # Defines the configuration for the ingress network. <br>        availability_zones = optional(number, 2)<br>        # The number of availablity zones to use for the ingress network. Defaults to 2. <br>        ipam_pool_id = optional(string, null)<br>        # The ID of the IPAM pool to use for the ingress network. Defaults to null. <br>        name = optional(string, "ingress")<br>        # The name of the ingress network. Defaults to 'ingress'. <br>        private_netmask = number<br>        # The netmask to use for the private network. Required, ensure space for enough aws services. <br>        public_netmask = number<br>        # The netmask to use for the public network. Required, ensure space for enough aws services. <br>        vpc_cidr = optional(string, null)<br>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM <br>        vpc_netmask = optional(string, null)<br>        # The netmask to use for the VPC. Defaults to null, required when using IPAM <br>      })<br>    }), null)<br>  })</pre> | `{}` | no |
+| <a name="input_services"></a> [services](#input\_services) | A collection of features and services associated with this connectivity domain. | <pre>object({<br/>    egress = optional(object({<br/>      network = object({<br/>        # Defines the configuration for an egress network. <br/>        availability_zones = optional(number, 2)<br/>        # The number of availablity zones to use for the egress network. Defaults to 2.<br/>        ipam_pool_id = optional(string, null)<br/>        # The ID of the IPAM pool to use for the egress network. Defaults to null. <br/>        name = optional(string, "egress")<br/>        # The name of the egress network. Defaults to 'egress'. <br/>        private_netmask = optional(number, 28)<br/>        # The netmask to use for the private network. Defaults to 28. <br/>        public_netmask = optional(number, 28)<br/>        # The netmask to use for the public network. Defaults to 28. <br/>        vpc_cidr = optional(string, null)<br/>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM<br/>        vpc_netmask = optional(string, null)<br/>        # The netmask to use for the VPC. Defaults to null, required when using IPAM<br/>      })<br/>    }), null)<br/>    dns = optional(object({<br/>      # The list of organizational units or accounts to share the domain rule with. <br/>      resolver_name = optional(string, "dns-resolver")<br/><br/>      # Defines the configuration for the endpoints network. <br/>      network = object({<br/>        # Defines the configuration for the endpoints network. <br/>        availability_zones = optional(number, 2)<br/>        # The number of availablity zones to use for the endpoints network. Defaults to 2. <br/>        ipam_pool_id = optional(string, null)<br/>        # The ID of the IPAM pool to use for the endpoints network. Defaults to null. <br/>        name = optional(string, "central-dns")<br/>        # The name of the endpoints network. Defaults to 'endpoints'. <br/>        private_netmask = optional(number, 24)<br/>        # The netmask to use for the private network. Defaults to 24, ensure space for enough aws services. <br/>        vpc_cidr = optional(string, null)<br/>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM <br/>        vpc_netmask = optional(string, null)<br/>        # The netmask to use for the VPC. Defaults to null, required when using IPAM <br/>      }),<br/><br/>      domain_rules = optional(list(object({<br/>        ram_share_name = optional(string, "central-dns")<br/>        # The name of the domain rule - this is mapped to the resource share name <br/>        ram_principals = optional(map(string), {})<br/>        # The name of the resolver to use. Defaults to 'dns-resolver'.<br/>        rules = list(object({<br/>          name = string<br/>          # The name of the rule - the ram share name is domain.name + "-" + rule.name <br/>          # The list of domain rules to apply to the domain. <br/>          domain = string<br/>          # The domain to apply the rule to. <br/>          targets = optional(list(string), [])<br/>          # The list of targets to apply the rule to - defaults to local resolver.<br/>        }))<br/>      })), [])<br/>    }), null)<br/><br/>    endpoints = optional(object({<br/>      # Defines the configuration for the endpoints network. <br/>      network = object({<br/>        # Defines the configuration for the endpoints network. <br/>        availability_zones = optional(number, 2)<br/>        # The number of availablity zones to use for the endpoints network. Defaults to 2. <br/>        ipam_pool_id = optional(string, null)<br/>        # The ID of the IPAM pool to use for the endpoints network. Defaults to null. <br/>        name = optional(string, "endpoints")<br/>        # The name of the endpoints network. Defaults to 'endpoints'. <br/>        private_netmask = optional(number, 24)<br/>        # The netmask to use for the private network. Defaults to 24, ensure space for enough aws services. <br/>        vpc_cidr = optional(string, null)<br/>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM <br/>        vpc_netmask = optional(string, null)<br/>        # The netmask to use for the VPC. Defaults to null, required when using IPAM <br/>      })<br/>      sharing = optional(object({<br/>        # Defines the configuration for the sharing network via AWS RAM <br/>        principals = optional(list(string), [])<br/>        # The list of organizational units or accounts to share the endpoints resolvers rules with. Defaults to an empty list.<br/>      }), null)<br/>      services = optional(map(object({<br/>        # Defines the configuration for the private endpoints in the shared network. <br/>        private_dns_enabled = optional(bool, true)<br/>        # Whether private DNS is enabled. Defaults to true. <br/>        service_type = optional(string, "Interface")<br/>        # The type of service, i.e. Gateway or Interface. Defaults to 'Interface'<br/>        service = string<br/>        # The name of the service i.e. ec2, ec2messages, ssm, ssmmessages, logs, kms, secretsmanager, s3.awsamazon.com<br/>        policy = optional(string, null)<br/>        # An optional IAM policy to use for the endpoint. Defaults to null.<br/>        })), {<br/>        ec2messages = {<br/>          service = "ec2messages"<br/>        },<br/>        ssm = {<br/>          service = "ssm"<br/>        },<br/>        ssmmessages = {<br/>          service = "ssmmessages"<br/>        },<br/>      })<br/>    }), null)<br/>    ingress = optional(object({<br/>      # Defines the configuration for the ingress network. <br/>      network = object({<br/>        # Defines the configuration for the ingress network. <br/>        availability_zones = optional(number, 2)<br/>        # The number of availablity zones to use for the ingress network. Defaults to 2. <br/>        ipam_pool_id = optional(string, null)<br/>        # The ID of the IPAM pool to use for the ingress network. Defaults to null. <br/>        name = optional(string, "ingress")<br/>        # The name of the ingress network. Defaults to 'ingress'. <br/>        private_netmask = number<br/>        # The netmask to use for the private network. Required, ensure space for enough aws services. <br/>        public_netmask = number<br/>        # The netmask to use for the public network. Required, ensure space for enough aws services. <br/>        vpc_cidr = optional(string, null)<br/>        # The CIDR block to use for the VPC. Defaults to null, required when not using IPAM <br/>        vpc_netmask = optional(string, null)<br/>        # The netmask to use for the VPC. Defaults to null, required when using IPAM <br/>      })<br/>    }), null)<br/>  })</pre> | `{}` | no |
 
 ## Outputs