1. Packages
  2. Fortios
  3. API Docs
  4. webproxy
  5. Urlmatch
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

fortios.webproxy.Urlmatch

Explore with Pulumi AI

fortios logo
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse

    Exempt URLs from web proxy forwarding and caching.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fortios from "@pulumiverse/fortios";
    
    const trname2 = new fortios.webproxy.Forwardserver("trname2", {
        addrType: "fqdn",
        healthcheck: "disable",
        ip: "0.0.0.0",
        monitor: "http://www.google.com",
        port: 3128,
        serverDownOption: "block",
    });
    const trname = new fortios.webproxy.Urlmatch("trname", {
        cacheExemption: "disable",
        forwardServer: trname2.name,
        status: "enable",
        urlPattern: "/examples/servlet/*Servlet",
    });
    
    import pulumi
    import pulumiverse_fortios as fortios
    
    trname2 = fortios.webproxy.Forwardserver("trname2",
        addr_type="fqdn",
        healthcheck="disable",
        ip="0.0.0.0",
        monitor="http://www.google.com",
        port=3128,
        server_down_option="block")
    trname = fortios.webproxy.Urlmatch("trname",
        cache_exemption="disable",
        forward_server=trname2.name,
        status="enable",
        url_pattern="/examples/servlet/*Servlet")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/webproxy"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		trname2, err := webproxy.NewForwardserver(ctx, "trname2", &webproxy.ForwardserverArgs{
    			AddrType:         pulumi.String("fqdn"),
    			Healthcheck:      pulumi.String("disable"),
    			Ip:               pulumi.String("0.0.0.0"),
    			Monitor:          pulumi.String("http://www.google.com"),
    			Port:             pulumi.Int(3128),
    			ServerDownOption: pulumi.String("block"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = webproxy.NewUrlmatch(ctx, "trname", &webproxy.UrlmatchArgs{
    			CacheExemption: pulumi.String("disable"),
    			ForwardServer:  trname2.Name,
    			Status:         pulumi.String("enable"),
    			UrlPattern:     pulumi.String("/examples/servlet/*Servlet"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Fortios = Pulumiverse.Fortios;
    
    return await Deployment.RunAsync(() => 
    {
        var trname2 = new Fortios.Webproxy.Forwardserver("trname2", new()
        {
            AddrType = "fqdn",
            Healthcheck = "disable",
            Ip = "0.0.0.0",
            Monitor = "http://www.google.com",
            Port = 3128,
            ServerDownOption = "block",
        });
    
        var trname = new Fortios.Webproxy.Urlmatch("trname", new()
        {
            CacheExemption = "disable",
            ForwardServer = trname2.Name,
            Status = "enable",
            UrlPattern = "/examples/servlet/*Servlet",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fortios.webproxy.Forwardserver;
    import com.pulumi.fortios.webproxy.ForwardserverArgs;
    import com.pulumi.fortios.webproxy.Urlmatch;
    import com.pulumi.fortios.webproxy.UrlmatchArgs;
    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 trname2 = new Forwardserver("trname2", ForwardserverArgs.builder()
                .addrType("fqdn")
                .healthcheck("disable")
                .ip("0.0.0.0")
                .monitor("http://www.google.com")
                .port(3128)
                .serverDownOption("block")
                .build());
    
            var trname = new Urlmatch("trname", UrlmatchArgs.builder()
                .cacheExemption("disable")
                .forwardServer(trname2.name())
                .status("enable")
                .urlPattern("/examples/servlet/*Servlet")
                .build());
    
        }
    }
    
    resources:
      trname2:
        type: fortios:webproxy:Forwardserver
        properties:
          addrType: fqdn
          healthcheck: disable
          ip: 0.0.0.0
          monitor: http://www.google.com
          port: 3128
          serverDownOption: block
      trname:
        type: fortios:webproxy:Urlmatch
        properties:
          cacheExemption: disable
          forwardServer: ${trname2.name}
          status: enable
          urlPattern: /examples/servlet/*Servlet
    

    Create Urlmatch Resource

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

    Constructor syntax

    new Urlmatch(name: string, args: UrlmatchArgs, opts?: CustomResourceOptions);
    @overload
    def Urlmatch(resource_name: str,
                 args: UrlmatchArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Urlmatch(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 url_pattern: Optional[str] = None,
                 cache_exemption: Optional[str] = None,
                 comment: Optional[str] = None,
                 fast_fallback: Optional[str] = None,
                 forward_server: Optional[str] = None,
                 name: Optional[str] = None,
                 status: Optional[str] = None,
                 vdomparam: Optional[str] = None)
    func NewUrlmatch(ctx *Context, name string, args UrlmatchArgs, opts ...ResourceOption) (*Urlmatch, error)
    public Urlmatch(string name, UrlmatchArgs args, CustomResourceOptions? opts = null)
    public Urlmatch(String name, UrlmatchArgs args)
    public Urlmatch(String name, UrlmatchArgs args, CustomResourceOptions options)
    
    type: fortios:webproxy:Urlmatch
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var urlmatchResource = new Fortios.Webproxy.Urlmatch("urlmatchResource", new()
    {
        UrlPattern = "string",
        CacheExemption = "string",
        Comment = "string",
        FastFallback = "string",
        ForwardServer = "string",
        Name = "string",
        Status = "string",
        Vdomparam = "string",
    });
    
    example, err := webproxy.NewUrlmatch(ctx, "urlmatchResource", &webproxy.UrlmatchArgs{
    	UrlPattern:     pulumi.String("string"),
    	CacheExemption: pulumi.String("string"),
    	Comment:        pulumi.String("string"),
    	FastFallback:   pulumi.String("string"),
    	ForwardServer:  pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	Status:         pulumi.String("string"),
    	Vdomparam:      pulumi.String("string"),
    })
    
    var urlmatchResource = new Urlmatch("urlmatchResource", UrlmatchArgs.builder()
        .urlPattern("string")
        .cacheExemption("string")
        .comment("string")
        .fastFallback("string")
        .forwardServer("string")
        .name("string")
        .status("string")
        .vdomparam("string")
        .build());
    
    urlmatch_resource = fortios.webproxy.Urlmatch("urlmatchResource",
        url_pattern="string",
        cache_exemption="string",
        comment="string",
        fast_fallback="string",
        forward_server="string",
        name="string",
        status="string",
        vdomparam="string")
    
    const urlmatchResource = new fortios.webproxy.Urlmatch("urlmatchResource", {
        urlPattern: "string",
        cacheExemption: "string",
        comment: "string",
        fastFallback: "string",
        forwardServer: "string",
        name: "string",
        status: "string",
        vdomparam: "string",
    });
    
    type: fortios:webproxy:Urlmatch
    properties:
        cacheExemption: string
        comment: string
        fastFallback: string
        forwardServer: string
        name: string
        status: string
        urlPattern: string
        vdomparam: string
    

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

    UrlPattern string
    URL pattern to be exempted from web proxy forwarding and caching.
    CacheExemption string
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    Comment string
    Comment.
    FastFallback string
    Fast fallback configuration entry name.
    ForwardServer string
    Forward server name.
    Name string
    Configure a name for the URL to be exempted.
    Status string
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    UrlPattern string
    URL pattern to be exempted from web proxy forwarding and caching.
    CacheExemption string
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    Comment string
    Comment.
    FastFallback string
    Fast fallback configuration entry name.
    ForwardServer string
    Forward server name.
    Name string
    Configure a name for the URL to be exempted.
    Status string
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    urlPattern String
    URL pattern to be exempted from web proxy forwarding and caching.
    cacheExemption String
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment String
    Comment.
    fastFallback String
    Fast fallback configuration entry name.
    forwardServer String
    Forward server name.
    name String
    Configure a name for the URL to be exempted.
    status String
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    urlPattern string
    URL pattern to be exempted from web proxy forwarding and caching.
    cacheExemption string
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment string
    Comment.
    fastFallback string
    Fast fallback configuration entry name.
    forwardServer string
    Forward server name.
    name string
    Configure a name for the URL to be exempted.
    status string
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    url_pattern str
    URL pattern to be exempted from web proxy forwarding and caching.
    cache_exemption str
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment str
    Comment.
    fast_fallback str
    Fast fallback configuration entry name.
    forward_server str
    Forward server name.
    name str
    Configure a name for the URL to be exempted.
    status str
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    urlPattern String
    URL pattern to be exempted from web proxy forwarding and caching.
    cacheExemption String
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment String
    Comment.
    fastFallback String
    Fast fallback configuration entry name.
    forwardServer String
    Forward server name.
    name String
    Configure a name for the URL to be exempted.
    status String
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

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

    Get an existing Urlmatch 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?: UrlmatchState, opts?: CustomResourceOptions): Urlmatch
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cache_exemption: Optional[str] = None,
            comment: Optional[str] = None,
            fast_fallback: Optional[str] = None,
            forward_server: Optional[str] = None,
            name: Optional[str] = None,
            status: Optional[str] = None,
            url_pattern: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Urlmatch
    func GetUrlmatch(ctx *Context, name string, id IDInput, state *UrlmatchState, opts ...ResourceOption) (*Urlmatch, error)
    public static Urlmatch Get(string name, Input<string> id, UrlmatchState? state, CustomResourceOptions? opts = null)
    public static Urlmatch get(String name, Output<String> id, UrlmatchState 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:
    CacheExemption string
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    Comment string
    Comment.
    FastFallback string
    Fast fallback configuration entry name.
    ForwardServer string
    Forward server name.
    Name string
    Configure a name for the URL to be exempted.
    Status string
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    UrlPattern string
    URL pattern to be exempted from web proxy forwarding and caching.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    CacheExemption string
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    Comment string
    Comment.
    FastFallback string
    Fast fallback configuration entry name.
    ForwardServer string
    Forward server name.
    Name string
    Configure a name for the URL to be exempted.
    Status string
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    UrlPattern string
    URL pattern to be exempted from web proxy forwarding and caching.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    cacheExemption String
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment String
    Comment.
    fastFallback String
    Fast fallback configuration entry name.
    forwardServer String
    Forward server name.
    name String
    Configure a name for the URL to be exempted.
    status String
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    urlPattern String
    URL pattern to be exempted from web proxy forwarding and caching.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    cacheExemption string
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment string
    Comment.
    fastFallback string
    Fast fallback configuration entry name.
    forwardServer string
    Forward server name.
    name string
    Configure a name for the URL to be exempted.
    status string
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    urlPattern string
    URL pattern to be exempted from web proxy forwarding and caching.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    cache_exemption str
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment str
    Comment.
    fast_fallback str
    Fast fallback configuration entry name.
    forward_server str
    Forward server name.
    name str
    Configure a name for the URL to be exempted.
    status str
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    url_pattern str
    URL pattern to be exempted from web proxy forwarding and caching.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    cacheExemption String
    Enable/disable exempting this URL pattern from caching. Valid values: enable, disable.
    comment String
    Comment.
    fastFallback String
    Fast fallback configuration entry name.
    forwardServer String
    Forward server name.
    name String
    Configure a name for the URL to be exempted.
    status String
    Enable/disable exempting the URLs matching the URL pattern from web proxy forwarding and caching. Valid values: enable, disable.
    urlPattern String
    URL pattern to be exempted from web proxy forwarding and caching.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Import

    WebProxy UrlMatch can be imported using any of these accepted formats:

    $ pulumi import fortios:webproxy/urlmatch:Urlmatch labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:webproxy/urlmatch:Urlmatch labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

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

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse