cloud-foundation-fabric/modules/net-cloudnat/README.md

# Cloud NAT Module

Simple Cloud NAT management, with optional router creation.

## Example

```hcl
module "nat" {
  source         = "../modules/net-cloudnat"
  project_id     = "my-project"
  region         = "europe-west1"
  name           = "default"
  router_network = "my-vpc"
}
```

<!-- BEGIN TFDOC -->
## Variables

| name | description | type | required | default |
|---|---|:---: |:---:|:---:|
| name | Name of the Cloud NAT resource. | <code title="">string</code> | ✓ |  |
| project_id | Project where resources will be created. | <code title="">string</code> | ✓ |  |
| region | Region where resources will be created. | <code title="">string</code> | ✓ |  |
| *addresses* | Optional list of external address self links. | <code title="list&#40;string&#41;">list(string)</code> |  | <code title="">[]</code> |
| *config_min_ports_per_vm* | Minimum number of ports allocated to a VM from this NAT config. | <code title="">number</code> |  | <code title="">64</code> |
| *config_source_subnets* | Subnetwork configuration (ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS). | <code title="">string</code> |  | <code title="">ALL_SUBNETWORKS_ALL_IP_RANGES</code> |
| *config_timeouts* | Timeout configurations. | <code title="object&#40;&#123;&#10;icmp            &#61; number&#10;tcp_established &#61; number&#10;tcp_transitory  &#61; number&#10;udp             &#61; number&#10;&#125;&#41;">object({...})</code> |  | <code title="&#123;&#10;icmp            &#61; 30&#10;tcp_established &#61; 1200&#10;tcp_transitory  &#61; 30&#10;udp             &#61; 30&#10;&#125;">...</code> |
| *router_asn* | Router ASN used for auto-created router. | <code title="">number</code> |  | <code title="">64514</code> |
| *router_create* | Create router. | <code title="">bool</code> |  | <code title="">true</code> |
| *router_name* | Router name, leave blank if router will be created to use auto generated name. | <code title="">string</code> |  | <code title=""></code> |
| *router_network* | Name of the VPC used for auto-created router. | <code title="">string</code> |  | <code title=""></code> |
| *subnetworks* | Subnetworks to NAT, only used when config_source_subnets equals LIST_OF_SUBNETWORKS. | <code title="list&#40;object&#40;&#123;&#10;self_link            &#61; string,&#10;config_source_ranges &#61; list&#40;string&#41;&#10;secondary_ranges     &#61; list&#40;string&#41;&#10;&#125;&#41;&#41;">list(object({...}))</code> |  | <code title="">[]</code> |

## Outputs

| name | description | sensitive |
|---|---|:---:|
| name | Name of the Cloud NAT. |  |
| nat_ip_allocate_option | NAT IP allocation mode. |  |
| region | Cloud NAT region. |  |
| router | Cloud NAT router resources (if auto created). |  |
| router_name | Cloud NAT router name. |  |
<!-- END TFDOC -->