Class VPNTunnel

VPN tunnel resource.

To get more information about VpnTunnel, see:

Warning: All arguments including shared_secret will be stored in the raw state as plain-text.

Example Usage - Vpn Tunnel Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var network1 = new Gcp.Compute.Network(&quot;network1&quot;, new Gcp.Compute.NetworkArgs
    {
    });
    var targetGateway = new Gcp.Compute.VPNGateway(&quot;targetGateway&quot;, new Gcp.Compute.VPNGatewayArgs
    {
        Network = network1.Id,
    });
    var vpnStaticIp = new Gcp.Compute.Address(&quot;vpnStaticIp&quot;, new Gcp.Compute.AddressArgs
    {
    });
    var frEsp = new Gcp.Compute.ForwardingRule(&quot;frEsp&quot;, new Gcp.Compute.ForwardingRuleArgs
    {
        IpProtocol = &quot;ESP&quot;,
        IpAddress = vpnStaticIp.IPAddress,
        Target = targetGateway.Id,
    });
    var frUdp500 = new Gcp.Compute.ForwardingRule(&quot;frUdp500&quot;, new Gcp.Compute.ForwardingRuleArgs
    {
        IpProtocol = &quot;UDP&quot;,
        PortRange = &quot;500&quot;,
        IpAddress = vpnStaticIp.IPAddress,
        Target = targetGateway.Id,
    });
    var frUdp4500 = new Gcp.Compute.ForwardingRule(&quot;frUdp4500&quot;, new Gcp.Compute.ForwardingRuleArgs
    {
        IpProtocol = &quot;UDP&quot;,
        PortRange = &quot;4500&quot;,
        IpAddress = vpnStaticIp.IPAddress,
        Target = targetGateway.Id,
    });
    var tunnel1 = new Gcp.Compute.VPNTunnel(&quot;tunnel1&quot;, new Gcp.Compute.VPNTunnelArgs
    {
        PeerIp = &quot;15.0.0.120&quot;,
        SharedSecret = &quot;a secret message&quot;,
        TargetVpnGateway = targetGateway.Id,
    });
    var route1 = new Gcp.Compute.Route(&quot;route1&quot;, new Gcp.Compute.RouteArgs
    {
        Network = network1.Name,
        DestRange = &quot;15.0.0.0/24&quot;,
        Priority = 1000,
        NextHopVpnTunnel = tunnel1.Id,
    });
}

}

Example Usage - Vpn Tunnel Beta

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var network1 = new Gcp.Compute.Network(&quot;network1&quot;, new Gcp.Compute.NetworkArgs
    {
    });
    var targetGateway = new Gcp.Compute.VPNGateway(&quot;targetGateway&quot;, new Gcp.Compute.VPNGatewayArgs
    {
        Network = network1.Id,
    });
    var vpnStaticIp = new Gcp.Compute.Address(&quot;vpnStaticIp&quot;, new Gcp.Compute.AddressArgs
    {
    });
    var frEsp = new Gcp.Compute.ForwardingRule(&quot;frEsp&quot;, new Gcp.Compute.ForwardingRuleArgs
    {
        IpProtocol = &quot;ESP&quot;,
        IpAddress = vpnStaticIp.IPAddress,
        Target = targetGateway.Id,
    });
    var frUdp500 = new Gcp.Compute.ForwardingRule(&quot;frUdp500&quot;, new Gcp.Compute.ForwardingRuleArgs
    {
        IpProtocol = &quot;UDP&quot;,
        PortRange = &quot;500&quot;,
        IpAddress = vpnStaticIp.IPAddress,
        Target = targetGateway.Id,
    });
    var frUdp4500 = new Gcp.Compute.ForwardingRule(&quot;frUdp4500&quot;, new Gcp.Compute.ForwardingRuleArgs
    {
        IpProtocol = &quot;UDP&quot;,
        PortRange = &quot;4500&quot;,
        IpAddress = vpnStaticIp.IPAddress,
        Target = targetGateway.Id,
    });
    var tunnel1 = new Gcp.Compute.VPNTunnel(&quot;tunnel1&quot;, new Gcp.Compute.VPNTunnelArgs
    {
        PeerIp = &quot;15.0.0.120&quot;,
        SharedSecret = &quot;a secret message&quot;,
        TargetVpnGateway = targetGateway.Id,
        Labels = 
        {
            { &quot;foo&quot;, &quot;bar&quot; },
        },
    });
    var route1 = new Gcp.Compute.Route(&quot;route1&quot;, new Gcp.Compute.RouteArgs
    {
        Network = network1.Name,
        DestRange = &quot;15.0.0.0/24&quot;,
        Priority = 1000,
        NextHopVpnTunnel = tunnel1.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

VPNTunnel

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class VPNTunnel : CustomResource

Constructors

View Source

VPNTunnel(String, VPNTunnelArgs, CustomResourceOptions)

Create a VPNTunnel resource with the given unique name, arguments, and options.

Declaration

public VPNTunnel(string name, VPNTunnelArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VPNTunnelArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

CreationTimestamp

Creation timestamp in RFC3339 text format.

Declaration

public Output<string> CreationTimestamp { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

An optional description of this resource.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

DetailedStatus

Detailed status message for the VPN tunnel.

Declaration

public Output<string> DetailedStatus { get; }

Property Value

Type	Description
Output<System.String>

View Source

IkeVersion

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.

Declaration

public Output<int?> IkeVersion { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

LabelFingerprint

The fingerprint used for optimistic locking of this resource. Used internally during updates.

Declaration

public Output<string> LabelFingerprint { get; }

Property Value

Type	Description
Output<System.String>

View Source

Labels

Labels to apply to this VpnTunnel.

Declaration

public Output<ImmutableDictionary<string, string>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

View Source

LocalTrafficSelectors

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.

Declaration

public Output<ImmutableArray<string>> LocalTrafficSelectors { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Name

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.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerExternalGateway

URL of the peer side external VPN gateway to which this VPN tunnel is connected.

Declaration

public Output<string> PeerExternalGateway { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerExternalGatewayInterface

The interface ID of the external VPN gateway to which this VPN tunnel is connected.

Declaration

public Output<int?> PeerExternalGatewayInterface { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

PeerGcpGateway

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.

Declaration

public Output<string> PeerGcpGateway { get; }

Property Value

Type	Description
Output<System.String>

View Source

PeerIp

IP address of the peer VPN gateway. Only IPv4 is supported.

Declaration

public Output<string> PeerIp { get; }

Property Value

Type	Description
Output<System.String>

View Source

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

Region

The region where the tunnel is located. If unset, is set to the region of target_vpn_gateway.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

RemoteTrafficSelectors

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.

Declaration

public Output<ImmutableArray<string>> RemoteTrafficSelectors { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Router

URL of router resource to be used for dynamic routing.

Declaration

public Output<string> Router { get; }

Property Value

Type	Description
Output<System.String>

View Source

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

View Source

SharedSecret

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.

Declaration

public Output<string> SharedSecret { get; }

Property Value

Type	Description
Output<System.String>

View Source

SharedSecretHash

Hash of the shared secret.

Declaration

public Output<string> SharedSecretHash { get; }

Property Value

Type	Description
Output<System.String>

View Source

TargetVpnGateway

URL of the Target VPN gateway with which this VPN tunnel is associated.

Declaration

public Output<string> TargetVpnGateway { get; }

Property Value

Type	Description
Output<System.String>

View Source

TunnelId

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

Declaration

public Output<string> TunnelId { get; }

Property Value

Type	Description
Output<System.String>

View Source

VpnGateway

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.

Declaration

public Output<string> VpnGateway { get; }

Property Value

Type	Description
Output<System.String>

View Source

VpnGatewayInterface

The interface ID of the VPN gateway with which this VPN tunnel is associated.

Declaration

public Output<int?> VpnGatewayInterface { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Methods

View Source

Get(String, Input<String>, VPNTunnelState, CustomResourceOptions)

Get an existing VPNTunnel resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static VPNTunnel Get(string name, Input<string> id, VPNTunnelState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VPNTunnelState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VPNTunnel