com.pulumi.gcp.compute.kotlin.VPNGatewayArgs.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.core.Output.of
import com.pulumi.gcp.compute.VPNGatewayArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName
/**
* 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,
* });
* 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)
* 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,
* });
* 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
* }
* _, 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
* }
* 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(),
* })
* 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 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());
* 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}
* 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}}
* ```
* @property description An optional description of this resource.
* @property name 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.
* @property network The network this VPN gateway is accepting traffic for.
* - - -
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property region The region this gateway should sit in.
*/
public data class VPNGatewayArgs(
public val description: Output? = null,
public val name: Output? = null,
public val network: Output? = null,
public val project: Output? = null,
public val region: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.compute.VPNGatewayArgs =
com.pulumi.gcp.compute.VPNGatewayArgs.builder()
.description(description?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.network(network?.applyValue({ args0 -> args0 }))
.project(project?.applyValue({ args0 -> args0 }))
.region(region?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [VPNGatewayArgs].
*/
@PulumiTagMarker
public class VPNGatewayArgsBuilder internal constructor() {
private var description: Output? = null
private var name: Output? = null
private var network: Output? = null
private var project: Output? = null
private var region: Output? = null
/**
* @param value An optional description of this resource.
*/
@JvmName("llklechyctdcgoeb")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value 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.
*/
@JvmName("ocwwhyjsdhdkmrnq")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value The network this VPN gateway is accepting traffic for.
* - - -
*/
@JvmName("hfcupffbydroswel")
public suspend fun network(`value`: Output) {
this.network = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("cniixnxpyuukuifd")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value The region this gateway should sit in.
*/
@JvmName("toncvxkwgucdvorw")
public suspend fun region(`value`: Output) {
this.region = value
}
/**
* @param value An optional description of this resource.
*/
@JvmName("djggmwnkkhgshwwi")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value 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.
*/
@JvmName("pqskhkvwqrceurkl")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value The network this VPN gateway is accepting traffic for.
* - - -
*/
@JvmName("kqgicwlrytkackxd")
public suspend fun network(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.network = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("outkhuruoiltxtli")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value The region this gateway should sit in.
*/
@JvmName("rkxtomjcsarfxioe")
public suspend fun region(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.region = mapped
}
internal fun build(): VPNGatewayArgs = VPNGatewayArgs(
description = description,
name = name,
network = network,
project = project,
region = region,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy