pulumi-gcp-kotlin/com.pulumi.gcp.edgecontainer.kotlin/VpnConnectionArgs

VpnConnectionArgs

data class VpnConnectionArgs(val cluster: Output<String>? = null, val enableHighAvailability: Output<Boolean>? = null, val labels: Output<Map<String, String>>? = null, val location: Output<String>? = null, val name: Output<String>? = null, val natGatewayIp: Output<String>? = null, val project: Output<String>? = null, val router: Output<String>? = null, val vpc: Output<String>? = null, val vpcProject: Output<VpnConnectionVpcProjectArgs>? = null) : ConvertibleToJava<VpnConnectionArgs>

A VPN connection To get more information about VpnConnection, see:

Example Usage

Edgecontainer Vpn Connection

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const cluster = new gcp.edgecontainer.Cluster("cluster", {
    name: "default",
    location: "us-central1",
    authorization: {
        adminUsers: {
            username: "admin@hashicorptest.com",
        },
    },
    networking: {
        clusterIpv4CidrBlocks: ["10&#46;0&#46;0&#46;0/16"],
        servicesIpv4CidrBlocks: ["10&#46;1&#46;0&#46;0/16"],
    },
    fleet: {
        project: project.then(project => `projects/${project.number}`),
    },
});
const nodePool = new gcp.edgecontainer.NodePool("node_pool", {
    name: "nodepool-1",
    cluster: cluster.name,
    location: "us-central1",
    nodeLocation: "us-central1-edge-example-edgesite",
    nodeCount: 3,
});
const vpc = new gcp.compute.Network("vpc", {name: "example-vpc"});
const _default = new gcp.edgecontainer.VpnConnection("default", {
    name: "vpn-connection-1",
    location: "us-central1",
    cluster: pulumi.all([project, cluster&#46;name])&#46;apply(([project, name]) => `projects/${project.number}/locations/us-east1/clusters/${name}`),
    vpc: vpc.name,
    enableHighAvailability: true,
    labels: {
        my_key: "my_val",
        other_key: "other_val",
    },
}, {
    dependsOn: [nodePool],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
cluster = gcp.edgecontainer.Cluster("cluster",
    name="default",
    location="us-central1",
    authorization={
        "admin_users": {
            "username": "admin@hashicorptest.com",
        },
    },
    networking={
        "cluster_ipv4_cidr_blocks": ["10&#46;0&#46;0&#46;0/16"],
        "services_ipv4_cidr_blocks": ["10&#46;1&#46;0&#46;0/16"],
    },
    fleet={
        "project": f"projects/{project.number}",
    })
node_pool = gcp.edgecontainer.NodePool("node_pool",
    name="nodepool-1",
    cluster=cluster.name,
    location="us-central1",
    node_location="us-central1-edge-example-edgesite",
    node_count=3)
vpc = gcp.compute.Network("vpc", name="example-vpc")
default = gcp.edgecontainer.VpnConnection("default",
    name="vpn-connection-1",
    location="us-central1",
    cluster=cluster.name.apply(lambda name: f"projects/{project.number}/locations/us-east1/clusters/{name}"),
    vpc=vpc.name,
    enable_high_availability=True,
    labels={
        "my_key": "my_val",
        "other_key": "other_val",
    },
    opts = pulumi.ResourceOptions(depends_on=[node_pool]))
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var project = Gcp.Organizations.GetProject.Invoke();
    var cluster = new Gcp.EdgeContainer.Cluster("cluster", new()
    {
        Name = "default",
        Location = "us-central1",
        Authorization = new Gcp.EdgeContainer.Inputs.ClusterAuthorizationArgs
        {
            AdminUsers = new Gcp.EdgeContainer.Inputs.ClusterAuthorizationAdminUsersArgs
            {
                Username = "admin@hashicorptest.com",
            },
        },
        Networking = new Gcp.EdgeContainer.Inputs.ClusterNetworkingArgs
        {
            ClusterIpv4CidrBlocks = new[]
            {
                "10.0.0.0/16",
            },
            ServicesIpv4CidrBlocks = new[]
            {
                "10.1.0.0/16",
            },
        },
        Fleet = new Gcp.EdgeContainer.Inputs.ClusterFleetArgs
        {
            Project = $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}",
        },
    });
    var nodePool = new Gcp.EdgeContainer.NodePool("node_pool", new()
    {
        Name = "nodepool-1",
        Cluster = cluster.Name,
        Location = "us-central1",
        NodeLocation = "us-central1-edge-example-edgesite",
        NodeCount = 3,
    });
    var vpc = new Gcp.Compute.Network("vpc", new()
    {
        Name = "example-vpc",
    });
    var @default = new Gcp.EdgeContainer.VpnConnection("default", new()
    {
        Name = "vpn-connection-1",
        Location = "us-central1",
        Cluster = Output.Tuple(project, cluster.Name).Apply(values =>
        {
            var project = values.Item1;
            var name = values.Item2;
            return $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/locations/us-east1/clusters/{name}";
        }),
        Vpc = vpc.Name,
        EnableHighAvailability = true,
        Labels =
        {
            { "my_key", "my_val" },
            { "other_key", "other_val" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            nodePool,
        },
    });
});
Content copied to clipboard
package main
import (
	"fmt"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/edgecontainer"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		cluster, err := edgecontainer.NewCluster(ctx, "cluster", &edgecontainer.ClusterArgs{
			Name:     pulumi.String("default"),
			Location: pulumi.String("us-central1"),
			Authorization: &edgecontainer.ClusterAuthorizationArgs{
				AdminUsers: &edgecontainer.ClusterAuthorizationAdminUsersArgs{
					Username: pulumi.String("admin@hashicorptest.com"),
				},
			},
			Networking: &edgecontainer.ClusterNetworkingArgs{
				ClusterIpv4CidrBlocks: pulumi.StringArray{
					pulumi.String("10.0.0.0/16"),
				},
				ServicesIpv4CidrBlocks: pulumi.StringArray{
					pulumi.String("10.1.0.0/16"),
				},
			},
			Fleet: &edgecontainer.ClusterFleetArgs{
				Project: pulumi.Sprintf("projects/%v", project.Number),
			},
		})
		if err != nil {
			return err
		}
		nodePool, err := edgecontainer.NewNodePool(ctx, "node_pool", &edgecontainer.NodePoolArgs{
			Name:         pulumi.String("nodepool-1"),
			Cluster:      cluster.Name,
			Location:     pulumi.String("us-central1"),
			NodeLocation: pulumi.String("us-central1-edge-example-edgesite"),
			NodeCount:    pulumi.Int(3),
		})
		if err != nil {
			return err
		}
		vpc, err := compute.NewNetwork(ctx, "vpc", &compute.NetworkArgs{
			Name: pulumi.String("example-vpc"),
		})
		if err != nil {
			return err
		}
		_, err = edgecontainer.NewVpnConnection(ctx, "default", &edgecontainer.VpnConnectionArgs{
			Name:     pulumi.String("vpn-connection-1"),
			Location: pulumi.String("us-central1"),
			Cluster: cluster.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("projects/%v/locations/us-east1/clusters/%v", project.Number, name), nil
			}).(pulumi.StringOutput),
			Vpc:                    vpc.Name,
			EnableHighAvailability: pulumi.Bool(true),
			Labels: pulumi.StringMap{
				"my_key":    pulumi.String("my_val"),
				"other_key": pulumi.String("other_val"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			nodePool,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.edgecontainer.Cluster;
import com.pulumi.gcp.edgecontainer.ClusterArgs;
import com.pulumi.gcp.edgecontainer.inputs.ClusterAuthorizationArgs;
import com.pulumi.gcp.edgecontainer.inputs.ClusterAuthorizationAdminUsersArgs;
import com.pulumi.gcp.edgecontainer.inputs.ClusterNetworkingArgs;
import com.pulumi.gcp.edgecontainer.inputs.ClusterFleetArgs;
import com.pulumi.gcp.edgecontainer.NodePool;
import com.pulumi.gcp.edgecontainer.NodePoolArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.edgecontainer.VpnConnection;
import com.pulumi.gcp.edgecontainer.VpnConnectionArgs;
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) {
        final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());
        var cluster = new Cluster("cluster", ClusterArgs.builder()
            .name("default")
            .location("us-central1")
            .authorization(ClusterAuthorizationArgs.builder()
                .adminUsers(ClusterAuthorizationAdminUsersArgs.builder()
                    .username("admin@hashicorptest.com")
                    .build())
                .build())
            .networking(ClusterNetworkingArgs.builder()
                .clusterIpv4CidrBlocks("10.0.0.0/16")
                .servicesIpv4CidrBlocks("10.1.0.0/16")
                .build())
            .fleet(ClusterFleetArgs.builder()
                .project(String.format("projects/%s", project.number()))
                .build())
            .build());
        var nodePool = new NodePool("nodePool", NodePoolArgs.builder()
            .name("nodepool-1")
            .cluster(cluster.name())
            .location("us-central1")
            .nodeLocation("us-central1-edge-example-edgesite")
            .nodeCount(3)
            .build());
        var vpc = new Network("vpc", NetworkArgs.builder()
            .name("example-vpc")
            .build());
        var default_ = new VpnConnection("default", VpnConnectionArgs.builder()
            .name("vpn-connection-1")
            .location("us-central1")
            .cluster(cluster.name().applyValue(_name -> String.format("projects/%s/locations/us-east1/clusters/%s", project.number(),_name)))
            .vpc(vpc.name())
            .enableHighAvailability(true)
            .labels(Map.ofEntries(
                Map.entry("my_key", "my_val"),
                Map.entry("other_key", "other_val")
            ))
            .build(), CustomResourceOptions.builder()
                .dependsOn(nodePool)
                .build());
    }
}
Content copied to clipboard
resources:
  cluster:
    type: gcp:edgecontainer:Cluster
    properties:
      name: default
      location: us-central1
      authorization:
        adminUsers:
          username: admin@hashicorptest.com
      networking:
        clusterIpv4CidrBlocks:
          - 10.0.0.0/16
        servicesIpv4CidrBlocks:
          - 10.1.0.0/16
      fleet:
        project: projects/${project.number}
  nodePool:
    type: gcp:edgecontainer:NodePool
    name: node_pool
    properties:
      name: nodepool-1
      cluster: ${cluster.name}
      location: us-central1
      nodeLocation: us-central1-edge-example-edgesite
      nodeCount: 3
  default:
    type: gcp:edgecontainer:VpnConnection
    properties:
      name: vpn-connection-1
      location: us-central1
      cluster: projects/${project.number}/locations/us-east1/clusters/${cluster.name}
      vpc: ${vpc.name}
      enableHighAvailability: true
      labels:
        my_key: my_val
        other_key: other_val
    options:
      dependsOn:
        - ${nodePool}
  vpc:
    type: gcp:compute:Network
    properties:
      name: example-vpc
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}
Content copied to clipboard

Import

VpnConnection can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/vpnConnections/{{name}}

  • {{project}}/{{location}}/{{name}}

  • {{location}}/{{name}} When using the pulumi import command, VpnConnection can be imported using one of the formats above. For example:

$ pulumi import gcp:edgecontainer/vpnConnection:VpnConnection default projects/{{project}}/locations/{{location}}/vpnConnections/{{name}}
Content copied to clipboard
$ pulumi import gcp:edgecontainer/vpnConnection:VpnConnection default {{project}}/{{location}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:edgecontainer/vpnConnection:VpnConnection default {{location}}/{{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(cluster: Output<String>? = null, enableHighAvailability: Output<Boolean>? = null, labels: Output<Map<String, String>>? = null, location: Output<String>? = null, name: Output<String>? = null, natGatewayIp: Output<String>? = null, project: Output<String>? = null, router: Output<String>? = null, vpc: Output<String>? = null, vpcProject: Output<VpnConnectionVpcProjectArgs>? = null)

Properties

Link copied to clipboard
val cluster: Output<String>? = null

The canonical Cluster name to connect to. It is in the form of projects/{project}/locations/{location}/clusters/{cluster}.

Link copied to clipboard
val enableHighAvailability: Output<Boolean>? = null

Whether this VPN connection has HA enabled on cluster side. If enabled, when creating VPN connection we will attempt to use 2 ANG floating IPs.

Link copied to clipboard
val labels: Output<Map<String, String>>? = null

Labels associated with this resource. 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.

Link copied to clipboard
val location: Output<String>? = null

Google Cloud Platform location.

Link copied to clipboard
val name: Output<String>? = null

The resource name of VPN connection

Link copied to clipboard
val natGatewayIp: Output<String>? = null

NAT gateway IP, or WAN IP address. If a customer has multiple NAT IPs, the customer needs to configure NAT such that only one external IP maps to the GMEC Anthos cluster. This is empty if NAT is not used.

Link copied to clipboard
val project: Output<String>? = null

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

Link copied to clipboard
val router: Output<String>? = null

The VPN connection Cloud Router name.

Link copied to clipboard
val vpc: Output<String>? = null

The network ID of VPC to connect to.

Link copied to clipboard
val vpcProject: Output<VpnConnectionVpcProjectArgs>? = null

Project detail of the VPC network. Required if VPC is in a different project than the cluster project. Structure is documented below.

Functions

Link copied to clipboard
open override fun toJava(): VpnConnectionArgs