Skip to content

googleComputeVpnTunnel

VPN tunnel resource.

To get more information about VpnTunnel, see:

\~> Warning: All arguments including sharedSecret will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage - Vpn Tunnel Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleComputeAddressVpnStaticIp =
  new google.computeAddress.ComputeAddress(this, "vpn_static_ip", {
    name: "vpn-static-ip",
  });
const googleComputeNetworkNetwork1 = new google.computeNetwork.ComputeNetwork(
  this,
  "network1",
  {
    name: "network-1",
  }
);
const googleComputeVpnGatewayTargetGateway =
  new google.computeVpnGateway.ComputeVpnGateway(this, "target_gateway", {
    name: "vpn-1",
    network: googleComputeNetworkNetwork1.id,
  });
const googleComputeForwardingRuleFrEsp =
  new google.computeForwardingRule.ComputeForwardingRule(this, "fr_esp", {
    ip_address: googleComputeAddressVpnStaticIp.address,
    ip_protocol: "ESP",
    name: "fr-esp",
    target: googleComputeVpnGatewayTargetGateway.id,
  });
const googleComputeForwardingRuleFrUdp4500 =
  new google.computeForwardingRule.ComputeForwardingRule(this, "fr_udp4500", {
    ip_address: googleComputeAddressVpnStaticIp.address,
    ip_protocol: "UDP",
    name: "fr-udp4500",
    port_range: "4500",
    target: googleComputeVpnGatewayTargetGateway.id,
  });
const googleComputeForwardingRuleFrUdp500 =
  new google.computeForwardingRule.ComputeForwardingRule(this, "fr_udp500", {
    ip_address: googleComputeAddressVpnStaticIp.address,
    ip_protocol: "UDP",
    name: "fr-udp500",
    port_range: "500",
    target: googleComputeVpnGatewayTargetGateway.id,
  });
const googleComputeVpnTunnelTunnel1 =
  new google.computeVpnTunnel.ComputeVpnTunnel(this, "tunnel1", {
    depends_on: [
      `\${${googleComputeForwardingRuleFrEsp.fqn}}`,
      `\${${googleComputeForwardingRuleFrUdp500.fqn}}`,
      `\${${googleComputeForwardingRuleFrUdp4500.fqn}}`,
    ],
    name: "tunnel-1",
    peer_ip: "15.0.0.120",
    shared_secret: "a secret message",
    target_vpn_gateway: googleComputeVpnGatewayTargetGateway.id,
  });
new google.computeRoute.ComputeRoute(this, "route1", {
  dest_range: "15.0.0.0/24",
  name: "route1",
  network: googleComputeNetworkNetwork1.name,
  next_hop_vpn_tunnel: googleComputeVpnTunnelTunnel1.id,
  priority: 1000,
});

Example Usage - Vpn Tunnel Beta

resource "google_compute_vpn_tunnel" "tunnel1" {
  provider      = google-beta
  name          = "tunnel-1"
  peer_ip       = "15.0.0.120"
  shared_secret = "a secret message"

  target_vpn_gateway = google_compute_vpn_gateway.target_gateway.id

  depends_on = [
    google_compute_forwarding_rule.fr_esp,
    google_compute_forwarding_rule.fr_udp500,
    google_compute_forwarding_rule.fr_udp4500,
  ]

  labels = {
    foo = "bar"
  }
}

resource "google_compute_vpn_gateway" "target_gateway" {
  provider = google-beta
  name     = "vpn-1"
  network  = google_compute_network.network1.id
}

resource "google_compute_network" "network1" {
  provider = google-beta
  name     = "network-1"
}

resource "google_compute_address" "vpn_static_ip" {
  provider = google-beta
  name     = "vpn-static-ip"
}

resource "google_compute_forwarding_rule" "fr_esp" {
  provider    = google-beta
  name        = "fr-esp"
  ip_protocol = "ESP"
  ip_address  = google_compute_address.vpn_static_ip.address
  target      = google_compute_vpn_gateway.target_gateway.id
}

resource "google_compute_forwarding_rule" "fr_udp500" {
  provider    = google-beta
  name        = "fr-udp500"
  ip_protocol = "UDP"
  port_range  = "500"
  ip_address  = google_compute_address.vpn_static_ip.address
  target      = google_compute_vpn_gateway.target_gateway.id
}

resource "google_compute_forwarding_rule" "fr_udp4500" {
  provider    = google-beta
  name        = "fr-udp4500"
  ip_protocol = "UDP"
  port_range  = "4500"
  ip_address  = google_compute_address.vpn_static_ip.address
  target      = google_compute_vpn_gateway.target_gateway.id
}

resource "google_compute_route" "route1" {
  provider   = google-beta
  name       = "route1"
  network    = google_compute_network.network1.name
  dest_range = "15.0.0.0/24"
  priority   = 1000

  next_hop_vpn_tunnel = google_compute_vpn_tunnel.tunnel1.id
}

provider "google-beta" {
  region = "us-central1"
  zone   = "us-central1-a"

}

Argument Reference

The following arguments are supported:

  • name - (Required) Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [aZ]([AZ09]*[aZ09])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

  • sharedSecret - (Required) Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. Note: This property is sensitive and will not be displayed in the plan.


  • description - (Optional) An optional description of this resource.

  • targetVpnGateway - (Optional) URL of the Target VPN gateway with which this VPN tunnel is associated.

  • vpnGateway - (Optional) URL of the VPN gateway with which this VPN tunnel is associated. This must be used if a High Availability VPN gateway resource is created. This field must reference a googleComputeHaVpnGateway resource.

  • vpnGatewayInterface - (Optional) The interface ID of the VPN gateway with which this VPN tunnel is associated.

  • peerExternalGateway - (Optional) URL of the peer side external VPN gateway to which this VPN tunnel is connected.

  • peerExternalGatewayInterface - (Optional) The interface ID of the external VPN gateway to which this VPN tunnel is connected.

  • peerGcpGateway - (Optional) URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. If provided, the VPN tunnel will automatically use the same vpn_gateway_interface ID in the peer GCP VPN gateway. This field must reference a googleComputeHaVpnGateway resource.

  • router - (Optional) URL of router resource to be used for dynamic routing.

  • peerIp - (Optional) IP address of the peer VPN gateway. Only IPv4 is supported.

  • ikeVersion - (Optional) IKE protocol version to use when establishing the VPN tunnel with peer VPN gateway. Acceptable IKE versions are 1 or 2. Default version is 2.

  • localTrafficSelector - (Optional) Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example 19216800/16. The ranges should be disjoint. Only IPv4 is supported.

  • remoteTrafficSelector - (Optional) Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example 19216800/16. The ranges should be disjoint. Only IPv4 is supported.

  • labels - (Optional, Beta) Labels to apply to this VpnTunnel.

  • region - (Optional) The region where the tunnel is located. If unset, is set to the region of targetVpnGateway.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}

  • tunnelId - The unique identifier for the resource. This identifier is defined by the server.

  • creationTimestamp - Creation timestamp in RFC3339 text format.

  • sharedSecretHash - Hash of the shared secret.

  • labelFingerprint - (Beta) The fingerprint used for optimistic locking of this resource. Used internally during updates.

  • detailedStatus - Detailed status message for the VPN tunnel.

  • selfLink - The URI of the created resource.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

VpnTunnel can be imported using any of these accepted formats:

$ terraform import google_compute_vpn_tunnel.default projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}
$ terraform import google_compute_vpn_tunnel.default {{project}}/{{region}}/{{name}}
$ terraform import google_compute_vpn_tunnel.default {{region}}/{{name}}
$ terraform import google_compute_vpn_tunnel.default {{name}}

User Project Overrides

This resource supports User Project Overrides.