Docs Packages
  1. Packages
  2. Fortios
  3. API Docs
  4. filter
  5. filter/web
  6. Searchengine
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.filter/web.Searchengine

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

    Configure web filter search engines.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.filter.web.Searchengine("trname", {
    charset: "utf-8",
    hostname: "sg.eiwuc.com",
    query: "sc=",
    safesearch: "disable",
    url: "^\\/f",
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.filter.web.Searchengine("trname",
    charset="utf-8",
    hostname="sg.eiwuc.com",
    query="sc=",
    safesearch="disable",
    url="^\\/f")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/filter"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filter.NewSearchengine(ctx, "trname", &filter.SearchengineArgs{
			Charset:    pulumi.String("utf-8"),
			Hostname:   pulumi.String("sg.eiwuc.com"),
			Query:      pulumi.String("sc="),
			Safesearch: pulumi.String("disable"),
			Url:        pulumi.String("^\\/f"),
		})
		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 trname = new Fortios.Filter.Web.Searchengine("trname", new()
    {
        Charset = "utf-8",
        Hostname = "sg.eiwuc.com",
        Query = "sc=",
        Safesearch = "disable",
        Url = "^\\/f",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.filter.Searchengine;
import com.pulumi.fortios.filter.SearchengineArgs;
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 trname = new Searchengine("trname", SearchengineArgs.builder()        
            .charset("utf-8")
            .hostname("sg.eiwuc.com")
            .query("sc=")
            .safesearch("disable")
            .url("^\\/f")
            .build());

    }
}

    resources:
  trname:
    type: fortios:filter/web:Searchengine
    properties:
      charset: utf-8
      hostname: sg.eiwuc.com
      query: sc=
      safesearch: disable
      url: ^\/f

    Create Searchengine Resource

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

    Constructor syntax

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

@overload
def Searchengine(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 charset: Optional[str] = None,
                 hostname: Optional[str] = None,
                 name: Optional[str] = None,
                 query: Optional[str] = None,
                 safesearch: Optional[str] = None,
                 safesearch_str: Optional[str] = None,
                 url: Optional[str] = None,
                 vdomparam: Optional[str] = None)
    func NewSearchengine(ctx *Context, name string, args *SearchengineArgs, opts ...ResourceOption) (*Searchengine, error)
    public Searchengine(string name, SearchengineArgs? args = null, CustomResourceOptions? opts = null)
    public Searchengine(String name, SearchengineArgs args)
public Searchengine(String name, SearchengineArgs args, CustomResourceOptions options)

    type: fortios:filter/web/searchengine:Searchengine
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 SearchengineArgs
    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 SearchengineArgs
    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 SearchengineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SearchengineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SearchengineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Charset string
    Search engine charset. Valid values: utf-8, gb2312.
    Hostname string
    Hostname (regular expression).
    Name string
    Search engine name.
    Query string
    Code used to prefix a query (must end with an equals character).
    Safesearch string
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    SafesearchStr string
    Safe search parameter used in the URL.
    Url string
    URL (regular expression).
    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.
    Charset string
    Search engine charset. Valid values: utf-8, gb2312.
    Hostname string
    Hostname (regular expression).
    Name string
    Search engine name.
    Query string
    Code used to prefix a query (must end with an equals character).
    Safesearch string
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    SafesearchStr string
    Safe search parameter used in the URL.
    Url string
    URL (regular expression).
    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.
    charset String
    Search engine charset. Valid values: utf-8, gb2312.
    hostname String
    Hostname (regular expression).
    name String
    Search engine name.
    query String
    Code used to prefix a query (must end with an equals character).
    safesearch String
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearchStr String
    Safe search parameter used in the URL.
    url String
    URL (regular expression).
    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.
    charset string
    Search engine charset. Valid values: utf-8, gb2312.
    hostname string
    Hostname (regular expression).
    name string
    Search engine name.
    query string
    Code used to prefix a query (must end with an equals character).
    safesearch string
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearchStr string
    Safe search parameter used in the URL.
    url string
    URL (regular expression).
    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.
    charset str
    Search engine charset. Valid values: utf-8, gb2312.
    hostname str
    Hostname (regular expression).
    name str
    Search engine name.
    query str
    Code used to prefix a query (must end with an equals character).
    safesearch str
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearch_str str
    Safe search parameter used in the URL.
    url str
    URL (regular expression).
    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.
    charset String
    Search engine charset. Valid values: utf-8, gb2312.
    hostname String
    Hostname (regular expression).
    name String
    Search engine name.
    query String
    Code used to prefix a query (must end with an equals character).
    safesearch String
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearchStr String
    Safe search parameter used in the URL.
    url String
    URL (regular expression).
    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 Searchengine 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 Searchengine Resource

    Get an existing Searchengine 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?: SearchengineState, opts?: CustomResourceOptions): Searchengine
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        charset: Optional[str] = None,
        hostname: Optional[str] = None,
        name: Optional[str] = None,
        query: Optional[str] = None,
        safesearch: Optional[str] = None,
        safesearch_str: Optional[str] = None,
        url: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Searchengine
    func GetSearchengine(ctx *Context, name string, id IDInput, state *SearchengineState, opts ...ResourceOption) (*Searchengine, error)
    public static Searchengine Get(string name, Input<string> id, SearchengineState? state, CustomResourceOptions? opts = null)
    public static Searchengine get(String name, Output<String> id, SearchengineState 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:
    Charset string
    Search engine charset. Valid values: utf-8, gb2312.
    Hostname string
    Hostname (regular expression).
    Name string
    Search engine name.
    Query string
    Code used to prefix a query (must end with an equals character).
    Safesearch string
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    SafesearchStr string
    Safe search parameter used in the URL.
    Url string
    URL (regular expression).
    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.
    Charset string
    Search engine charset. Valid values: utf-8, gb2312.
    Hostname string
    Hostname (regular expression).
    Name string
    Search engine name.
    Query string
    Code used to prefix a query (must end with an equals character).
    Safesearch string
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    SafesearchStr string
    Safe search parameter used in the URL.
    Url string
    URL (regular expression).
    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.
    charset String
    Search engine charset. Valid values: utf-8, gb2312.
    hostname String
    Hostname (regular expression).
    name String
    Search engine name.
    query String
    Code used to prefix a query (must end with an equals character).
    safesearch String
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearchStr String
    Safe search parameter used in the URL.
    url String
    URL (regular expression).
    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.
    charset string
    Search engine charset. Valid values: utf-8, gb2312.
    hostname string
    Hostname (regular expression).
    name string
    Search engine name.
    query string
    Code used to prefix a query (must end with an equals character).
    safesearch string
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearchStr string
    Safe search parameter used in the URL.
    url string
    URL (regular expression).
    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.
    charset str
    Search engine charset. Valid values: utf-8, gb2312.
    hostname str
    Hostname (regular expression).
    name str
    Search engine name.
    query str
    Code used to prefix a query (must end with an equals character).
    safesearch str
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearch_str str
    Safe search parameter used in the URL.
    url str
    URL (regular expression).
    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.
    charset String
    Search engine charset. Valid values: utf-8, gb2312.
    hostname String
    Hostname (regular expression).
    name String
    Search engine name.
    query String
    Code used to prefix a query (must end with an equals character).
    safesearch String
    Safe search method. You can disable safe search, add the safe search string to URLs, or insert a safe search header.
    safesearchStr String
    Safe search parameter used in the URL.
    url String
    URL (regular expression).
    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

    Webfilter SearchEngine can be imported using any of these accepted formats:

    $ pulumi import fortios:filter/web/searchengine:Searchengine labelname {{name}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:filter/web/searchengine:Searchengine 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.5 published on Tuesday, Apr 9, 2024 by pulumiverse
    pulumiverse/pulumi-fortios