@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
193 lines (192 loc) • 8.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* Configure URL filter lists.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.filter.web.Urlfilter("trname", {
* fosid: 1,
* ipAddrBlock: "enable",
* oneArmIpsUrlfilter: "enable",
* });
* ```
*
* ## Import
*
* Webfilter Urlfilter can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:filter/web/urlfilter:Urlfilter labelname {{fosid}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:filter/web/urlfilter:Urlfilter labelname {{fosid}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Urlfilter extends pulumi.CustomResource {
/**
* Get an existing Urlfilter resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UrlfilterState, opts?: pulumi.CustomResourceOptions): Urlfilter;
/**
* Returns true if the given object is an instance of Urlfilter. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Urlfilter;
/**
* Optional comments.
*/
readonly comment: pulumi.Output<string | undefined>;
/**
* 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 ].
*/
readonly dynamicSortSubtable: pulumi.Output<string | undefined>;
/**
* URL filter entries. The structure of `entries` block is documented below.
*/
readonly entries: pulumi.Output<outputs.filter.web.UrlfilterEntry[] | undefined>;
/**
* ID.
*/
readonly fosid: pulumi.Output<number>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
readonly getAllTables: pulumi.Output<string | undefined>;
/**
* Enable/disable matching of IPv4 mapped IPv6 URLs. Valid values: `enable`, `disable`.
*/
readonly ip4MappedIp6: pulumi.Output<string>;
/**
* Enable/disable blocking URLs when the hostname appears as an IP address. Valid values: `enable`, `disable`.
*/
readonly ipAddrBlock: pulumi.Output<string>;
/**
* Name of URL filter list.
*/
readonly name: pulumi.Output<string>;
/**
* Enable/disable DNS resolver for one-arm IPS URL filter operation. Valid values: `enable`, `disable`.
*/
readonly oneArmIpsUrlfilter: pulumi.Output<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.
*/
readonly vdomparam: pulumi.Output<string>;
/**
* Create a Urlfilter resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: UrlfilterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Urlfilter resources.
*/
export interface UrlfilterState {
/**
* Optional comments.
*/
comment?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* URL filter entries. The structure of `entries` block is documented below.
*/
entries?: pulumi.Input<pulumi.Input<inputs.filter.web.UrlfilterEntry>[]>;
/**
* ID.
*/
fosid?: pulumi.Input<number>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* Enable/disable matching of IPv4 mapped IPv6 URLs. Valid values: `enable`, `disable`.
*/
ip4MappedIp6?: pulumi.Input<string>;
/**
* Enable/disable blocking URLs when the hostname appears as an IP address. Valid values: `enable`, `disable`.
*/
ipAddrBlock?: pulumi.Input<string>;
/**
* Name of URL filter list.
*/
name?: pulumi.Input<string>;
/**
* Enable/disable DNS resolver for one-arm IPS URL filter operation. Valid values: `enable`, `disable`.
*/
oneArmIpsUrlfilter?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Urlfilter resource.
*/
export interface UrlfilterArgs {
/**
* Optional comments.
*/
comment?: pulumi.Input<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 ].
*/
dynamicSortSubtable?: pulumi.Input<string>;
/**
* URL filter entries. The structure of `entries` block is documented below.
*/
entries?: pulumi.Input<pulumi.Input<inputs.filter.web.UrlfilterEntry>[]>;
/**
* ID.
*/
fosid: pulumi.Input<number>;
/**
* Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
*/
getAllTables?: pulumi.Input<string>;
/**
* Enable/disable matching of IPv4 mapped IPv6 URLs. Valid values: `enable`, `disable`.
*/
ip4MappedIp6?: pulumi.Input<string>;
/**
* Enable/disable blocking URLs when the hostname appears as an IP address. Valid values: `enable`, `disable`.
*/
ipAddrBlock?: pulumi.Input<string>;
/**
* Name of URL filter list.
*/
name?: pulumi.Input<string>;
/**
* Enable/disable DNS resolver for one-arm IPS URL filter operation. Valid values: `enable`, `disable`.
*/
oneArmIpsUrlfilter?: pulumi.Input<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.
*/
vdomparam?: pulumi.Input<string>;
}