History

Ludovico Magnocavallo 1ac3fe4460 New tfdoc version (#396 ) * update tfdoc * rewrite check docs, refactor tfdoc replace, regenerate modules READMEs * remove dead code from check docs * do not fail on missing variable files in check docs * fix typos		2021-12-21 08:51:51 +01:00
..
README.md	New tfdoc version (#396 )	2021-12-21 08:51:51 +01:00
main.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
outputs.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
variables.tf	Update copyright to 2021	2021-02-15 09:38:10 +01:00
versions.tf	Use the same versions file everywhere, pin to tf 1.0+ provider 4.0+ (#355 )	2021-11-03 15:05:43 +01:00

README.md

Cloud NAT Module

Simple Cloud NAT management, with optional router creation.

Example

module "nat" {
  source         = "./modules/net-cloudnat"
  project_id     = "my-project"
  region         = "europe-west1"
  name           = "default"
  router_network = "my-vpc"
}
# tftest:modules=1:resources=2

Variables

name	description	type	required	default
name	Name of the Cloud NAT resource.	`string`	✓
project_id	Project where resources will be created.	`string`	✓
region	Region where resources will be created.	`string`	✓
addresses	Optional list of external address self links.	`list(string)`		`[]`
config_min_ports_per_vm	Minimum number of ports allocated to a VM from this NAT config.	`number`		`64`
config_source_subnets	Subnetwork configuration (ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS).	`string`		`"ALL_SUBNETWORKS_ALL_IP_RANGES"`
config_timeouts	Timeout configurations.	`object({…})`		`{…}`
logging_filter	Enables logging if not null, value is one of 'ERRORS_ONLY', 'TRANSLATIONS_ONLY', 'ALL'.	`string`		`null`
router_asn	Router ASN used for auto-created router.	`number`		`64514`
router_create	Create router.	`bool`		`true`
router_name	Router name, leave blank if router will be created to use auto generated name.	`string`		`null`
router_network	Name of the VPC used for auto-created router.	`string`		`null`
subnetworks	Subnetworks to NAT, only used when config_source_subnets equals LIST_OF_SUBNETWORKS.	`list(object({…}))`		`[]`

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.