Cloudflare v5.0.0, Mar 13 23

cloudflare.TunnelConfig

Provides a Cloudflare Tunnel configuration resource.

!> When you delete a tunnel configuration, the tunnel will be deleted. You need to make sure that the tunnel is not in use before deleting the configuration.

Create TunnelConfig Resource

new TunnelConfig(name: string, args: TunnelConfigArgs, opts?: CustomResourceOptions);

@overload
def TunnelConfig(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 account_id: Optional[str] = None,
                 config: Optional[TunnelConfigConfigArgs] = None,
                 tunnel_id: Optional[str] = None)
@overload
def TunnelConfig(resource_name: str,
                 args: TunnelConfigArgs,
                 opts: Optional[ResourceOptions] = None)

func NewTunnelConfig(ctx *Context, name string, args TunnelConfigArgs, opts ...ResourceOption) (*TunnelConfig, error)

public TunnelConfig(string name, TunnelConfigArgs args, CustomResourceOptions? opts = null)

public TunnelConfig(String name, TunnelConfigArgs args)
public TunnelConfig(String name, TunnelConfigArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args TunnelConfigArgs: 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 TunnelConfigArgs: 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 TunnelConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

TunnelConfig 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 TunnelConfig resource accepts the following input properties:

AccountId string: The account identifier to target for the resource.
Config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
TunnelId string: Identifier of the Tunnel to target for this configuration.

AccountId string: The account identifier to target for the resource.
Config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
TunnelId string: Identifier of the Tunnel to target for this configuration.

accountId String: The account identifier to target for the resource.
config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
tunnelId String: Identifier of the Tunnel to target for this configuration.

accountId string: The account identifier to target for the resource.
config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
tunnelId string: Identifier of the Tunnel to target for this configuration.

account_id str: The account identifier to target for the resource.
config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
tunnel_id str: Identifier of the Tunnel to target for this configuration.

accountId String: The account identifier to target for the resource.
config Property Map: Configuration block for Tunnel Configuration.
tunnelId String: Identifier of the Tunnel to target for this configuration.

Outputs

All input properties are implicitly available as output properties. Additionally, the TunnelConfig 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 TunnelConfig Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        config: Optional[TunnelConfigConfigArgs] = None,
        tunnel_id: Optional[str] = None) -> TunnelConfig

func GetTunnelConfig(ctx *Context, name string, id IDInput, state *TunnelConfigState, opts ...ResourceOption) (*TunnelConfig, error)

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

public static TunnelConfig get(String name, Output<String> id, TunnelConfigState 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.
Config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
TunnelId string: Identifier of the Tunnel to target for this configuration.

AccountId string: The account identifier to target for the resource.
Config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
TunnelId string: Identifier of the Tunnel to target for this configuration.

accountId String: The account identifier to target for the resource.
config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
tunnelId String: Identifier of the Tunnel to target for this configuration.

accountId string: The account identifier to target for the resource.
config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
tunnelId string: Identifier of the Tunnel to target for this configuration.

account_id str: The account identifier to target for the resource.
config TunnelConfigConfigArgs: Configuration block for Tunnel Configuration.
tunnel_id str: Identifier of the Tunnel to target for this configuration.

accountId String: The account identifier to target for the resource.
config Property Map: Configuration block for Tunnel Configuration.
tunnelId String: Identifier of the Tunnel to target for this configuration.

Supporting Types

TunnelConfigConfig

IngressRules List<TunnelConfigConfigIngressRule>: Each incoming request received by cloudflared causes cloudflared to send a request to a local service. This section configures the rules that determine which requests are sent to which local services. Read more.
OriginRequest TunnelConfigConfigOriginRequest
WarpRouting TunnelConfigConfigWarpRouting: If you're exposing a private network, you need to add the warp-routing key and set it to true.

IngressRules []TunnelConfigConfigIngressRule: Each incoming request received by cloudflared causes cloudflared to send a request to a local service. This section configures the rules that determine which requests are sent to which local services. Read more.
OriginRequest TunnelConfigConfigOriginRequest
WarpRouting TunnelConfigConfigWarpRouting: If you're exposing a private network, you need to add the warp-routing key and set it to true.

ingressRules List<TunnelConfigConfigIngressRule>: Each incoming request received by cloudflared causes cloudflared to send a request to a local service. This section configures the rules that determine which requests are sent to which local services. Read more.
originRequest TunnelConfigConfigOriginRequest
warpRouting TunnelConfigConfigWarpRouting: If you're exposing a private network, you need to add the warp-routing key and set it to true.

ingressRules TunnelConfigConfigIngressRule[]: Each incoming request received by cloudflared causes cloudflared to send a request to a local service. This section configures the rules that determine which requests are sent to which local services. Read more.
originRequest TunnelConfigConfigOriginRequest
warpRouting TunnelConfigConfigWarpRouting: If you're exposing a private network, you need to add the warp-routing key and set it to true.

ingress_rules Sequence[TunnelConfigConfigIngressRule]: Each incoming request received by cloudflared causes cloudflared to send a request to a local service. This section configures the rules that determine which requests are sent to which local services. Read more.
origin_request TunnelConfigConfigOriginRequest
warp_routing TunnelConfigConfigWarpRouting: If you're exposing a private network, you need to add the warp-routing key and set it to true.

ingressRules List<Property Map>: Each incoming request received by cloudflared causes cloudflared to send a request to a local service. This section configures the rules that determine which requests are sent to which local services. Read more.
originRequest Property Map
warpRouting Property Map: If you're exposing a private network, you need to add the warp-routing key and set it to true.