com.pulumi.cloudflare.kotlin.Tunnel.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-cloudflare-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.
There is a newer version: 5.40.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.cloudflare.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.String
import kotlin.Suppress
import kotlin.Unit

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

    public var args: TunnelArgs = TunnelArgs()

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

/**
 * Tunnel exposes applications running on your local web server on any
 * network with an internet connection without manually adding DNS
 * records or configuring a firewall or router.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cloudflare from "@pulumi/cloudflare";
 * const example = new cloudflare.Tunnel("example", {
 *     accountId: "f037e56e89293a057740de681ac9abbe",
 *     name: "my-tunnel",
 *     secret: "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_cloudflare as cloudflare
 * example = cloudflare.Tunnel("example",
 *     account_id="f037e56e89293a057740de681ac9abbe",
 *     name="my-tunnel",
 *     secret="AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Cloudflare = Pulumi.Cloudflare;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Cloudflare.Tunnel("example", new()
 *     {
 *         AccountId = "f037e56e89293a057740de681ac9abbe",
 *         Name = "my-tunnel",
 *         Secret = "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := cloudflare.NewTunnel(ctx, "example", &cloudflare.TunnelArgs{
 * 			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
 * 			Name:      pulumi.String("my-tunnel"),
 * 			Secret:    pulumi.String("AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg="),
 * 		})
 * 		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.cloudflare.Tunnel;
 * import com.pulumi.cloudflare.TunnelArgs;
 * 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 example = new Tunnel("example", TunnelArgs.builder()
 *             .accountId("f037e56e89293a057740de681ac9abbe")
 *             .name("my-tunnel")
 *             .secret("AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: cloudflare:Tunnel
 *     properties:
 *       accountId: f037e56e89293a057740de681ac9abbe
 *       name: my-tunnel
 *       secret: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=
 * ```
 * 
 * ## Import
 * ```sh
 * $ pulumi import cloudflare:index/tunnel:Tunnel example /
 * ```
 */
public class Tunnel internal constructor(
    override val javaResource: com.pulumi.cloudflare.Tunnel,
) : KotlinCustomResource(javaResource, TunnelMapper) {
    /**
     * The account identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
     */
    public val accountId: Output
        get() = javaResource.accountId().applyValue({ args0 -> args0 })

    /**
     * Usable CNAME for accessing the Tunnel.
     */
    public val cname: Output
        get() = javaResource.cname().applyValue({ args0 -> args0 })

    /**
     * Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard or using tunnel*config, tunnel*route or tunnel*virtual*network resources. Available values: `local`, `cloudflare`. **Modifying this attribute will force creation of a new resource.**
     */
    public val configSrc: Output?
        get() = javaResource.configSrc().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * A user-friendly name chosen when the tunnel is created. **Modifying this attribute will force creation of a new resource.**
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * 32 or more bytes, encoded as a base64 string. The Create Argo Tunnel endpoint sets this as the tunnel's password. Anyone wishing to run the tunnel needs this password. **Modifying this attribute will force creation of a new resource.**
     */
    public val secret: Output
        get() = javaResource.secret().applyValue({ args0 -> args0 })

    /**
     * Token used by a connector to authenticate and run the tunnel.
     */
    public val tunnelToken: Output
        get() = javaResource.tunnelToken().applyValue({ args0 -> args0 })
}

public object TunnelMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.cloudflare.Tunnel::class == javaResource::class

    override fun map(javaResource: Resource): Tunnel = Tunnel(
        javaResource as
            com.pulumi.cloudflare.Tunnel,
    )
}

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

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