|
| 1 | +# Module documentation |
| 2 | + |
| 3 | +## Required Inputs |
| 4 | + |
| 5 | +The following input variables are required: |
| 6 | + |
| 7 | +### <a name="input_name"></a> [name](#input\_name) |
| 8 | + |
| 9 | +Description: The name of the NAT gateway. |
| 10 | + |
| 11 | +Type: `string` |
| 12 | + |
| 13 | +### <a name="input_public_ip_name"></a> [public\_ip\_name](#input\_public\_ip\_name) |
| 14 | + |
| 15 | +Description: The name of the public IP address resource created for the NAT gateway. |
| 16 | + |
| 17 | +Type: `string` |
| 18 | + |
| 19 | +### <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) |
| 20 | + |
| 21 | +Description: The name of the resource group in which to create the NAT gateway. |
| 22 | + |
| 23 | +Type: `string` |
| 24 | + |
| 25 | +### <a name="input_subnet_id"></a> [subnet\_id](#input\_subnet\_id) |
| 26 | + |
| 27 | +Description: The ID of the subnet to associate with the NAT gateway. |
| 28 | + |
| 29 | +Type: `string` |
| 30 | + |
| 31 | +## Optional Inputs |
| 32 | + |
| 33 | +The following input variables are optional (have default values): |
| 34 | + |
| 35 | +### <a name="input_idle_timeout_in_minutes"></a> [idle\_timeout\_in\_minutes](#input\_idle\_timeout\_in\_minutes) |
| 36 | + |
| 37 | +Description: The idle timeout in minutes for the NAT gateway. Must be between 4 and 120. |
| 38 | + |
| 39 | +Type: `number` |
| 40 | + |
| 41 | +Default: `4` |
| 42 | + |
| 43 | +### <a name="input_location"></a> [location](#input\_location) |
| 44 | + |
| 45 | +Description: The location/region where the NAT gateway will be created. |
| 46 | + |
| 47 | +Type: `string` |
| 48 | + |
| 49 | +Default: `"uksouth"` |
| 50 | + |
| 51 | +### <a name="input_tags"></a> [tags](#input\_tags) |
| 52 | + |
| 53 | +Description: A mapping of tags to assign to the resource. |
| 54 | + |
| 55 | +Type: `map(string)` |
| 56 | + |
| 57 | +Default: `{}` |
| 58 | + |
| 59 | +### <a name="input_zones"></a> [zones](#input\_zones) |
| 60 | + |
| 61 | +Description: Availability zones for the NAT gateway and its public IP. Use ["1"] for a zonal deployment. An empty list deploys with no zone redundancy. |
| 62 | + |
| 63 | +Type: `list(string)` |
| 64 | + |
| 65 | +Default: `[]` |
| 66 | +## Modules |
| 67 | + |
| 68 | +The following Modules are called: |
| 69 | + |
| 70 | +### <a name="module_pip"></a> [pip](#module\_pip) |
| 71 | + |
| 72 | +Source: ../public-ip |
| 73 | + |
| 74 | +Version: |
| 75 | +## Outputs |
| 76 | + |
| 77 | +The following outputs are exported: |
| 78 | + |
| 79 | +### <a name="output_id"></a> [id](#output\_id) |
| 80 | + |
| 81 | +Description: The ID of the NAT gateway. |
| 82 | + |
| 83 | +### <a name="output_name"></a> [name](#output\_name) |
| 84 | + |
| 85 | +Description: The name of the NAT gateway. |
| 86 | + |
| 87 | +### <a name="output_public_ip_address"></a> [public\_ip\_address](#output\_public\_ip\_address) |
| 88 | + |
| 89 | +Description: The public IP address associated with the NAT gateway. |
| 90 | +## Resources |
| 91 | + |
| 92 | +The following resources are used by this module: |
| 93 | + |
| 94 | +- [azurerm_nat_gateway.nat_gateway](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/nat_gateway) (resource) |
| 95 | +- [azurerm_nat_gateway_public_ip_association.nat_gateway_pip](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/nat_gateway_public_ip_association) (resource) |
| 96 | +- [azurerm_subnet_nat_gateway_association.nat_gateway_subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet_nat_gateway_association) (resource) |
0 commit comments