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

fortios.filter/dns.Domainfilter

Explore with Pulumi AI

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

    Configure DNS domain filters.

    Example Usage

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

const trname = new fortios.filter.dns.Domainfilter("trname", {
    entries: [{
        action: "block",
        domain: "bac.com",
        id: 1,
        status: "enable",
        type: "simple",
    }],
    fosid: 1,
});

    import pulumi
import pulumiverse_fortios as fortios

trname = fortios.filter.dns.Domainfilter("trname",
    entries=[fortios.filter.dns.DomainfilterEntryArgs(
        action="block",
        domain="bac.com",
        id=1,
        status="enable",
        type="simple",
    )],
    fosid=1)

    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.NewDomainfilter(ctx, "trname", &filter.DomainfilterArgs{
			Entries: dns.DomainfilterEntryArray{
				&dns.DomainfilterEntryArgs{
					Action: pulumi.String("block"),
					Domain: pulumi.String("bac.com"),
					Id:     pulumi.Int(1),
					Status: pulumi.String("enable"),
					Type:   pulumi.String("simple"),
				},
			},
			Fosid: pulumi.Int(1),
		})
		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.Dns.Domainfilter("trname", new()
    {
        Entries = new[]
        {
            new Fortios.Filter.Dns.Inputs.DomainfilterEntryArgs
            {
                Action = "block",
                Domain = "bac.com",
                Id = 1,
                Status = "enable",
                Type = "simple",
            },
        },
        Fosid = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.filter.Domainfilter;
import com.pulumi.fortios.filter.DomainfilterArgs;
import com.pulumi.fortios.filter.inputs.DomainfilterEntryArgs;
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 Domainfilter("trname", DomainfilterArgs.builder()        
            .entries(DomainfilterEntryArgs.builder()
                .action("block")
                .domain("bac.com")
                .id(1)
                .status("enable")
                .type("simple")
                .build())
            .fosid(1)
            .build());

    }
}

    resources:
  trname:
    type: fortios:filter/dns:Domainfilter
    properties:
      entries:
        - action: block
          domain: bac.com
          id: 1
          status: enable
          type: simple
      fosid: 1

    Create Domainfilter Resource

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

    Constructor syntax

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

@overload
def Domainfilter(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 fosid: Optional[int] = None,
                 comment: Optional[str] = None,
                 dynamic_sort_subtable: Optional[str] = None,
                 entries: Optional[Sequence[DomainfilterEntryArgs]] = None,
                 get_all_tables: Optional[str] = None,
                 name: Optional[str] = None,
                 vdomparam: Optional[str] = None)
    func NewDomainfilter(ctx *Context, name string, args DomainfilterArgs, opts ...ResourceOption) (*Domainfilter, error)
    public Domainfilter(string name, DomainfilterArgs args, CustomResourceOptions? opts = null)
    public Domainfilter(String name, DomainfilterArgs args)
public Domainfilter(String name, DomainfilterArgs args, CustomResourceOptions options)

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

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

    Fosid int
    ID.
    Comment string
    Optional comments.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Entries List<Pulumiverse.Fortios.Filter.Dns.Inputs.DomainfilterEntry>
    DNS domain filter entries. The structure of entries block is documented below.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table.
    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.
    Fosid int
    ID.
    Comment string
    Optional comments.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Entries []DomainfilterEntryArgs
    DNS domain filter entries. The structure of entries block is documented below.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table.
    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.
    fosid Integer
    ID.
    comment String
    Optional comments.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries List<DomainfilterEntry>
    DNS domain filter entries. The structure of entries block is documented below.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table.
    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.
    fosid number
    ID.
    comment string
    Optional comments.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries DomainfilterEntry[]
    DNS domain filter entries. The structure of entries block is documented below.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Name of table.
    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.
    fosid int
    ID.
    comment str
    Optional comments.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries Sequence[DomainfilterEntryArgs]
    DNS domain filter entries. The structure of entries block is documented below.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Name of table.
    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.
    fosid Number
    ID.
    comment String
    Optional comments.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries List<Property Map>
    DNS domain filter entries. The structure of entries block is documented below.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table.
    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 Domainfilter 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 Domainfilter Resource

    Get an existing Domainfilter 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?: DomainfilterState, opts?: CustomResourceOptions): Domainfilter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        entries: Optional[Sequence[DomainfilterEntryArgs]] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        name: Optional[str] = None,
        vdomparam: Optional[str] = None) -> Domainfilter
    func GetDomainfilter(ctx *Context, name string, id IDInput, state *DomainfilterState, opts ...ResourceOption) (*Domainfilter, error)
    public static Domainfilter Get(string name, Input<string> id, DomainfilterState? state, CustomResourceOptions? opts = null)
    public static Domainfilter get(String name, Output<String> id, DomainfilterState 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:
    Comment string
    Optional comments.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Entries List<Pulumiverse.Fortios.Filter.Dns.Inputs.DomainfilterEntry>
    DNS domain filter entries. The structure of entries block is documented below.
    Fosid int
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table.
    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.
    Comment string
    Optional comments.
    DynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    Entries []DomainfilterEntryArgs
    DNS domain filter entries. The structure of entries block is documented below.
    Fosid int
    ID.
    GetAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    Name string
    Name of table.
    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.
    comment String
    Optional comments.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries List<DomainfilterEntry>
    DNS domain filter entries. The structure of entries block is documented below.
    fosid Integer
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table.
    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.
    comment string
    Optional comments.
    dynamicSortSubtable string
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries DomainfilterEntry[]
    DNS domain filter entries. The structure of entries block is documented below.
    fosid number
    ID.
    getAllTables string
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name string
    Name of table.
    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.
    comment str
    Optional comments.
    dynamic_sort_subtable str
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries Sequence[DomainfilterEntryArgs]
    DNS domain filter entries. The structure of entries block is documented below.
    fosid int
    ID.
    get_all_tables str
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name str
    Name of table.
    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.
    comment String
    Optional comments.
    dynamicSortSubtable String
    Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
    entries List<Property Map>
    DNS domain filter entries. The structure of entries block is documented below.
    fosid Number
    ID.
    getAllTables String
    Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwish conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
    name String
    Name of table.
    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.

    Supporting Types

    DomainfilterEntry, DomainfilterEntryArgs

    Action string
    Action to take for domain filter matches. Valid values: block, allow, monitor.
    Domain string
    Domain entries to be filtered.
    Id int
    Id.
    Status string
    Enable/disable this domain filter. Valid values: enable, disable.
    Type string
    DNS domain filter type. Valid values: simple, regex, wildcard.
    Action string
    Action to take for domain filter matches. Valid values: block, allow, monitor.
    Domain string
    Domain entries to be filtered.
    Id int
    Id.
    Status string
    Enable/disable this domain filter. Valid values: enable, disable.
    Type string
    DNS domain filter type. Valid values: simple, regex, wildcard.
    action String
    Action to take for domain filter matches. Valid values: block, allow, monitor.
    domain String
    Domain entries to be filtered.
    id Integer
    Id.
    status String
    Enable/disable this domain filter. Valid values: enable, disable.
    type String
    DNS domain filter type. Valid values: simple, regex, wildcard.
    action string
    Action to take for domain filter matches. Valid values: block, allow, monitor.
    domain string
    Domain entries to be filtered.
    id number
    Id.
    status string
    Enable/disable this domain filter. Valid values: enable, disable.
    type string
    DNS domain filter type. Valid values: simple, regex, wildcard.
    action str
    Action to take for domain filter matches. Valid values: block, allow, monitor.
    domain str
    Domain entries to be filtered.
    id int
    Id.
    status str
    Enable/disable this domain filter. Valid values: enable, disable.
    type str
    DNS domain filter type. Valid values: simple, regex, wildcard.
    action String
    Action to take for domain filter matches. Valid values: block, allow, monitor.
    domain String
    Domain entries to be filtered.
    id Number
    Id.
    status String
    Enable/disable this domain filter. Valid values: enable, disable.
    type String
    DNS domain filter type. Valid values: simple, regex, wildcard.

    Import

    Dnsfilter DomainFilter can be imported using any of these accepted formats:

    $ pulumi import fortios:filter/dns/domainfilter:Domainfilter labelname {{fosid}}

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:filter/dns/domainfilter:Domainfilter labelname {{fosid}}

    $ 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