com.pulumi.gcp.compute.kotlin.VPNTunnel.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.compute.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [VPNTunnel].
*/
@PulumiTagMarker
public class VPNTunnelResourceBuilder internal constructor() {
public var name: String? = null
public var args: VPNTunnelArgs = VPNTunnelArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend VPNTunnelArgsBuilder.() -> Unit) {
val builder = VPNTunnelArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): VPNTunnel {
val builtJavaResource = com.pulumi.gcp.compute.VPNTunnel(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return VPNTunnel(builtJavaResource)
}
}
/**
* VPN tunnel resource.
* To get more information about VpnTunnel, see:
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/vpnTunnels)
* * How-to Guides
* * [Cloud VPN Overview](https://cloud.google.com/vpn/docs/concepts/overview)
* * [Networks and Tunnel Routing](https://cloud.google.com/vpn/docs/concepts/choosing-networks-routing)
* ## Example Usage
* ### Vpn Tunnel Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const network1 = new gcp.compute.Network("network1", {name: "network-1"});
* const targetGateway = new gcp.compute.VPNGateway("target_gateway", {
* name: "vpn-1",
* network: network1.id,
* });
* const tunnel1 = new gcp.compute.VPNTunnel("tunnel1", {
* name: "tunnel-1",
* peerIp: "15.0.0.120",
* sharedSecret: "a secret message",
* targetVpnGateway: targetGateway.id,
* labels: {
* foo: "bar",
* },
* });
* const vpnStaticIp = new gcp.compute.Address("vpn_static_ip", {name: "vpn-static-ip"});
* const frEsp = new gcp.compute.ForwardingRule("fr_esp", {
* name: "fr-esp",
* ipProtocol: "ESP",
* ipAddress: vpnStaticIp.address,
* target: targetGateway.id,
* });
* const frUdp500 = new gcp.compute.ForwardingRule("fr_udp500", {
* name: "fr-udp500",
* ipProtocol: "UDP",
* portRange: "500",
* ipAddress: vpnStaticIp.address,
* target: targetGateway.id,
* });
* const frUdp4500 = new gcp.compute.ForwardingRule("fr_udp4500", {
* name: "fr-udp4500",
* ipProtocol: "UDP",
* portRange: "4500",
* ipAddress: vpnStaticIp.address,
* target: targetGateway.id,
* });
* const route1 = new gcp.compute.Route("route1", {
* name: "route1",
* network: network1.name,
* destRange: "15.0.0.0/24",
* priority: 1000,
* nextHopVpnTunnel: tunnel1.id,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* network1 = gcp.compute.Network("network1", name="network-1")
* target_gateway = gcp.compute.VPNGateway("target_gateway",
* name="vpn-1",
* network=network1.id)
* tunnel1 = gcp.compute.VPNTunnel("tunnel1",
* name="tunnel-1",
* peer_ip="15.0.0.120",
* shared_secret="a secret message",
* target_vpn_gateway=target_gateway.id,
* labels={
* "foo": "bar",
* })
* vpn_static_ip = gcp.compute.Address("vpn_static_ip", name="vpn-static-ip")
* fr_esp = gcp.compute.ForwardingRule("fr_esp",
* name="fr-esp",
* ip_protocol="ESP",
* ip_address=vpn_static_ip.address,
* target=target_gateway.id)
* fr_udp500 = gcp.compute.ForwardingRule("fr_udp500",
* name="fr-udp500",
* ip_protocol="UDP",
* port_range="500",
* ip_address=vpn_static_ip.address,
* target=target_gateway.id)
* fr_udp4500 = gcp.compute.ForwardingRule("fr_udp4500",
* name="fr-udp4500",
* ip_protocol="UDP",
* port_range="4500",
* ip_address=vpn_static_ip.address,
* target=target_gateway.id)
* route1 = gcp.compute.Route("route1",
* name="route1",
* network=network1.name,
* dest_range="15.0.0.0/24",
* priority=1000,
* next_hop_vpn_tunnel=tunnel1.id)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var network1 = new Gcp.Compute.Network("network1", new()
* {
* Name = "network-1",
* });
* var targetGateway = new Gcp.Compute.VPNGateway("target_gateway", new()
* {
* Name = "vpn-1",
* Network = network1.Id,
* });
* var tunnel1 = new Gcp.Compute.VPNTunnel("tunnel1", new()
* {
* Name = "tunnel-1",
* PeerIp = "15.0.0.120",
* SharedSecret = "a secret message",
* TargetVpnGateway = targetGateway.Id,
* Labels =
* {
* { "foo", "bar" },
* },
* });
* var vpnStaticIp = new Gcp.Compute.Address("vpn_static_ip", new()
* {
* Name = "vpn-static-ip",
* });
* var frEsp = new Gcp.Compute.ForwardingRule("fr_esp", new()
* {
* Name = "fr-esp",
* IpProtocol = "ESP",
* IpAddress = vpnStaticIp.IPAddress,
* Target = targetGateway.Id,
* });
* var frUdp500 = new Gcp.Compute.ForwardingRule("fr_udp500", new()
* {
* Name = "fr-udp500",
* IpProtocol = "UDP",
* PortRange = "500",
* IpAddress = vpnStaticIp.IPAddress,
* Target = targetGateway.Id,
* });
* var frUdp4500 = new Gcp.Compute.ForwardingRule("fr_udp4500", new()
* {
* Name = "fr-udp4500",
* IpProtocol = "UDP",
* PortRange = "4500",
* IpAddress = vpnStaticIp.IPAddress,
* Target = targetGateway.Id,
* });
* var route1 = new Gcp.Compute.Route("route1", new()
* {
* Name = "route1",
* Network = network1.Name,
* DestRange = "15.0.0.0/24",
* Priority = 1000,
* NextHopVpnTunnel = tunnel1.Id,
* });
* });
* ```
* ```go
* 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", &compute.NetworkArgs{
* Name: pulumi.String("network-1"),
* })
* if err != nil {
* return err
* }
* targetGateway, err := compute.NewVPNGateway(ctx, "target_gateway", &compute.VPNGatewayArgs{
* Name: pulumi.String("vpn-1"),
* Network: network1.ID(),
* })
* if err != nil {
* return err
* }
* tunnel1, err := compute.NewVPNTunnel(ctx, "tunnel1", &compute.VPNTunnelArgs{
* Name: pulumi.String("tunnel-1"),
* PeerIp: pulumi.String("15.0.0.120"),
* SharedSecret: pulumi.String("a secret message"),
* TargetVpnGateway: targetGateway.ID(),
* Labels: pulumi.StringMap{
* "foo": pulumi.String("bar"),
* },
* })
* if err != nil {
* return err
* }
* vpnStaticIp, err := compute.NewAddress(ctx, "vpn_static_ip", &compute.AddressArgs{
* Name: pulumi.String("vpn-static-ip"),
* })
* if err != nil {
* return err
* }
* _, err = compute.NewForwardingRule(ctx, "fr_esp", &compute.ForwardingRuleArgs{
* Name: pulumi.String("fr-esp"),
* IpProtocol: pulumi.String("ESP"),
* IpAddress: vpnStaticIp.Address,
* Target: targetGateway.ID(),
* })
* if err != nil {
* return err
* }
* _, err = compute.NewForwardingRule(ctx, "fr_udp500", &compute.ForwardingRuleArgs{
* Name: pulumi.String("fr-udp500"),
* IpProtocol: pulumi.String("UDP"),
* PortRange: pulumi.String("500"),
* IpAddress: vpnStaticIp.Address,
* Target: targetGateway.ID(),
* })
* if err != nil {
* return err
* }
* _, err = compute.NewForwardingRule(ctx, "fr_udp4500", &compute.ForwardingRuleArgs{
* Name: pulumi.String("fr-udp4500"),
* IpProtocol: pulumi.String("UDP"),
* PortRange: pulumi.String("4500"),
* IpAddress: vpnStaticIp.Address,
* Target: targetGateway.ID(),
* })
* if err != nil {
* return err
* }
* _, err = compute.NewRoute(ctx, "route1", &compute.RouteArgs{
* Name: pulumi.String("route1"),
* 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
* })
* }
* ```
* ```java
* 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.NetworkArgs;
* import com.pulumi.gcp.compute.VPNGateway;
* import com.pulumi.gcp.compute.VPNGatewayArgs;
* import com.pulumi.gcp.compute.VPNTunnel;
* import com.pulumi.gcp.compute.VPNTunnelArgs;
* import com.pulumi.gcp.compute.Address;
* import com.pulumi.gcp.compute.AddressArgs;
* import com.pulumi.gcp.compute.ForwardingRule;
* import com.pulumi.gcp.compute.ForwardingRuleArgs;
* import com.pulumi.gcp.compute.Route;
* import com.pulumi.gcp.compute.RouteArgs;
* 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", NetworkArgs.builder()
* .name("network-1")
* .build());
* var targetGateway = new VPNGateway("targetGateway", VPNGatewayArgs.builder()
* .name("vpn-1")
* .network(network1.id())
* .build());
* var tunnel1 = new VPNTunnel("tunnel1", VPNTunnelArgs.builder()
* .name("tunnel-1")
* .peerIp("15.0.0.120")
* .sharedSecret("a secret message")
* .targetVpnGateway(targetGateway.id())
* .labels(Map.of("foo", "bar"))
* .build());
* var vpnStaticIp = new Address("vpnStaticIp", AddressArgs.builder()
* .name("vpn-static-ip")
* .build());
* var frEsp = new ForwardingRule("frEsp", ForwardingRuleArgs.builder()
* .name("fr-esp")
* .ipProtocol("ESP")
* .ipAddress(vpnStaticIp.address())
* .target(targetGateway.id())
* .build());
* var frUdp500 = new ForwardingRule("frUdp500", ForwardingRuleArgs.builder()
* .name("fr-udp500")
* .ipProtocol("UDP")
* .portRange("500")
* .ipAddress(vpnStaticIp.address())
* .target(targetGateway.id())
* .build());
* var frUdp4500 = new ForwardingRule("frUdp4500", ForwardingRuleArgs.builder()
* .name("fr-udp4500")
* .ipProtocol("UDP")
* .portRange("4500")
* .ipAddress(vpnStaticIp.address())
* .target(targetGateway.id())
* .build());
* var route1 = new Route("route1", RouteArgs.builder()
* .name("route1")
* .network(network1.name())
* .destRange("15.0.0.0/24")
* .priority(1000)
* .nextHopVpnTunnel(tunnel1.id())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* tunnel1:
* type: gcp:compute:VPNTunnel
* properties:
* name: tunnel-1
* peerIp: 15.0.0.120
* sharedSecret: a secret message
* targetVpnGateway: ${targetGateway.id}
* labels:
* foo: bar
* targetGateway:
* type: gcp:compute:VPNGateway
* name: target_gateway
* properties:
* name: vpn-1
* network: ${network1.id}
* network1:
* type: gcp:compute:Network
* properties:
* name: network-1
* vpnStaticIp:
* type: gcp:compute:Address
* name: vpn_static_ip
* properties:
* name: vpn-static-ip
* frEsp:
* type: gcp:compute:ForwardingRule
* name: fr_esp
* properties:
* name: fr-esp
* ipProtocol: ESP
* ipAddress: ${vpnStaticIp.address}
* target: ${targetGateway.id}
* frUdp500:
* type: gcp:compute:ForwardingRule
* name: fr_udp500
* properties:
* name: fr-udp500
* ipProtocol: UDP
* portRange: '500'
* ipAddress: ${vpnStaticIp.address}
* target: ${targetGateway.id}
* frUdp4500:
* type: gcp:compute:ForwardingRule
* name: fr_udp4500
* properties:
* name: fr-udp4500
* ipProtocol: UDP
* portRange: '4500'
* ipAddress: ${vpnStaticIp.address}
* target: ${targetGateway.id}
* route1:
* type: gcp:compute:Route
* properties:
* name: route1
* network: ${network1.name}
* destRange: 15.0.0.0/24
* priority: 1000
* nextHopVpnTunnel: ${tunnel1.id}
* ```
*
* ## Import
* VpnTunnel can be imported using any of these accepted formats:
* * `projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}`
* * `{{project}}/{{region}}/{{name}}`
* * `{{region}}/{{name}}`
* * `{{name}}`
* When using the `pulumi import` command, VpnTunnel can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default projects/{{project}}/regions/{{region}}/vpnTunnels/{{name}}
* ```
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{project}}/{{region}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{region}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:compute/vPNTunnel:VPNTunnel default {{name}}
* ```
*/
public class VPNTunnel internal constructor(
override val javaResource: com.pulumi.gcp.compute.VPNTunnel,
) : KotlinCustomResource(javaResource, VPNTunnelMapper) {
/**
* Creation timestamp in RFC3339 text format.
*/
public val creationTimestamp: Output
get() = javaResource.creationTimestamp().applyValue({ args0 -> args0 })
/**
* An optional description of this resource.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Detailed status message for the VPN tunnel.
*/
public val detailedStatus: Output
get() = javaResource.detailedStatus().applyValue({ args0 -> args0 })
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* 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.
*/
public val ikeVersion: Output?
get() = javaResource.ikeVersion().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The fingerprint used for optimistic locking of this resource. Used
* internally during updates.
*/
public val labelFingerprint: Output
get() = javaResource.labelFingerprint().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* 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.
*/
public val localTrafficSelectors: Output>
get() = javaResource.localTrafficSelectors().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* 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.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* URL of the peer side external VPN gateway to which this VPN tunnel is connected.
*/
public val peerExternalGateway: Output?
get() = javaResource.peerExternalGateway().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The interface ID of the external VPN gateway to which this VPN tunnel is connected.
*/
public val peerExternalGatewayInterface: Output?
get() = javaResource.peerExternalGatewayInterface().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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.
*/
public val peerGcpGateway: Output?
get() = javaResource.peerGcpGateway().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* IP address of the peer VPN gateway. Only IPv4 is supported.
*/
public val peerIp: Output
get() = javaResource.peerIp().applyValue({ args0 -> args0 })
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The region where the tunnel is located. If unset, is set to the region of `target_vpn_gateway`.
*/
public val region: Output
get() = javaResource.region().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val remoteTrafficSelectors: Output>
get() = javaResource.remoteTrafficSelectors().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* URL of router resource to be used for dynamic routing.
*/
public val router: Output?
get() = javaResource.router().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The URI of the created resource.
*/
public val selfLink: Output
get() = javaResource.selfLink().applyValue({ args0 -> args0 })
/**
* 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.
* - - -
*/
public val sharedSecret: Output
get() = javaResource.sharedSecret().applyValue({ args0 -> args0 })
/**
* Hash of the shared secret.
*/
public val sharedSecretHash: Output
get() = javaResource.sharedSecretHash().applyValue({ args0 -> args0 })
/**
* URL of the Target VPN gateway with which this VPN tunnel is
* associated.
*/
public val targetVpnGateway: Output?
get() = javaResource.targetVpnGateway().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The unique identifier for the resource. This identifier is defined by the server.
*/
public val tunnelId: Output
get() = javaResource.tunnelId().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val vpnGateway: Output?
get() = javaResource.vpnGateway().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The interface ID of the VPN gateway with which this VPN tunnel is associated.
*/
public val vpnGatewayInterface: Output?
get() = javaResource.vpnGatewayInterface().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object VPNTunnelMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.compute.VPNTunnel::class == javaResource::class
override fun map(javaResource: Resource): VPNTunnel = VPNTunnel(
javaResource as
com.pulumi.gcp.compute.VPNTunnel,
)
}
/**
* @see [VPNTunnel].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [VPNTunnel].
*/
public suspend fun vpnTunnel(name: String, block: suspend VPNTunnelResourceBuilder.() -> Unit): VPNTunnel {
val builder = VPNTunnelResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [VPNTunnel].
* @param name The _unique_ name of the resulting resource.
*/
public fun vpnTunnel(name: String): VPNTunnel {
val builder = VPNTunnelResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy