1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. Tunnel
Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

cloudflare.Tunnel

Explore with Pulumi AI

Deprecated: cloudflare.index/tunnel.Tunnel has been deprecated in favor of cloudflare.index/zerotrusttunnelcloudflared.ZeroTrustTunnelCloudflared

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleZeroTrustTunnelCloudflared = new cloudflare.ZeroTrustTunnelCloudflared("example_zero_trust_tunnel_cloudflared", {
    accountId: "699d98642c564d2e855e9661899b7252",
    name: "blog",
    configSrc: "cloudflare",
    tunnelSecret: "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_zero_trust_tunnel_cloudflared = cloudflare.ZeroTrustTunnelCloudflared("example_zero_trust_tunnel_cloudflared",
    account_id="699d98642c564d2e855e9661899b7252",
    name="blog",
    config_src="cloudflare",
    tunnel_secret="AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=")
Copy
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewZeroTrustTunnelCloudflared(ctx, "example_zero_trust_tunnel_cloudflared", &cloudflare.ZeroTrustTunnelCloudflaredArgs{
			AccountId:    pulumi.String("699d98642c564d2e855e9661899b7252"),
			Name:         pulumi.String("blog"),
			ConfigSrc:    pulumi.String("cloudflare"),
			TunnelSecret: pulumi.String("AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg="),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleZeroTrustTunnelCloudflared = new Cloudflare.ZeroTrustTunnelCloudflared("example_zero_trust_tunnel_cloudflared", new()
    {
        AccountId = "699d98642c564d2e855e9661899b7252",
        Name = "blog",
        ConfigSrc = "cloudflare",
        TunnelSecret = "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.ZeroTrustTunnelCloudflared;
import com.pulumi.cloudflare.ZeroTrustTunnelCloudflaredArgs;
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 exampleZeroTrustTunnelCloudflared = new ZeroTrustTunnelCloudflared("exampleZeroTrustTunnelCloudflared", ZeroTrustTunnelCloudflaredArgs.builder()
            .accountId("699d98642c564d2e855e9661899b7252")
            .name("blog")
            .configSrc("cloudflare")
            .tunnelSecret("AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=")
            .build());

    }
}
Copy
resources:
  exampleZeroTrustTunnelCloudflared:
    type: cloudflare:ZeroTrustTunnelCloudflared
    name: example_zero_trust_tunnel_cloudflared
    properties:
      accountId: 699d98642c564d2e855e9661899b7252
      name: blog
      configSrc: cloudflare
      tunnelSecret: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=
Copy

Create Tunnel Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Tunnel(name: string, args: TunnelArgs, opts?: CustomResourceOptions);
@overload
def Tunnel(resource_name: str,
           args: TunnelArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Tunnel(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           account_id: Optional[str] = None,
           config_src: Optional[str] = None,
           name: Optional[str] = None,
           tunnel_secret: Optional[str] = None)
func NewTunnel(ctx *Context, name string, args TunnelArgs, opts ...ResourceOption) (*Tunnel, error)
public Tunnel(string name, TunnelArgs args, CustomResourceOptions? opts = null)
public Tunnel(String name, TunnelArgs args)
public Tunnel(String name, TunnelArgs args, CustomResourceOptions options)
type: cloudflare:Tunnel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TunnelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TunnelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TunnelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TunnelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TunnelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Tunnel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Tunnel resource accepts the following input properties:

AccountId This property is required. string
Cloudflare account ID
Name This property is required. string
A user-friendly name for a tunnel.
ConfigSrc string
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. Available values: "local", "cloudflare".
TunnelSecret string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
AccountId This property is required. string
Cloudflare account ID
Name This property is required. string
A user-friendly name for a tunnel.
ConfigSrc string
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. Available values: "local", "cloudflare".
TunnelSecret string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
accountId This property is required. String
Cloudflare account ID
name This property is required. String
A user-friendly name for a tunnel.
configSrc String
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. Available values: "local", "cloudflare".
tunnelSecret String
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
accountId This property is required. string
Cloudflare account ID
name This property is required. string
A user-friendly name for a tunnel.
configSrc string
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. Available values: "local", "cloudflare".
tunnelSecret string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
account_id This property is required. str
Cloudflare account ID
name This property is required. str
A user-friendly name for a tunnel.
config_src str
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. Available values: "local", "cloudflare".
tunnel_secret str
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
accountId This property is required. String
Cloudflare account ID
name This property is required. String
A user-friendly name for a tunnel.
configSrc String
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. Available values: "local", "cloudflare".
tunnelSecret String
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.

Outputs

All input properties are implicitly available as output properties. Additionally, the Tunnel resource produces the following output properties:

AccountTag string
Cloudflare account ID
Connections List<TunnelConnection>
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
ConnsActiveAt string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
ConnsInactiveAt string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
CreatedAt string
Timestamp of when the resource was created.
DeletedAt string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
Id string
The provider-assigned unique ID for this managed resource.
Metadata string
Metadata associated with the tunnel.
RemoteConfig bool
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
Status string
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
TunType string
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
AccountTag string
Cloudflare account ID
Connections []TunnelConnection
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
ConnsActiveAt string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
ConnsInactiveAt string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
CreatedAt string
Timestamp of when the resource was created.
DeletedAt string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
Id string
The provider-assigned unique ID for this managed resource.
Metadata string
Metadata associated with the tunnel.
RemoteConfig bool
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
Status string
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
TunType string
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
accountTag String
Cloudflare account ID
connections List<TunnelConnection>
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
connsActiveAt String
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
connsInactiveAt String
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
createdAt String
Timestamp of when the resource was created.
deletedAt String
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
id String
The provider-assigned unique ID for this managed resource.
metadata String
Metadata associated with the tunnel.
remoteConfig Boolean
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status String
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tunType String
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
accountTag string
Cloudflare account ID
connections TunnelConnection[]
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
connsActiveAt string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
connsInactiveAt string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
createdAt string
Timestamp of when the resource was created.
deletedAt string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
id string
The provider-assigned unique ID for this managed resource.
metadata string
Metadata associated with the tunnel.
remoteConfig boolean
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status string
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tunType string
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
account_tag str
Cloudflare account ID
connections Sequence[TunnelConnection]
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
conns_active_at str
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
conns_inactive_at str
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
created_at str
Timestamp of when the resource was created.
deleted_at str
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
id str
The provider-assigned unique ID for this managed resource.
metadata str
Metadata associated with the tunnel.
remote_config bool
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status str
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tun_type str
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
accountTag String
Cloudflare account ID
connections List<Property Map>
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
connsActiveAt String
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
connsInactiveAt String
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
createdAt String
Timestamp of when the resource was created.
deletedAt String
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
id String
The provider-assigned unique ID for this managed resource.
metadata String
Metadata associated with the tunnel.
remoteConfig Boolean
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status String
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tunType String
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".

Look up Existing Tunnel Resource

Get an existing Tunnel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TunnelState, opts?: CustomResourceOptions): Tunnel
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        account_tag: Optional[str] = None,
        config_src: Optional[str] = None,
        connections: Optional[Sequence[TunnelConnectionArgs]] = None,
        conns_active_at: Optional[str] = None,
        conns_inactive_at: Optional[str] = None,
        created_at: Optional[str] = None,
        deleted_at: Optional[str] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        remote_config: Optional[bool] = None,
        status: Optional[str] = None,
        tun_type: Optional[str] = None,
        tunnel_secret: Optional[str] = None) -> Tunnel
func GetTunnel(ctx *Context, name string, id IDInput, state *TunnelState, opts ...ResourceOption) (*Tunnel, error)
public static Tunnel Get(string name, Input<string> id, TunnelState? state, CustomResourceOptions? opts = null)
public static Tunnel get(String name, Output<String> id, TunnelState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:Tunnel    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountId string
Cloudflare account ID
AccountTag string
Cloudflare account ID
ConfigSrc string
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. Available values: "local", "cloudflare".
Connections List<TunnelConnection>
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
ConnsActiveAt string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
ConnsInactiveAt string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
CreatedAt string
Timestamp of when the resource was created.
DeletedAt string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
Metadata string
Metadata associated with the tunnel.
Name string
A user-friendly name for a tunnel.
RemoteConfig bool
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
Status string
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
TunType string
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
TunnelSecret string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
AccountId string
Cloudflare account ID
AccountTag string
Cloudflare account ID
ConfigSrc string
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. Available values: "local", "cloudflare".
Connections []TunnelConnectionArgs
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
ConnsActiveAt string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
ConnsInactiveAt string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
CreatedAt string
Timestamp of when the resource was created.
DeletedAt string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
Metadata string
Metadata associated with the tunnel.
Name string
A user-friendly name for a tunnel.
RemoteConfig bool
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
Status string
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
TunType string
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
TunnelSecret string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
accountId String
Cloudflare account ID
accountTag String
Cloudflare account ID
configSrc String
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. Available values: "local", "cloudflare".
connections List<TunnelConnection>
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
connsActiveAt String
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
connsInactiveAt String
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
createdAt String
Timestamp of when the resource was created.
deletedAt String
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
metadata String
Metadata associated with the tunnel.
name String
A user-friendly name for a tunnel.
remoteConfig Boolean
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status String
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tunType String
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
tunnelSecret String
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
accountId string
Cloudflare account ID
accountTag string
Cloudflare account ID
configSrc string
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. Available values: "local", "cloudflare".
connections TunnelConnection[]
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
connsActiveAt string
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
connsInactiveAt string
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
createdAt string
Timestamp of when the resource was created.
deletedAt string
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
metadata string
Metadata associated with the tunnel.
name string
A user-friendly name for a tunnel.
remoteConfig boolean
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status string
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tunType string
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
tunnelSecret string
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
account_id str
Cloudflare account ID
account_tag str
Cloudflare account ID
config_src str
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. Available values: "local", "cloudflare".
connections Sequence[TunnelConnectionArgs]
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
conns_active_at str
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
conns_inactive_at str
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
created_at str
Timestamp of when the resource was created.
deleted_at str
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
metadata str
Metadata associated with the tunnel.
name str
A user-friendly name for a tunnel.
remote_config bool
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status str
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tun_type str
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
tunnel_secret str
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.
accountId String
Cloudflare account ID
accountTag String
Cloudflare account ID
configSrc String
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. Available values: "local", "cloudflare".
connections List<Property Map>
The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
connsActiveAt String
Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If null, the tunnel is inactive.
connsInactiveAt String
Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If null, the tunnel is active.
createdAt String
Timestamp of when the resource was created.
deletedAt String
Timestamp of when the resource was deleted. If null, the resource has not been deleted.
metadata String
Metadata associated with the tunnel.
name String
A user-friendly name for a tunnel.
remoteConfig Boolean
If true, the tunnel can be configured remotely from the Zero Trust dashboard. If false, the tunnel must be configured locally on the origin machine.
status String
The status of the tunnel. Valid values are inactive (tunnel has never been run), degraded (tunnel is active and able to serve traffic but in an unhealthy state), healthy (tunnel is active and able to serve traffic), or down (tunnel can not serve traffic as it has no connections to the Cloudflare Edge). Available values: "inactive", "degraded", "healthy", "down".
tunType String
The type of tunnel. Available values: "cfdtunnel", "warpconnector", "warp", "magic", "ip_sec", "gre", "cni".
tunnelSecret String
Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.

Supporting Types

TunnelConnection
, TunnelConnectionArgs

ClientId string
UUID of the Cloudflare Tunnel connector.
ClientVersion string
The cloudflared version used to establish this connection.
ColoName string
The Cloudflare data center used for this connection.
Id string
UUID of the Cloudflare Tunnel connection.
IsPendingReconnect bool
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.
OpenedAt string
Timestamp of when the connection was established.
OriginIp string
The public IP address of the host running cloudflared.
Uuid string
UUID of the Cloudflare Tunnel connection.
ClientId string
UUID of the Cloudflare Tunnel connector.
ClientVersion string
The cloudflared version used to establish this connection.
ColoName string
The Cloudflare data center used for this connection.
Id string
UUID of the Cloudflare Tunnel connection.
IsPendingReconnect bool
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.
OpenedAt string
Timestamp of when the connection was established.
OriginIp string
The public IP address of the host running cloudflared.
Uuid string
UUID of the Cloudflare Tunnel connection.
clientId String
UUID of the Cloudflare Tunnel connector.
clientVersion String
The cloudflared version used to establish this connection.
coloName String
The Cloudflare data center used for this connection.
id String
UUID of the Cloudflare Tunnel connection.
isPendingReconnect Boolean
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.
openedAt String
Timestamp of when the connection was established.
originIp String
The public IP address of the host running cloudflared.
uuid String
UUID of the Cloudflare Tunnel connection.
clientId string
UUID of the Cloudflare Tunnel connector.
clientVersion string
The cloudflared version used to establish this connection.
coloName string
The Cloudflare data center used for this connection.
id string
UUID of the Cloudflare Tunnel connection.
isPendingReconnect boolean
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.
openedAt string
Timestamp of when the connection was established.
originIp string
The public IP address of the host running cloudflared.
uuid string
UUID of the Cloudflare Tunnel connection.
client_id str
UUID of the Cloudflare Tunnel connector.
client_version str
The cloudflared version used to establish this connection.
colo_name str
The Cloudflare data center used for this connection.
id str
UUID of the Cloudflare Tunnel connection.
is_pending_reconnect bool
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.
opened_at str
Timestamp of when the connection was established.
origin_ip str
The public IP address of the host running cloudflared.
uuid str
UUID of the Cloudflare Tunnel connection.
clientId String
UUID of the Cloudflare Tunnel connector.
clientVersion String
The cloudflared version used to establish this connection.
coloName String
The Cloudflare data center used for this connection.
id String
UUID of the Cloudflare Tunnel connection.
isPendingReconnect Boolean
Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If true, the connection has disconnected but is still being tracked. If false, the connection is actively serving traffic.
openedAt String
Timestamp of when the connection was established.
originIp String
The public IP address of the host running cloudflared.
uuid String
UUID of the Cloudflare Tunnel connection.

Import

$ pulumi import cloudflare:index/tunnel:Tunnel example '<account_id>/<tunnel_id>'
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.