All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.compute.kotlin.VPNGateway.kt Maven / Gradle / Ivy

@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

/**
 * Builder for [VPNGateway].
 */
@PulumiTagMarker
public class VPNGatewayResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: VPNGatewayArgs = VPNGatewayArgs()

    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 VPNGatewayArgsBuilder.() -> Unit) {
        val builder = VPNGatewayArgsBuilder()
        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(): VPNGateway {
        val builtJavaResource = com.pulumi.gcp.compute.VPNGateway(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return VPNGateway(builtJavaResource)
    }
}

/**
 * Represents a VPN gateway running in GCP. This virtual device is managed
 * by Google, but used only by you.
 * To get more information about VpnGateway, see:
 * * [API documentation](https://cloud.google.com/compute/docs/reference/rest/v1/targetVpnGateways)
 * > **Warning:** Classic VPN is deprecating certain functionality on October 31, 2021. For more information,
 * see the [Classic VPN partial deprecation page](https://cloud.google.com/network-connectivity/docs/vpn/deprecations/classic-vpn-deprecation).
 * ## Example Usage
 * ### Target Vpn Gateway 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 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 tunnel1 = new gcp.compute.VPNTunnel("tunnel1", {
 *     name: "tunnel1",
 *     peerIp: "15.0.0.120",
 *     sharedSecret: "a secret message",
 *     targetVpnGateway: targetGateway.id,
 * }, {
 *     dependsOn: [
 *         frEsp,
 *         frUdp500,
 *         frUdp4500,
 *     ],
 * });
 * 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)
 * 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)
 * tunnel1 = gcp.compute.VPNTunnel("tunnel1",
 *     name="tunnel1",
 *     peer_ip="15.0.0.120",
 *     shared_secret="a secret message",
 *     target_vpn_gateway=target_gateway.id,
 *     opts = pulumi.ResourceOptions(depends_on=[
 *             fr_esp,
 *             fr_udp500,
 *             fr_udp4500,
 *         ]))
 * 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 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 tunnel1 = new Gcp.Compute.VPNTunnel("tunnel1", new()
 *     {
 *         Name = "tunnel1",
 *         PeerIp = "15.0.0.120",
 *         SharedSecret = "a secret message",
 *         TargetVpnGateway = targetGateway.Id,
 *     }, new CustomResourceOptions
 *     {
 *         DependsOn =
 *         {
 *             frEsp,
 *             frUdp500,
 *             frUdp4500,
 *         },
 *     });
 *     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
 * 		}
 * 		vpnStaticIp, err := compute.NewAddress(ctx, "vpn_static_ip", &compute.AddressArgs{
 * 			Name: pulumi.String("vpn-static-ip"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		frEsp, 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
 * 		}
 * 		frUdp500, 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
 * 		}
 * 		frUdp4500, 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
 * 		}
 * 		tunnel1, err := compute.NewVPNTunnel(ctx, "tunnel1", &compute.VPNTunnelArgs{
 * 			Name:             pulumi.String("tunnel1"),
 * 			PeerIp:           pulumi.String("15.0.0.120"),
 * 			SharedSecret:     pulumi.String("a secret message"),
 * 			TargetVpnGateway: targetGateway.ID(),
 * 		}, pulumi.DependsOn([]pulumi.Resource{
 * 			frEsp,
 * 			frUdp500,
 * 			frUdp4500,
 * 		}))
 * 		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.Address;
 * import com.pulumi.gcp.compute.AddressArgs;
 * 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", NetworkArgs.builder()
 *             .name("network-1")
 *             .build());
 *         var targetGateway = new VPNGateway("targetGateway", VPNGatewayArgs.builder()
 *             .name("vpn-1")
 *             .network(network1.id())
 *             .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 tunnel1 = new VPNTunnel("tunnel1", VPNTunnelArgs.builder()
 *             .name("tunnel1")
 *             .peerIp("15.0.0.120")
 *             .sharedSecret("a secret message")
 *             .targetVpnGateway(targetGateway.id())
 *             .build(), CustomResourceOptions.builder()
 *                 .dependsOn(
 *                     frEsp,
 *                     frUdp500,
 *                     frUdp4500)
 *                 .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:
 *   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}
 *   tunnel1:
 *     type: gcp:compute:VPNTunnel
 *     properties:
 *       name: tunnel1
 *       peerIp: 15.0.0.120
 *       sharedSecret: a secret message
 *       targetVpnGateway: ${targetGateway.id}
 *     options:
 *       dependson:
 *         - ${frEsp}
 *         - ${frUdp500}
 *         - ${frUdp4500}
 *   route1:
 *     type: gcp:compute:Route
 *     properties:
 *       name: route1
 *       network: ${network1.name}
 *       destRange: 15.0.0.0/24
 *       priority: 1000
 *       nextHopVpnTunnel: ${tunnel1.id}
 * ```
 * 
 * ## Import
 * VpnGateway can be imported using any of these accepted formats:
 * * `projects/{{project}}/regions/{{region}}/targetVpnGateways/{{name}}`
 * * `{{project}}/{{region}}/{{name}}`
 * * `{{region}}/{{name}}`
 * * `{{name}}`
 * When using the `pulumi import` command, VpnGateway can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:compute/vPNGateway:VPNGateway default projects/{{project}}/regions/{{region}}/targetVpnGateways/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:compute/vPNGateway:VPNGateway default {{project}}/{{region}}/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:compute/vPNGateway:VPNGateway default {{region}}/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:compute/vPNGateway:VPNGateway default {{name}}
 * ```
 */
public class VPNGateway internal constructor(
    override val javaResource: com.pulumi.gcp.compute.VPNGateway,
) : KotlinCustomResource(javaResource, VPNGatewayMapper) {
    /**
     * 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)
        })

    /**
     * The unique identifier for the resource.
     */
    public val gatewayId: Output
        get() = javaResource.gatewayId().applyValue({ args0 -> args0 })

    /**
     * Name of the resource. Provided by the client when the resource is
     * created. 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 })

    /**
     * The network this VPN gateway is accepting traffic for.
     * - - -
     */
    public val network: Output
        get() = javaResource.network().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 region this gateway should sit in.
     */
    public val region: Output
        get() = javaResource.region().applyValue({ args0 -> args0 })

    /**
     * The URI of the created resource.
     */
    public val selfLink: Output
        get() = javaResource.selfLink().applyValue({ args0 -> args0 })
}

public object VPNGatewayMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.compute.VPNGateway::class == javaResource::class

    override fun map(javaResource: Resource): VPNGateway = VPNGateway(
        javaResource as
            com.pulumi.gcp.compute.VPNGateway,
    )
}

/**
 * @see [VPNGateway].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [VPNGateway].
 */
public suspend fun vpnGateway(name: String, block: suspend VPNGatewayResourceBuilder.() -> Unit): VPNGateway {
    val builder = VPNGatewayResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [VPNGateway].
 * @param name The _unique_ name of the resulting resource.
 */
public fun vpnGateway(name: String): VPNGateway {
    val builder = VPNGatewayResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy