Cloudflare v5.0.0, Mar 13 23

cloudflare.TunnelVirtualNetwork

Provides a resource, that manages Cloudflare tunnel virtual networks for Zero Trust. Tunnel virtual networks are used for segregation of Tunnel IP Routes via Virtualized Networks to handle overlapping private IPs in your origins.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.TunnelVirtualNetwork("example", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        Comment = "New tunnel virtual network for documentation",
        Name = "vnet-for-documentation",
    });

});

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.NewTunnelVirtualNetwork(ctx, "example", &cloudflare.TunnelVirtualNetworkArgs{
			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
			Comment:   pulumi.String("New tunnel virtual network for documentation"),
			Name:      pulumi.String("vnet-for-documentation"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.TunnelVirtualNetwork;
import com.pulumi.cloudflare.TunnelVirtualNetworkArgs;
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 TunnelVirtualNetwork("example", TunnelVirtualNetworkArgs.builder()        
            .accountId("f037e56e89293a057740de681ac9abbe")
            .comment("New tunnel virtual network for documentation")
            .name("vnet-for-documentation")
            .build());

    }
}

import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.TunnelVirtualNetwork("example",
    account_id="f037e56e89293a057740de681ac9abbe",
    comment="New tunnel virtual network for documentation",
    name="vnet-for-documentation")

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

const example = new cloudflare.TunnelVirtualNetwork("example", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    comment: "New tunnel virtual network for documentation",
    name: "vnet-for-documentation",
});

resources:
  example:
    type: cloudflare:TunnelVirtualNetwork
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      comment: New tunnel virtual network for documentation
      name: vnet-for-documentation

Create TunnelVirtualNetwork Resource

new TunnelVirtualNetwork(name: string, args: TunnelVirtualNetworkArgs, opts?: CustomResourceOptions);

@overload
def TunnelVirtualNetwork(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_id: Optional[str] = None,
                         comment: Optional[str] = None,
                         is_default_network: Optional[bool] = None,
                         name: Optional[str] = None)
@overload
def TunnelVirtualNetwork(resource_name: str,
                         args: TunnelVirtualNetworkArgs,
                         opts: Optional[ResourceOptions] = None)

func NewTunnelVirtualNetwork(ctx *Context, name string, args TunnelVirtualNetworkArgs, opts ...ResourceOption) (*TunnelVirtualNetwork, error)

public TunnelVirtualNetwork(string name, TunnelVirtualNetworkArgs args, CustomResourceOptions? opts = null)

public TunnelVirtualNetwork(String name, TunnelVirtualNetworkArgs args)
public TunnelVirtualNetwork(String name, TunnelVirtualNetworkArgs args, CustomResourceOptions options)

type: cloudflare:TunnelVirtualNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TunnelVirtualNetworkArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TunnelVirtualNetworkArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TunnelVirtualNetworkArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TunnelVirtualNetworkArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TunnelVirtualNetworkArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

TunnelVirtualNetwork Resource Properties

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

Inputs

The TunnelVirtualNetwork resource accepts the following input properties:

AccountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Name string: A user-friendly name chosen when the virtual network is created.
Comment string: Description of the tunnel virtual network.
IsDefaultNetwork bool: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.

AccountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Name string: A user-friendly name chosen when the virtual network is created.
Comment string: Description of the tunnel virtual network.
IsDefaultNetwork bool: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
name String: A user-friendly name chosen when the virtual network is created.
comment String: Description of the tunnel virtual network.
isDefaultNetwork Boolean: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.

accountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
name string: A user-friendly name chosen when the virtual network is created.
comment string: Description of the tunnel virtual network.
isDefaultNetwork boolean: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.

account_id str: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
name str: A user-friendly name chosen when the virtual network is created.
comment str: Description of the tunnel virtual network.
is_default_network bool: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
name String: A user-friendly name chosen when the virtual network is created.
comment String: Description of the tunnel virtual network.
isDefaultNetwork Boolean: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing TunnelVirtualNetwork Resource

Get an existing TunnelVirtualNetwork 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?: TunnelVirtualNetworkState, opts?: CustomResourceOptions): TunnelVirtualNetwork

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        comment: Optional[str] = None,
        is_default_network: Optional[bool] = None,
        name: Optional[str] = None) -> TunnelVirtualNetwork

func GetTunnelVirtualNetwork(ctx *Context, name string, id IDInput, state *TunnelVirtualNetworkState, opts ...ResourceOption) (*TunnelVirtualNetwork, error)

public static TunnelVirtualNetwork Get(string name, Input<string> id, TunnelVirtualNetworkState? state, CustomResourceOptions? opts = null)

public static TunnelVirtualNetwork get(String name, Output<String> id, TunnelVirtualNetworkState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Comment string: Description of the tunnel virtual network.
IsDefaultNetwork bool: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.
Name string: A user-friendly name chosen when the virtual network is created.

AccountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
Comment string: Description of the tunnel virtual network.
IsDefaultNetwork bool: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.
Name string: A user-friendly name chosen when the virtual network is created.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
comment String: Description of the tunnel virtual network.
isDefaultNetwork Boolean: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.
name String: A user-friendly name chosen when the virtual network is created.

accountId string: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
comment string: Description of the tunnel virtual network.
isDefaultNetwork boolean: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.
name string: A user-friendly name chosen when the virtual network is created.

account_id str: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
comment str: Description of the tunnel virtual network.
is_default_network bool: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.
name str: A user-friendly name chosen when the virtual network is created.

accountId String: The account identifier to target for the resource. Modifying this attribute will force creation of a new resource.
comment String: Description of the tunnel virtual network.
isDefaultNetwork Boolean: Whether this virtual network is the default one for the account. This means IP Routes belong to this virtual network and Teams Clients in the account route through this virtual network, unless specified otherwise for each case.
name String: A user-friendly name chosen when the virtual network is created.

Import

 $ pulumi import cloudflare:index/tunnelVirtualNetwork:TunnelVirtualNetwork example <account_id>/<vnet_id>

Package Details

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