Skip to content

Commit d861e3a

Browse files
committed
chore(deps): updating the documentation, as the version of the terraform-docs has changed
1 parent 75e3174 commit d861e3a

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ The `terraform-docs` utility is used to generate this README. Follow the below s
8484

8585
| Name | Description | Type | Default | Required |
8686
|------|-------------|------|---------|:--------:|
87-
| <a name="input_network"></a> [network](#input\_network) | The network to use for the endpoints and optinal resolvers | <pre>object({<br> availability_zones = optional(number, 2)<br> # Whether to use ipam when creating the network<br> create = optional(bool, true)<br> # Indicates if we should create a new network or reuse an existing one<br> enable_default_route_table_association = optional(bool, true)<br> # Whether to associate the default route table <br> enable_default_route_table_propagation = optional(bool, true)<br> # Whether to propagate the default route table<br> ipam_pool_id = optional(string, null)<br> # The id of the ipam pool to use when creating the network<br> name = optional(string, "central-dns")<br> # The name of the network to create<br> private_netmask = optional(number, 24)<br> # The subnet mask for private subnets, when creating the network i.e subnet-id => 10.90.0.0/24<br> private_subnet_ids = optional(list(string), [])<br> # The ids of the private subnets to if we are reusing an existing network<br> transit_gateway_id = optional(string, "")<br> ## The transit gateway id to use for the network<br> vpc_cidr = optional(string, "")<br> # The cidrws range to use for the VPC, when creating the network<br> vpc_id = optional(string, "")<br> # The vpc id to use when reusing an existing network <br> vpc_netmask = optional(number, null)<br> # When using ipam this the netmask to use for the VPC<br> })</pre> | n/a | yes |
87+
| <a name="input_network"></a> [network](#input\_network) | The network to use for the endpoints and optinal resolvers | <pre>object({<br/> availability_zones = optional(number, 2)<br/> # Whether to use ipam when creating the network<br/> create = optional(bool, true)<br/> # Indicates if we should create a new network or reuse an existing one<br/> enable_default_route_table_association = optional(bool, true)<br/> # Whether to associate the default route table <br/> enable_default_route_table_propagation = optional(bool, true)<br/> # Whether to propagate the default route table<br/> ipam_pool_id = optional(string, null)<br/> # The id of the ipam pool to use when creating the network<br/> name = optional(string, "central-dns")<br/> # The name of the network to create<br/> private_netmask = optional(number, 24)<br/> # The subnet mask for private subnets, when creating the network i.e subnet-id => 10.90.0.0/24<br/> private_subnet_ids = optional(list(string), [])<br/> # The ids of the private subnets to if we are reusing an existing network<br/> transit_gateway_id = optional(string, "")<br/> ## The transit gateway id to use for the network<br/> vpc_cidr = optional(string, "")<br/> # The cidrws range to use for the VPC, when creating the network<br/> vpc_id = optional(string, "")<br/> # The vpc id to use when reusing an existing network <br/> vpc_netmask = optional(number, null)<br/> # When using ipam this the netmask to use for the VPC<br/> })</pre> | n/a | yes |
8888
| <a name="input_resolver_name"></a> [resolver\_name](#input\_resolver\_name) | Name of the Route53 resolver endpoint | `string` | n/a | yes |
8989
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | n/a | yes |
9090
| <a name="input_resolver_endpoint_type"></a> [resolver\_endpoint\_type](#input\_resolver\_endpoint\_type) | The Route 53 Resolver endpoint IP address type. Valid values: IPV4, IPV6, DUALSTACK. | `string` | `"IPV4"` | no |
91-
| <a name="input_resolver_protocols"></a> [resolver\_protocols](#input\_resolver\_protocols) | List of protocols that the Route53 Outbound Resolver should support | `list(string)` | <pre>[<br> "Do53",<br> "DoH"<br>]</pre> | no |
92-
| <a name="input_resolver_rule_groups"></a> [resolver\_rule\_groups](#input\_resolver\_rule\_groups) | Map of Route53 Resolver Rules by group. Every rule in each group can be shared with principals via AWS RAM. | <pre>list(object({<br> ram_share_name = string<br> # The share share name will be the ram_share_name '-' rule_name<br> ram_principals = optional(map(string), {})<br> ## A map of principals to share the rules with i.e. Infrastructure OU => ou-1234567890<br> rules = list(object({<br> name = string<br> ## The name of the rule, used when creating the ram share <br> domain = string<br> ## The domain to forward the query to <br> targets = optional(list(string), [])<br> ## The name of the resolver rule<br> rule_type = optional(string, "FORWARD")<br> ## The type of rule to create <br> }))<br> ## A list of rules to create in the group <br> }))</pre> | `[]` | no |
91+
| <a name="input_resolver_protocols"></a> [resolver\_protocols](#input\_resolver\_protocols) | List of protocols that the Route53 Outbound Resolver should support | `list(string)` | <pre>[<br/> "Do53",<br/> "DoH"<br/>]</pre> | no |
92+
| <a name="input_resolver_rule_groups"></a> [resolver\_rule\_groups](#input\_resolver\_rule\_groups) | Map of Route53 Resolver Rules by group. Every rule in each group can be shared with principals via AWS RAM. | <pre>list(object({<br/> ram_share_name = string<br/> # The share share name will be the ram_share_name '-' rule_name<br/> ram_principals = optional(map(string), {})<br/> ## A map of principals to share the rules with i.e. Infrastructure OU => ou-1234567890<br/> rules = list(object({<br/> name = string<br/> ## The name of the rule, used when creating the ram share <br/> domain = string<br/> ## The domain to forward the query to <br/> targets = optional(list(string), [])<br/> ## The name of the resolver rule<br/> rule_type = optional(string, "FORWARD")<br/> ## The type of rule to create <br/> }))<br/> ## A list of rules to create in the group <br/> }))</pre> | `[]` | no |
9393
| <a name="input_route53_zone_ids"></a> [route53\_zone\_ids](#input\_route53\_zone\_ids) | List of Route53 Zone IDs to be associated with the resolver VPC. | `list(string)` | `[]` | no |
9494

9595
## Outputs

examples/complete/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ No resources.
2424

2525
| Name | Description | Type | Default | Required |
2626
|------|-------------|------|---------|:--------:|
27-
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | <pre>{<br> "Environment": "Testing",<br> "GitRepo": "https://github.com/appvia/terraform-aws-dns"<br>}</pre> | no |
27+
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | <pre>{<br/> "Environment": "Testing",<br/> "GitRepo": "https://github.com/appvia/terraform-aws-dns"<br/>}</pre> | no |
2828
| <a name="input_transit_gateway_id"></a> [transit\_gateway\_id](#input\_transit\_gateway\_id) | The id of the transit gateway to use for the network | `string` | `"tgw-04ad8f026be8b7eb6"` | no |
2929

3030
## Outputs

examples/reuse/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ No resources.
3535
| Name | Description | Type | Default | Required |
3636
|------|-------------|------|---------|:--------:|
3737
| <a name="input_ipam_pool_id"></a> [ipam\_pool\_id](#input\_ipam\_pool\_id) | The id of the ipam pool to use when creating the network | `string` | `"ipam-pool-054836edbcccd8983"` | no |
38-
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | <pre>{<br> "Environment": "Testing",<br> "GitRepo": "https://github.com/appvia/terraform-aws-dns"<br>}</pre> | no |
38+
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | <pre>{<br/> "Environment": "Testing",<br/> "GitRepo": "https://github.com/appvia/terraform-aws-dns"<br/>}</pre> | no |
3939
| <a name="input_transit_gateway_id"></a> [transit\_gateway\_id](#input\_transit\_gateway\_id) | The id of the transit gateway to use for the network | `string` | `"tgw-04ad8f026be8b7eb6"` | no |
4040

4141
## Outputs

0 commit comments

Comments
 (0)