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:
- Account
Id string The account identifier to target for the resource.
- Config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- Tunnel
Id string Identifier of the Tunnel to target for this configuration.
- Account
Id string The account identifier to target for the resource.
- Config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- Tunnel
Id string Identifier of the Tunnel to target for this configuration.
- account
Id String The account identifier to target for the resource.
- config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- tunnel
Id String Identifier of the Tunnel to target for this configuration.
- account
Id string The account identifier to target for the resource.
- config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- tunnel
Id string Identifier of the Tunnel to target for this configuration.
- account_
id str The account identifier to target for the resource.
- config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- tunnel_
id str Identifier of the Tunnel to target for this configuration.
- account
Id String The account identifier to target for the resource.
- config Property Map
Configuration block for Tunnel Configuration.
- tunnel
Id 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.
- Account
Id string The account identifier to target for the resource.
- Config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- Tunnel
Id string Identifier of the Tunnel to target for this configuration.
- Account
Id string The account identifier to target for the resource.
- Config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- Tunnel
Id string Identifier of the Tunnel to target for this configuration.
- account
Id String The account identifier to target for the resource.
- config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- tunnel
Id String Identifier of the Tunnel to target for this configuration.
- account
Id string The account identifier to target for the resource.
- config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- tunnel
Id string Identifier of the Tunnel to target for this configuration.
- account_
id str The account identifier to target for the resource.
- config
Tunnel
Config Config Args Configuration block for Tunnel Configuration.
- tunnel_
id str Identifier of the Tunnel to target for this configuration.
- account
Id String The account identifier to target for the resource.
- config Property Map
Configuration block for Tunnel Configuration.
- tunnel
Id String Identifier of the Tunnel to target for this configuration.
Supporting Types
TunnelConfigConfig
- Ingress
Rules List<TunnelConfig Config Ingress Rule> 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 TunnelConfig Config Origin Request - Warp
Routing TunnelConfig Config Warp Routing If you're exposing a private network, you need to add the
warp-routing
key and set it totrue
.
- Ingress
Rules []TunnelConfig Config Ingress Rule 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 TunnelConfig Config Origin Request - Warp
Routing TunnelConfig Config Warp Routing If you're exposing a private network, you need to add the
warp-routing
key and set it totrue
.
- ingress
Rules List<TunnelConfig Config Ingress Rule> 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 TunnelConfig Config Origin Request - warp
Routing TunnelConfig Config Warp Routing If you're exposing a private network, you need to add the
warp-routing
key and set it totrue
.
- ingress
Rules TunnelConfig Config Ingress Rule[] 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 TunnelConfig Config Origin Request - warp
Routing TunnelConfig Config Warp Routing If you're exposing a private network, you need to add the
warp-routing
key and set it totrue
.
- ingress_
rules Sequence[TunnelConfig Config Ingress Rule] 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 TunnelConfig Config Origin Request - warp_
routing TunnelConfig Config Warp Routing If you're exposing a private network, you need to add the
warp-routing
key and set it totrue
.
- ingress
Rules 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.
- origin
Request Property Map - warp
Routing Property Map If you're exposing a private network, you need to add the
warp-routing
key and set it totrue
.
TunnelConfigConfigIngressRule
TunnelConfigConfigOriginRequest
- Bastion
Mode bool - Ca
Pool string - Connect
Timeout string - Disable
Chunked boolEncoding - Http
Host stringHeader - Ip
Rules List<TunnelConfig Config Origin Request Ip Rule> - Keep
Alive intConnections - Keep
Alive stringTimeout - No
Happy boolEyeballs - No
Tls boolVerify - Origin
Server stringName - Proxy
Address string - Proxy
Port int - Proxy
Type string - Tcp
Keep stringAlive - Tls
Timeout string
- Bastion
Mode bool - Ca
Pool string - Connect
Timeout string - Disable
Chunked boolEncoding - Http
Host stringHeader - Ip
Rules []TunnelConfig Config Origin Request Ip Rule - Keep
Alive intConnections - Keep
Alive stringTimeout - No
Happy boolEyeballs - No
Tls boolVerify - Origin
Server stringName - Proxy
Address string - Proxy
Port int - Proxy
Type string - Tcp
Keep stringAlive - Tls
Timeout string
- bastion
Mode Boolean - ca
Pool String - connect
Timeout String - disable
Chunked BooleanEncoding - http
Host StringHeader - ip
Rules List<TunnelConfig Config Origin Request Ip Rule> - keep
Alive IntegerConnections - keep
Alive StringTimeout - no
Happy BooleanEyeballs - no
Tls BooleanVerify - origin
Server StringName - proxy
Address String - proxy
Port Integer - proxy
Type String - tcp
Keep StringAlive - tls
Timeout String
- bastion
Mode boolean - ca
Pool string - connect
Timeout string - disable
Chunked booleanEncoding - http
Host stringHeader - ip
Rules TunnelConfig Config Origin Request Ip Rule[] - keep
Alive numberConnections - keep
Alive stringTimeout - no
Happy booleanEyeballs - no
Tls booleanVerify - origin
Server stringName - proxy
Address string - proxy
Port number - proxy
Type string - tcp
Keep stringAlive - tls
Timeout string
- bastion_
mode bool - ca_
pool str - connect_
timeout str - disable_
chunked_ boolencoding - http_
host_ strheader - ip_
rules Sequence[TunnelConfig Config Origin Request Ip Rule] - keep_
alive_ intconnections - keep_
alive_ strtimeout - no_
happy_ booleyeballs - no_
tls_ boolverify - origin_
server_ strname - proxy_
address str - proxy_
port int - proxy_
type str - tcp_
keep_ stralive - tls_
timeout str
- bastion
Mode Boolean - ca
Pool String - connect
Timeout String - disable
Chunked BooleanEncoding - http
Host StringHeader - ip
Rules List<Property Map> - keep
Alive NumberConnections - keep
Alive StringTimeout - no
Happy BooleanEyeballs - no
Tls BooleanVerify - origin
Server StringName - proxy
Address String - proxy
Port Number - proxy
Type String - tcp
Keep StringAlive - tls
Timeout String
TunnelConfigConfigOriginRequestIpRule
TunnelConfigConfigWarpRouting
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cloudflare
Terraform Provider.