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

com.pulumi.gcp.edgecontainer.kotlin.VpnConnection.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.edgecontainer.kotlin

import com.pulumi.core.Output
import com.pulumi.gcp.edgecontainer.kotlin.outputs.VpnConnectionDetail
import com.pulumi.gcp.edgecontainer.kotlin.outputs.VpnConnectionVpcProject
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.gcp.edgecontainer.kotlin.outputs.VpnConnectionDetail.Companion.toKotlin as vpnConnectionDetailToKotlin
import com.pulumi.gcp.edgecontainer.kotlin.outputs.VpnConnectionVpcProject.Companion.toKotlin as vpnConnectionVpcProjectToKotlin

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

    public var args: VpnConnectionArgs = VpnConnectionArgs()

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

/**
 * A VPN connection
 * To get more information about VpnConnection, see:
 * * [API documentation](https://cloud.google.com/distributed-cloud/edge/latest/docs/reference/container/rest/v1/projects.locations.vpnConnections)
 * * How-to Guides
 *     * [Google Distributed Cloud Edge](https://cloud.google.com/distributed-cloud/edge/latest/docs)
 * ## Example Usage
 * ### Edgecontainer Vpn Connection
 * 
 * ```typescript
 * 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: "[email protected]",
 *         },
 *     },
 *     networking: {
 *         clusterIpv4CidrBlocks: ["10.0.0.0/16"],
 *         servicesIpv4CidrBlocks: ["10.1.0.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.name]).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",
 *     },
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * project = gcp.organizations.get_project()
 * cluster = gcp.edgecontainer.Cluster("cluster",
 *     name="default",
 *     location="us-central1",
 *     authorization=gcp.edgecontainer.ClusterAuthorizationArgs(
 *         admin_users=gcp.edgecontainer.ClusterAuthorizationAdminUsersArgs(
 *             username="[email protected]",
 *         ),
 *     ),
 *     networking=gcp.edgecontainer.ClusterNetworkingArgs(
 *         cluster_ipv4_cidr_blocks=["10.0.0.0/16"],
 *         services_ipv4_cidr_blocks=["10.1.0.0/16"],
 *     ),
 *     fleet=gcp.edgecontainer.ClusterFleetArgs(
 *         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",
 *     })
 * ```
 * ```csharp
 * 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 = "[email protected]",
 *             },
 *         },
 *         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" },
 *         },
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"fmt"
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/edgecontainer"
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/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, nil, 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("[email protected]"),
 * 				},
 * 			},
 * 			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.String(fmt.Sprintf("projects/%v", project.Number)),
 * 			},
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, 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"),
 * 			},
 * 		})
 * 		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.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 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();
 *         var cluster = new Cluster("cluster", ClusterArgs.builder()
 *             .name("default")
 *             .location("us-central1")
 *             .authorization(ClusterAuthorizationArgs.builder()
 *                 .adminUsers(ClusterAuthorizationAdminUsersArgs.builder()
 *                     .username("[email protected]")
 *                     .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.applyValue(getProjectResult -> getProjectResult.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.applyValue(getProjectResult -> getProjectResult.number()),name)))
 *             .vpc(vpc.name())
 *             .enableHighAvailability(true)
 *             .labels(Map.ofEntries(
 *                 Map.entry("my_key", "my_val"),
 *                 Map.entry("other_key", "other_val")
 *             ))
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   cluster:
 *     type: gcp:edgecontainer:Cluster
 *     properties:
 *       name: default
 *       location: us-central1
 *       authorization:
 *         adminUsers:
 *           username: [email protected]
 *       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
 *   vpc:
 *     type: gcp:compute:Network
 *     properties:
 *       name: example-vpc
 * variables:
 *   project:
 *     fn::invoke:
 *       Function: gcp:organizations:getProject
 *       Arguments: {}
 * ```
 * 
 * ## 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:
 * ```sh
 * $ pulumi import gcp:edgecontainer/vpnConnection:VpnConnection default projects/{{project}}/locations/{{location}}/vpnConnections/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:edgecontainer/vpnConnection:VpnConnection default {{project}}/{{location}}/{{name}}
 * ```
 * ```sh
 * $ pulumi import gcp:edgecontainer/vpnConnection:VpnConnection default {{location}}/{{name}}
 * ```
 */
public class VpnConnection internal constructor(
    override val javaResource: com.pulumi.gcp.edgecontainer.VpnConnection,
) : KotlinCustomResource(javaResource, VpnConnectionMapper) {
    /**
     * The canonical Cluster name to connect to. It is in the form of projects/{project}/locations/{location}/clusters/{cluster}.
     */
    public val cluster: Output
        get() = javaResource.cluster().applyValue({ args0 -> args0 })

    /**
     * The time when the VPN connection was created.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * A nested object resource
     * Structure is documented below.
     */
    public val details: Output>
        get() = javaResource.details().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    vpnConnectionDetailToKotlin(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()
        })

    /**
     * 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.
     */
    public val enableHighAvailability: Output
        get() = javaResource.enableHighAvailability().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val labels: Output>?
        get() = javaResource.labels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * Google Cloud Platform location.
     * - - -
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * The resource name of VPN connection
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * 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.
     */
    public val natGatewayIp: Output?
        get() = javaResource.natGatewayIp().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * 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 VPN connection Cloud Router name.
     */
    public val router: Output?
        get() = javaResource.router().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The time when the VPN connection was last updated.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })

    /**
     * The network ID of VPC to connect to.
     */
    public val vpc: Output?
        get() = javaResource.vpc().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Project detail of the VPC network. Required if VPC is in a different project than the cluster project.
     * Structure is documented below.
     */
    public val vpcProject: Output?
        get() = javaResource.vpcProject().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    vpnConnectionVpcProjectToKotlin(args0)
                })
            }).orElse(null)
        })
}

public object VpnConnectionMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.edgecontainer.VpnConnection::class == javaResource::class

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

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy