|
3 | 3 | Creates a site-to-site VPN connection intended to terminate to a FortiGate firewall. Creates a template configuration file that can be used to easily configure the connection. |
4 | 4 |
|
5 | 5 | <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> |
| 6 | +## Requirements |
| 7 | + |
| 8 | +| Name | Version | |
| 9 | +|------|---------| |
| 10 | +| terraform | >= 0.12 | |
| 11 | + |
| 12 | +## Providers |
| 13 | + |
| 14 | +| Name | Version | |
| 15 | +|------|---------| |
| 16 | +| aws | n/a | |
| 17 | +| local | n/a | |
| 18 | + |
6 | 19 | ## Inputs |
7 | 20 |
|
8 | 21 | | Name | Description | Type | Default | Required | |
9 | | -|------|-------------|:----:|:-----:|:-----:| |
10 | | -| account\_name | Name for AWS account side of tunnel | string | n/a | yes | |
11 | | -| customer\_bgp\_asn | BGP for customer side of tunnel | number | n/a | yes | |
12 | | -| customer\_gateway\_type | Type for customer gateway | string | `"ipsec.1"` | no | |
13 | | -| customer\_ip\_address | IP address for customer side | string | n/a | yes | |
14 | | -| customer\_name | Name for customer side of tunnel | string | n/a | yes | |
15 | | -| generate\_fortigate\_config | Generate a FortiGate config template \(does not include PSKs\) | bool | `"true"` | no | |
16 | | -| tags | Tags to add to supported resources | string | n/a | yes | |
17 | | -| transit\_gateway\_id | Transit gateway to attach VPN to \(required if `vpn\_gateway\_id` not set\) | string | `"null"` | no | |
18 | | -| tunnel1\_inside\_cidr | Specify a Tunnel 1 inside CIDR \(optional\) | string | `""` | no | |
19 | | -| tunnel1\_psk | Specify a Tunnel 1 PSK explicitly \(optional\) | string | `""` | no | |
20 | | -| tunnel1\_psk\_version | Version to use for PSK \(increment to generate a new PSK\) | number | `"1"` | no | |
21 | | -| tunnel2\_inside\_cidr | Specify a Tunnel 2 inside CIDR \(optional\) | string | `""` | no | |
22 | | -| tunnel2\_psk | Specify a Tunnel 2 PSK explicitly \(optional\) | string | `""` | no | |
23 | | -| tunnel2\_psk\_version | Version to use for PSK \(increment to generate a new PSK\) | number | `"1"` | no | |
24 | | -| use\_secrets\_manager | Use Secrets Manager to store/manage PSKs | bool | `"true"` | no | |
25 | | -| vgw\_id | Virtual Private Gateway to attach VPN to \(required if `transit\_gateway\_id` not set\) | string | `"null"` | no | |
26 | | -| wan\_interface | WAN interface to use in fortigate config template | string | `"wan1"` | no | |
| 22 | +|------|-------------|------|---------|:--------:| |
| 23 | +| account\_name | Name for AWS account side of tunnel | `string` | n/a | yes | |
| 24 | +| customer\_bgp\_asn | BGP for customer side of tunnel | `number` | n/a | yes | |
| 25 | +| customer\_gateway\_type | Type for customer gateway | `string` | `"ipsec.1"` | no | |
| 26 | +| customer\_ip\_address | IP address for customer side | `string` | n/a | yes | |
| 27 | +| customer\_name | Name for customer side of tunnel | `string` | n/a | yes | |
| 28 | +| generate\_fortigate\_config | Generate a FortiGate config template (does not include PSKs) | `bool` | `true` | no | |
| 29 | +| tags | Tags to add to supported resources | `any` | n/a | yes | |
| 30 | +| transit\_gateway\_id | Transit gateway to attach VPN to (required if `vpn_gateway_id` not set) | `string` | `null` | no | |
| 31 | +| tunnel1\_inside\_cidr | Specify a Tunnel 1 inside CIDR (optional) | `string` | `""` | no | |
| 32 | +| tunnel1\_psk | Specify a Tunnel 1 PSK explicitly (optional) | `string` | `""` | no | |
| 33 | +| tunnel1\_psk\_version | Version to use for PSK (increment to generate a new PSK) | `number` | `1` | no | |
| 34 | +| tunnel2\_inside\_cidr | Specify a Tunnel 2 inside CIDR (optional) | `string` | `""` | no | |
| 35 | +| tunnel2\_psk | Specify a Tunnel 2 PSK explicitly (optional) | `string` | `""` | no | |
| 36 | +| tunnel2\_psk\_version | Version to use for PSK (increment to generate a new PSK) | `number` | `1` | no | |
| 37 | +| use\_secrets\_manager | Use Secrets Manager to store/manage PSKs | `bool` | `true` | no | |
| 38 | +| vgw\_id | Virtual Private Gateway to attach VPN to (required if `transit_gateway_id` not set) | `string` | `null` | no | |
| 39 | +| wan\_interface | WAN interface to use in fortigate config template | `string` | `"wan1"` | no | |
27 | 40 |
|
28 | 41 | ## Outputs |
29 | 42 |
|
|
0 commit comments