|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "stackit_vpn_gateway Resource - stackit" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + VPN Gateway resource schema. Uses the default_region specified in the provider configuration as a fallback in case no region is defined on resource level. |
| 7 | +--- |
| 8 | + |
| 9 | +# stackit_vpn_gateway (Resource) |
| 10 | + |
| 11 | +VPN Gateway resource schema. Uses the `default_region` specified in the provider configuration as a fallback in case no `region` is defined on resource level. |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 15 | +```terraform |
| 16 | +resource "stackit_vpn_gateway" "example" { |
| 17 | + project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" |
| 18 | + display_name = "example-vpn-gateway" |
| 19 | + plan_id = "p500" |
| 20 | + routing_type = "ROUTE_BASED" |
| 21 | +
|
| 22 | + availability_zones = { |
| 23 | + tunnel1 = "eu01-1" |
| 24 | + tunnel2 = "eu01-2" |
| 25 | + } |
| 26 | +} |
| 27 | +
|
| 28 | +# Only use the import statement, if you want to import an existing VPN gateway |
| 29 | +import { |
| 30 | + to = stackit_vpn_gateway.example |
| 31 | + id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,eu01,xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" |
| 32 | +} |
| 33 | +``` |
| 34 | + |
| 35 | +<!-- schema generated by tfplugindocs --> |
| 36 | +## Schema |
| 37 | + |
| 38 | +### Required |
| 39 | + |
| 40 | +- `availability_zones` (Attributes) Availability zones for the two tunnel endpoints. (see [below for nested schema](#nestedatt--availability_zones)) |
| 41 | +- `display_name` (String) A user-friendly name for the VPN gateway. |
| 42 | +- `plan_id` (String) The service plan identifier (e.g. `p500`). For guidance on finding available plans, see [List available service plans](https://docs.stackit.cloud/products/network/connectivity-hybrid-multi-cloud/vpn/getting-started/gateway-create/#list-available-service-plans). |
| 43 | +- `project_id` (String) STACKIT project ID associated with the VPN gateway. |
| 44 | +- `routing_type` (String) Routing architecture. Possible values are: `POLICY_BASED`, `ROUTE_BASED`, `BGP_ROUTE_BASED`. |
| 45 | + |
| 46 | +### Optional |
| 47 | + |
| 48 | +- `bgp` (Attributes) BGP configuration. Only applicable when routing_type is BGP_ROUTE_BASED. (see [below for nested schema](#nestedatt--bgp)) |
| 49 | +- `labels` (Map of String) Map of custom labels (key-value string pairs). |
| 50 | +- `region` (String) STACKIT region name the resource is located in. If not defined, the provider region is used. |
| 51 | + |
| 52 | +### Read-Only |
| 53 | + |
| 54 | +- `gateway_id` (String) The server-generated UUID of the VPN gateway. |
| 55 | +- `id` (String) Terraform's internal resource identifier. Structured as "`project_id`,`region`,`gateway_id`". |
| 56 | +- `state` (String) The current lifecycle state of the gateway. Possible values are: `PENDING`, `READY`, `ERROR`, `DELETING`. |
| 57 | + |
| 58 | +<a id="nestedatt--availability_zones"></a> |
| 59 | +### Nested Schema for `availability_zones` |
| 60 | + |
| 61 | +Required: |
| 62 | + |
| 63 | +- `tunnel1` (String) Availability zone for tunnel 1. |
| 64 | +- `tunnel2` (String) Availability zone for tunnel 2. |
| 65 | + |
| 66 | + |
| 67 | +<a id="nestedatt--bgp"></a> |
| 68 | +### Nested Schema for `bgp` |
| 69 | + |
| 70 | +Required: |
| 71 | + |
| 72 | +- `local_asn` (Number) Local ASN for BGP (private ASN range, 64512-4294967294). |
| 73 | + |
| 74 | +Optional: |
| 75 | + |
| 76 | +- `override_advertised_routes` (List of String) List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised. |
0 commit comments