gcp.compute.VPNTunnel
Explore with Pulumi AI
VPN tunnel resource.
To get more information about VpnTunnel, see:
Example Usage
Vpn Tunnel Basic
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var network1 = new Gcp.Compute.Network("network1");
var targetGateway = new Gcp.Compute.VPNGateway("targetGateway", new()
{
Network = network1.Id,
});
var vpnStaticIp = new Gcp.Compute.Address("vpnStaticIp");
var frEsp = new Gcp.Compute.ForwardingRule("frEsp", new()
{
IpProtocol = "ESP",
IpAddress = vpnStaticIp.IPAddress,
Target = targetGateway.Id,
});
var frUdp500 = new Gcp.Compute.ForwardingRule("frUdp500", new()
{
IpProtocol = "UDP",
PortRange = "500",
IpAddress = vpnStaticIp.IPAddress,
Target = targetGateway.Id,
});
var frUdp4500 = new Gcp.Compute.ForwardingRule("frUdp4500", new()
{
IpProtocol = "UDP",
PortRange = "4500",
IpAddress = vpnStaticIp.IPAddress,
Target = targetGateway.Id,
});
var tunnel1 = new Gcp.Compute.VPNTunnel("tunnel1", new()
{
PeerIp = "15.0.0.120",
SharedSecret = "a secret message",
TargetVpnGateway = targetGateway.Id,
Labels =
{
{ "foo", "bar" },
},
}, new CustomResourceOptions
{
DependsOn = new[]
{
frEsp,
frUdp500,
frUdp4500,
},
});
var route1 = new Gcp.Compute.Route("route1", new()
{
Network = network1.Name,
DestRange = "15.0.0.0/24",
Priority = 1000,
NextHopVpnTunnel = tunnel1.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
network1, err := compute.NewNetwork(ctx, "network1", nil)
if err != nil {
return err
}
targetGateway, err := compute.NewVPNGateway(ctx, "targetGateway", &compute.VPNGatewayArgs{
Network: network1.ID(),
})
if err != nil {
return err
}
vpnStaticIp, err := compute.NewAddress(ctx, "vpnStaticIp", nil)
if err != nil {
return err
}
frEsp, err := compute.NewForwardingRule(ctx, "frEsp", &compute.ForwardingRuleArgs{
IpProtocol: pulumi.String("ESP"),
IpAddress: vpnStaticIp.Address,
Target: targetGateway.ID(),
})
if err != nil {
return err
}
frUdp500, err := compute.NewForwardingRule(ctx, "frUdp500", &compute.ForwardingRuleArgs{
IpProtocol: pulumi.String("UDP"),
PortRange: pulumi.String("500"),
IpAddress: vpnStaticIp.Address,
Target: targetGateway.ID(),
})
if err != nil {
return err
}
frUdp4500, err := compute.NewForwardingRule(ctx, "frUdp4500", &compute.ForwardingRuleArgs{
IpProtocol: pulumi.String("UDP"),
PortRange: pulumi.String("4500"),
IpAddress: vpnStaticIp.Address,
Target: targetGateway.ID(),
})
if err != nil {
return err
}
tunnel1, err := compute.NewVPNTunnel(ctx, "tunnel1", &compute.VPNTunnelArgs{
PeerIp: pulumi.String("15.0.0.120"),
SharedSecret: pulumi.String("a secret message"),
TargetVpnGateway: targetGateway.ID(),
Labels: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
}, pulumi.DependsOn([]pulumi.Resource{
frEsp,
frUdp500,
frUdp4500,
}))
if err != nil {
return err
}
_, err = compute.NewRoute(ctx, "route1", &compute.RouteArgs{
Network: network1.Name,
DestRange: pulumi.String("15.0.0.0/24"),
Priority: pulumi.Int(1000),
NextHopVpnTunnel: tunnel1.ID(),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.VPNGateway;
import com.pulumi.gcp.compute.VPNGatewayArgs;
import com.pulumi.gcp.compute.Address;
import com.pulumi.gcp.compute.ForwardingRule;
import com.pulumi.gcp.compute.ForwardingRuleArgs;
import com.pulumi.gcp.compute.VPNTunnel;
import com.pulumi.gcp.compute.VPNTunnelArgs;
import com.pulumi.gcp.compute.Route;
import com.pulumi.gcp.compute.RouteArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var network1 = new Network("network1");
var targetGateway = new VPNGateway("targetGateway", VPNGatewayArgs.builder()
.network(network1.id())
.build());
var vpnStaticIp = new Address("vpnStaticIp");
var frEsp = new ForwardingRule("frEsp", ForwardingRuleArgs.builder()
.ipProtocol("ESP")
.ipAddress(vpnStaticIp.address())
.target(targetGateway.id())
.build());
var frUdp500 = new ForwardingRule("frUdp500", ForwardingRuleArgs.builder()
.ipProtocol("UDP")
.portRange("500")
.ipAddress(vpnStaticIp.address())
.target(targetGateway.id())
.build());
var frUdp4500 = new ForwardingRule("frUdp4500", ForwardingRuleArgs.builder()
.ipProtocol("UDP")
.portRange("4500")
.ipAddress(vpnStaticIp.address())
.target(targetGateway.id())
.build());
var tunnel1 = new VPNTunnel("tunnel1", VPNTunnelArgs.builder()
.peerIp("15.0.0.120")
.sharedSecret("a secret message")
.targetVpnGateway(targetGateway.id())
.labels(Map.of("foo", "bar"))
.build(), CustomResourceOptions.builder()
.dependsOn(
frEsp,
frUdp500,
frUdp4500)
.build());
var route1 = new Route("route1", RouteArgs.builder()
.network(network1.name())
.destRange("15.0.0.0/24")
.priority(1000)
.nextHopVpnTunnel(tunnel1.id())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
network1 = gcp.compute.Network("network1")
target_gateway = gcp.compute.VPNGateway("targetGateway", network=network1.id)
vpn_static_ip = gcp.compute.Address("vpnStaticIp")
fr_esp = gcp.compute.ForwardingRule("frEsp",
ip_protocol="ESP",
ip_address=vpn_static_ip.address,
target=target_gateway.id)
fr_udp500 = gcp.compute.ForwardingRule("frUdp500",
ip_protocol="UDP",
port_range="500",
ip_address=vpn_static_ip.address,
target=target_gateway.id)
fr_udp4500 = gcp.compute.ForwardingRule("frUdp4500",
ip_protocol="UDP",
port_range="4500",
ip_address=vpn_static_ip.address,
target=target_gateway.id)
tunnel1 = gcp.compute.VPNTunnel("tunnel1",
peer_ip="15.0.0.120",
shared_secret="a secret message",
target_vpn_gateway=target_gateway.id,
labels={
"foo": "bar",
},
opts=pulumi.ResourceOptions(depends_on=[
fr_esp,
fr_udp500,
fr_udp4500,
]))
route1 = gcp.compute.Route("route1",
network=network1.name,
dest_range="15.0.0.0/24",
priority=1000,
next_hop_vpn_tunnel=tunnel1.id)
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const network1 = new gcp.compute.Network("network1", {});
const targetGateway = new gcp.compute.VPNGateway("targetGateway", {network: network1.id});
const vpnStaticIp = new gcp.compute.Address("vpnStaticIp", {});
const frEsp = new gcp.compute.ForwardingRule("frEsp", {
ipProtocol: "ESP",
ipAddress: vpnStaticIp.address,
target: targetGateway.id,
});
const frUdp500 = new gcp.compute.ForwardingRule("frUdp500", {
ipProtocol: "UDP",
portRange: "500",
ipAddress: vpnStaticIp.address,
target: targetGateway.id,
});
const frUdp4500 = new gcp.compute.ForwardingRule("frUdp4500", {
ipProtocol: "UDP",
portRange: "4500",
ipAddress: vpnStaticIp.address,
target: targetGateway.id,
});
const tunnel1 = new gcp.compute.VPNTunnel("tunnel1", {
peerIp: "15.0.0.120",
sharedSecret: "a secret message",
targetVpnGateway: targetGateway.id,
labels: {
foo: "bar",
},
}, {
dependsOn: [
frEsp,
frUdp500,
frUdp4500,
],
});
const route1 = new gcp.compute.Route("route1", {
network: network1.name,
destRange: "15.0.0.0/24",
priority: 1000,
nextHopVpnTunnel: tunnel1.id,
});
resources:
tunnel1:
type: gcp:compute:VPNTunnel
properties:
peerIp: 15.0.0.120
sharedSecret: a secret message
targetVpnGateway: ${targetGateway.id}
labels:
foo: bar
options:
dependson:
- ${frEsp}
- ${frUdp500}
- ${frUdp4500}
targetGateway:
type: gcp:compute:VPNGateway
properties:
network: ${network1.id}
network1:
type: gcp:compute:Network
vpnStaticIp:
type: gcp:compute:Address
frEsp:
type: gcp:compute:ForwardingRule
properties:
ipProtocol: ESP
ipAddress: ${vpnStaticIp.address}
target: ${targetGateway.id}
frUdp500:
type: gcp:compute:ForwardingRule
properties:
ipProtocol: UDP
portRange: '500'
ipAddress: ${vpnStaticIp.address}
target: ${targetGateway.id}
frUdp4500:
type: gcp:compute:ForwardingRule
properties:
ipProtocol: UDP
portRange: '4500'
ipAddress: ${vpnStaticIp.address}
target: ${targetGateway.id}
route1:
type: gcp:compute:Route
properties:
network: ${network1.name}
destRange: 15.0.0.0/24
priority: 1000
nextHopVpnTunnel: ${tunnel1.id}
Create VPNTunnel Resource
new VPNTunnel(name: string, args: VPNTunnelArgs, opts?: CustomResourceOptions);
@overload
def VPNTunnel(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
ike_version: Optional[int] = None,
labels: Optional[Mapping[str, str]] = None,
local_traffic_selectors: Optional[Sequence[str]] = None,
name: Optional[str] = None,
peer_external_gateway: Optional[str] = None,
peer_external_gateway_interface: Optional[int] = None,
peer_gcp_gateway: Optional[str] = None,
peer_ip: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
remote_traffic_selectors: Optional[Sequence[str]] = None,
router: Optional[str] = None,
shared_secret: Optional[str] = None,
target_vpn_gateway: Optional[str] = None,
vpn_gateway: Optional[str] = None,
vpn_gateway_interface: Optional[int] = None)
@overload
def VPNTunnel(resource_name: str,
args: VPNTunnelArgs,
opts: Optional[ResourceOptions] = None)
func NewVPNTunnel(ctx *Context, name string, args VPNTunnelArgs, opts ...ResourceOption) (*VPNTunnel, error)
public VPNTunnel(string name, VPNTunnelArgs args, CustomResourceOptions? opts = null)
public VPNTunnel(String name, VPNTunnelArgs args)
public VPNTunnel(String name, VPNTunnelArgs args, CustomResourceOptions options)
type: gcp:compute:VPNTunnel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VPNTunnelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args VPNTunnelArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args VPNTunnelArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VPNTunnelArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VPNTunnelArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
VPNTunnel Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The VPNTunnel resource accepts the following input properties:
- string
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 string
An optional description of this resource.
- Ike
Version int 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.
- Labels Dictionary<string, string>
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Local
Traffic List<string>Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Name string
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
a-z?
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.- Peer
External stringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- Peer
External intGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- Peer
Gcp stringGateway 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
gcp.compute.HaVpnGateway
resource.- Peer
Ip string IP address of the peer VPN gateway. Only IPv4 is supported.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- Remote
Traffic List<string>Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Router string
URL of router resource to be used for dynamic routing.
- Target
Vpn stringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- Vpn
Gateway string 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
gcp.compute.HaVpnGateway
resource.- Vpn
Gateway intInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- string
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 string
An optional description of this resource.
- Ike
Version int 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.
- Labels map[string]string
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Local
Traffic []stringSelectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Name string
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
a-z?
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.- Peer
External stringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- Peer
External intGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- Peer
Gcp stringGateway 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
gcp.compute.HaVpnGateway
resource.- Peer
Ip string IP address of the peer VPN gateway. Only IPv4 is supported.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- Remote
Traffic []stringSelectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Router string
URL of router resource to be used for dynamic routing.
- Target
Vpn stringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- Vpn
Gateway string 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
gcp.compute.HaVpnGateway
resource.- Vpn
Gateway intInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- String
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 String
An optional description of this resource.
- ike
Version Integer 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.
- labels Map<String,String>
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local
Traffic List<String>Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name String
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
a-z?
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.- peer
External StringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer
External IntegerGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer
Gcp StringGateway 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
gcp.compute.HaVpnGateway
resource.- peer
Ip String IP address of the peer VPN gateway. Only IPv4 is supported.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote
Traffic List<String>Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router String
URL of router resource to be used for dynamic routing.
- target
Vpn StringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- vpn
Gateway String 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
gcp.compute.HaVpnGateway
resource.- vpn
Gateway IntegerInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- string
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 string
An optional description of this resource.
- ike
Version number 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.
- labels {[key: string]: string}
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local
Traffic string[]Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name string
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
a-z?
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.- peer
External stringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer
External numberGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer
Gcp stringGateway 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
gcp.compute.HaVpnGateway
resource.- peer
Ip string IP address of the peer VPN gateway. Only IPv4 is supported.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote
Traffic string[]Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router string
URL of router resource to be used for dynamic routing.
- target
Vpn stringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- vpn
Gateway string 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
gcp.compute.HaVpnGateway
resource.- vpn
Gateway numberInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- str
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 str
An optional description of this resource.
- ike_
version int 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.
- labels Mapping[str, str]
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local_
traffic_ Sequence[str]selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name str
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
a-z?
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.- peer_
external_ strgateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer_
external_ intgateway_ interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer_
gcp_ strgateway 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
gcp.compute.HaVpnGateway
resource.- peer_
ip str IP address of the peer VPN gateway. Only IPv4 is supported.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote_
traffic_ Sequence[str]selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router str
URL of router resource to be used for dynamic routing.
- target_
vpn_ strgateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- vpn_
gateway str 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
gcp.compute.HaVpnGateway
resource.- vpn_
gateway_ intinterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- String
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 String
An optional description of this resource.
- ike
Version Number 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.
- labels Map<String>
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local
Traffic List<String>Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name String
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
a-z?
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.- peer
External StringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer
External NumberGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer
Gcp StringGateway 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
gcp.compute.HaVpnGateway
resource.- peer
Ip String IP address of the peer VPN gateway. Only IPv4 is supported.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote
Traffic List<String>Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router String
URL of router resource to be used for dynamic routing.
- target
Vpn StringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- vpn
Gateway String 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
gcp.compute.HaVpnGateway
resource.- vpn
Gateway NumberInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
Outputs
All input properties are implicitly available as output properties. Additionally, the VPNTunnel resource produces the following output properties:
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Detailed
Status string Detailed status message for the VPN tunnel.
- Effective
Labels Dictionary<string, string> All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
The provider-assigned unique ID for this managed resource.
- Label
Fingerprint string The fingerprint used for optimistic locking of this resource. Used internally during updates.
- Pulumi
Labels Dictionary<string, string> The combination of labels configured directly on the resource and default labels configured on the provider.
- Self
Link string The URI of the created resource.
- string
Hash of the shared secret.
- Tunnel
Id string The unique identifier for the resource. This identifier is defined by the server.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Detailed
Status string Detailed status message for the VPN tunnel.
- Effective
Labels map[string]string All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
The provider-assigned unique ID for this managed resource.
- Label
Fingerprint string The fingerprint used for optimistic locking of this resource. Used internally during updates.
- Pulumi
Labels map[string]string The combination of labels configured directly on the resource and default labels configured on the provider.
- Self
Link string The URI of the created resource.
- string
Hash of the shared secret.
- Tunnel
Id string The unique identifier for the resource. This identifier is defined by the server.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- detailed
Status String Detailed status message for the VPN tunnel.
- effective
Labels Map<String,String> All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
The provider-assigned unique ID for this managed resource.
- label
Fingerprint String The fingerprint used for optimistic locking of this resource. Used internally during updates.
- pulumi
Labels Map<String,String> The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link String The URI of the created resource.
- String
Hash of the shared secret.
- tunnel
Id String The unique identifier for the resource. This identifier is defined by the server.
- creation
Timestamp string Creation timestamp in RFC3339 text format.
- detailed
Status string Detailed status message for the VPN tunnel.
- effective
Labels {[key: string]: string} All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
The provider-assigned unique ID for this managed resource.
- label
Fingerprint string The fingerprint used for optimistic locking of this resource. Used internally during updates.
- pulumi
Labels {[key: string]: string} The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link string The URI of the created resource.
- string
Hash of the shared secret.
- tunnel
Id string The unique identifier for the resource. This identifier is defined by the server.
- creation_
timestamp str Creation timestamp in RFC3339 text format.
- detailed_
status str Detailed status message for the VPN tunnel.
- effective_
labels Mapping[str, str] All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
The provider-assigned unique ID for this managed resource.
- label_
fingerprint str The fingerprint used for optimistic locking of this resource. Used internally during updates.
- pulumi_
labels Mapping[str, str] The combination of labels configured directly on the resource and default labels configured on the provider.
- self_
link str The URI of the created resource.
- str
Hash of the shared secret.
- tunnel_
id str The unique identifier for the resource. This identifier is defined by the server.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- detailed
Status String Detailed status message for the VPN tunnel.
- effective
Labels Map<String> All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
The provider-assigned unique ID for this managed resource.
- label
Fingerprint String The fingerprint used for optimistic locking of this resource. Used internally during updates.
- pulumi
Labels Map<String> The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link String The URI of the created resource.
- String
Hash of the shared secret.
- tunnel
Id String The unique identifier for the resource. This identifier is defined by the server.
Look up Existing VPNTunnel Resource
Get an existing VPNTunnel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: VPNTunnelState, opts?: CustomResourceOptions): VPNTunnel
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
creation_timestamp: Optional[str] = None,
description: Optional[str] = None,
detailed_status: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
ike_version: Optional[int] = None,
label_fingerprint: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
local_traffic_selectors: Optional[Sequence[str]] = None,
name: Optional[str] = None,
peer_external_gateway: Optional[str] = None,
peer_external_gateway_interface: Optional[int] = None,
peer_gcp_gateway: Optional[str] = None,
peer_ip: Optional[str] = None,
project: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
region: Optional[str] = None,
remote_traffic_selectors: Optional[Sequence[str]] = None,
router: Optional[str] = None,
self_link: Optional[str] = None,
shared_secret: Optional[str] = None,
shared_secret_hash: Optional[str] = None,
target_vpn_gateway: Optional[str] = None,
tunnel_id: Optional[str] = None,
vpn_gateway: Optional[str] = None,
vpn_gateway_interface: Optional[int] = None) -> VPNTunnel
func GetVPNTunnel(ctx *Context, name string, id IDInput, state *VPNTunnelState, opts ...ResourceOption) (*VPNTunnel, error)
public static VPNTunnel Get(string name, Input<string> id, VPNTunnelState? state, CustomResourceOptions? opts = null)
public static VPNTunnel get(String name, Output<String> id, VPNTunnelState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Description string
An optional description of this resource.
- Detailed
Status string Detailed status message for the VPN tunnel.
- Effective
Labels Dictionary<string, string> All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Ike
Version int 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.
- Label
Fingerprint string The fingerprint used for optimistic locking of this resource. Used internally during updates.
- Labels Dictionary<string, string>
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Local
Traffic List<string>Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Name string
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
a-z?
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.- Peer
External stringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- Peer
External intGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- Peer
Gcp stringGateway 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
gcp.compute.HaVpnGateway
resource.- Peer
Ip string IP address of the peer VPN gateway. Only IPv4 is supported.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels Dictionary<string, string> The combination of labels configured directly on the resource and default labels configured on the provider.
- Region string
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- Remote
Traffic List<string>Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Router string
URL of router resource to be used for dynamic routing.
- Self
Link string The URI of the created resource.
- string
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.
- string
Hash of the shared secret.
- Target
Vpn stringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- Tunnel
Id string The unique identifier for the resource. This identifier is defined by the server.
- Vpn
Gateway string 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
gcp.compute.HaVpnGateway
resource.- Vpn
Gateway intInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- Creation
Timestamp string Creation timestamp in RFC3339 text format.
- Description string
An optional description of this resource.
- Detailed
Status string Detailed status message for the VPN tunnel.
- Effective
Labels map[string]string All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Ike
Version int 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.
- Label
Fingerprint string The fingerprint used for optimistic locking of this resource. Used internally during updates.
- Labels map[string]string
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Local
Traffic []stringSelectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Name string
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
a-z?
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.- Peer
External stringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- Peer
External intGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- Peer
Gcp stringGateway 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
gcp.compute.HaVpnGateway
resource.- Peer
Ip string IP address of the peer VPN gateway. Only IPv4 is supported.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels map[string]string The combination of labels configured directly on the resource and default labels configured on the provider.
- Region string
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- Remote
Traffic []stringSelectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- Router string
URL of router resource to be used for dynamic routing.
- Self
Link string The URI of the created resource.
- string
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.
- string
Hash of the shared secret.
- Target
Vpn stringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- Tunnel
Id string The unique identifier for the resource. This identifier is defined by the server.
- Vpn
Gateway string 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
gcp.compute.HaVpnGateway
resource.- Vpn
Gateway intInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- description String
An optional description of this resource.
- detailed
Status String Detailed status message for the VPN tunnel.
- effective
Labels Map<String,String> All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- ike
Version Integer 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.
- label
Fingerprint String The fingerprint used for optimistic locking of this resource. Used internally during updates.
- labels Map<String,String>
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local
Traffic List<String>Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name String
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
a-z?
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.- peer
External StringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer
External IntegerGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer
Gcp StringGateway 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
gcp.compute.HaVpnGateway
resource.- peer
Ip String IP address of the peer VPN gateway. Only IPv4 is supported.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String,String> The combination of labels configured directly on the resource and default labels configured on the provider.
- region String
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote
Traffic List<String>Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router String
URL of router resource to be used for dynamic routing.
- self
Link String The URI of the created resource.
- String
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.
- String
Hash of the shared secret.
- target
Vpn StringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- tunnel
Id String The unique identifier for the resource. This identifier is defined by the server.
- vpn
Gateway String 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
gcp.compute.HaVpnGateway
resource.- vpn
Gateway IntegerInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- creation
Timestamp string Creation timestamp in RFC3339 text format.
- description string
An optional description of this resource.
- detailed
Status string Detailed status message for the VPN tunnel.
- effective
Labels {[key: string]: string} All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- ike
Version number 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.
- label
Fingerprint string The fingerprint used for optimistic locking of this resource. Used internally during updates.
- labels {[key: string]: string}
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local
Traffic string[]Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name string
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
a-z?
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.- peer
External stringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer
External numberGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer
Gcp stringGateway 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
gcp.compute.HaVpnGateway
resource.- peer
Ip string IP address of the peer VPN gateway. Only IPv4 is supported.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels {[key: string]: string} The combination of labels configured directly on the resource and default labels configured on the provider.
- region string
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote
Traffic string[]Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router string
URL of router resource to be used for dynamic routing.
- self
Link string The URI of the created resource.
- string
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.
- string
Hash of the shared secret.
- target
Vpn stringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- tunnel
Id string The unique identifier for the resource. This identifier is defined by the server.
- vpn
Gateway string 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
gcp.compute.HaVpnGateway
resource.- vpn
Gateway numberInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- creation_
timestamp str Creation timestamp in RFC3339 text format.
- description str
An optional description of this resource.
- detailed_
status str Detailed status message for the VPN tunnel.
- effective_
labels Mapping[str, str] All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- ike_
version int 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.
- label_
fingerprint str The fingerprint used for optimistic locking of this resource. Used internally during updates.
- labels Mapping[str, str]
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local_
traffic_ Sequence[str]selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name str
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
a-z?
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.- peer_
external_ strgateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer_
external_ intgateway_ interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer_
gcp_ strgateway 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
gcp.compute.HaVpnGateway
resource.- peer_
ip str IP address of the peer VPN gateway. Only IPv4 is supported.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels Mapping[str, str] The combination of labels configured directly on the resource and default labels configured on the provider.
- region str
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote_
traffic_ Sequence[str]selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router str
URL of router resource to be used for dynamic routing.
- self_
link str The URI of the created resource.
- str
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.
- str
Hash of the shared secret.
- target_
vpn_ strgateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- tunnel_
id str The unique identifier for the resource. This identifier is defined by the server.
- vpn_
gateway str 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
gcp.compute.HaVpnGateway
resource.- vpn_
gateway_ intinterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
- creation
Timestamp String Creation timestamp in RFC3339 text format.
- description String
An optional description of this resource.
- detailed
Status String Detailed status message for the VPN tunnel.
- effective
Labels Map<String> All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- ike
Version Number 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.
- label
Fingerprint String The fingerprint used for optimistic locking of this resource. Used internally during updates.
- labels Map<String>
Labels to apply to this VpnTunnel. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- local
Traffic List<String>Selectors Local traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- name String
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
a-z?
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.- peer
External StringGateway URL of the peer side external VPN gateway to which this VPN tunnel is connected.
- peer
External NumberGateway Interface The interface ID of the external VPN gateway to which this VPN tunnel is connected.
- peer
Gcp StringGateway 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
gcp.compute.HaVpnGateway
resource.- peer
Ip String IP address of the peer VPN gateway. Only IPv4 is supported.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String> The combination of labels configured directly on the resource and default labels configured on the provider.
- region String
The region where the tunnel is located. If unset, is set to the region of
target_vpn_gateway
.- remote
Traffic List<String>Selectors Remote traffic selector to use when establishing the VPN tunnel with peer VPN gateway. The value should be a CIDR formatted string, for example
192.168.0.0/16
. The ranges should be disjoint. Only IPv4 is supported.- router String
URL of router resource to be used for dynamic routing.
- self
Link String The URI of the created resource.
- String
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.
- String
Hash of the shared secret.
- target
Vpn StringGateway URL of the Target VPN gateway with which this VPN tunnel is associated.
- tunnel
Id String The unique identifier for the resource. This identifier is defined by the server.
- vpn
Gateway String 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
gcp.compute.HaVpnGateway
resource.- vpn
Gateway NumberInterface The interface ID of the VPN gateway with which this VPN tunnel is associated.
Import
VpnTunnel can be imported using any of these accepted formats* projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}
* {{project}}/{{region}}/{{name}}
* {{region}}/{{name}}
* {{name}}
In Terraform v1.5.0 and later, use an import
block to import VpnTunnel using one of the formats above. For exampletf import {
id = “projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}”
to = google_compute_vpn_tunnel.default }
$ pulumi import gcp:compute/vPNTunnel:VPNTunnel When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), VpnTunnel can be imported using one of the formats above. For example
$ pulumi import gcp:compute/vPNTunnel:VPNTunnel default projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}
$ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{region}}/{{name}}
$ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{name}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.