@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
259 lines (258 loc) • 9.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Configure FortiGuard Web Filter service.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.filter.web.Fortiguard("trname", {
* cacheMemPercent: 2,
* cacheMode: "ttl",
* cachePrefixMatch: "enable",
* closePorts: "disable",
* ovrdAuthHttps: "enable",
* ovrdAuthPort: 8008,
* ovrdAuthPortHttp: 8008,
* ovrdAuthPortHttps: 8010,
* ovrdAuthPortHttpsFlow: 8015,
* ovrdAuthPortWarning: 8020,
* warnAuthHttps: "enable",
* });
* ```
*
* ## Import
*
* Webfilter Fortiguard can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:filter/web/fortiguard:Fortiguard labelname WebfilterFortiguard
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:filter/web/fortiguard:Fortiguard labelname WebfilterFortiguard
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Fortiguard extends pulumi.CustomResource {
/**
* Get an existing Fortiguard 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?: FortiguardState, opts?: pulumi.CustomResourceOptions): Fortiguard;
/**
* Returns true if the given object is an instance of Fortiguard. 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 Fortiguard;
/**
* Maximum percentage of available memory allocated to caching (1 - 15).
*/
readonly cacheMemPercent: pulumi.Output<number>;
/**
* Maximum permille of available memory allocated to caching (1 - 150).
*/
readonly cacheMemPermille: pulumi.Output<number>;
/**
* Cache entry expiration mode. Valid values: `ttl`, `db-ver`.
*/
readonly cacheMode: pulumi.Output<string>;
/**
* Enable/disable prefix matching in the cache. Valid values: `enable`, `disable`.
*/
readonly cachePrefixMatch: pulumi.Output<string>;
/**
* Close ports used for HTTP/HTTPS override authentication and disable user overrides. Valid values: `enable`, `disable`.
*/
readonly closePorts: pulumi.Output<string>;
/**
* Enable/disable embedding images into replacement messages (default = enable). Valid values: `enable`, `disable`.
*/
readonly embedImage: pulumi.Output<string>;
/**
* Enable/disable use of HTTPS for override authentication. Valid values: `enable`, `disable`.
*/
readonly ovrdAuthHttps: pulumi.Output<string>;
/**
* Port to use for FortiGuard Web Filter override authentication.
*/
readonly ovrdAuthPort: pulumi.Output<number>;
/**
* Port to use for FortiGuard Web Filter HTTP override authentication
*/
readonly ovrdAuthPortHttp: pulumi.Output<number>;
/**
* Port to use for FortiGuard Web Filter HTTPS override authentication in proxy mode.
*/
readonly ovrdAuthPortHttps: pulumi.Output<number>;
/**
* Port to use for FortiGuard Web Filter HTTPS override authentication in flow mode.
*/
readonly ovrdAuthPortHttpsFlow: pulumi.Output<number>;
/**
* Port to use for FortiGuard Web Filter Warning override authentication.
*/
readonly ovrdAuthPortWarning: pulumi.Output<number>;
/**
* Limit size of URL request packets sent to FortiGuard server (0 for default).
*/
readonly requestPacketSizeLimit: pulumi.Output<number>;
/**
* 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>;
/**
* Enable/disable use of HTTPS for warning and authentication. Valid values: `enable`, `disable`.
*/
readonly warnAuthHttps: pulumi.Output<string>;
/**
* Create a Fortiguard 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?: FortiguardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Fortiguard resources.
*/
export interface FortiguardState {
/**
* Maximum percentage of available memory allocated to caching (1 - 15).
*/
cacheMemPercent?: pulumi.Input<number>;
/**
* Maximum permille of available memory allocated to caching (1 - 150).
*/
cacheMemPermille?: pulumi.Input<number>;
/**
* Cache entry expiration mode. Valid values: `ttl`, `db-ver`.
*/
cacheMode?: pulumi.Input<string>;
/**
* Enable/disable prefix matching in the cache. Valid values: `enable`, `disable`.
*/
cachePrefixMatch?: pulumi.Input<string>;
/**
* Close ports used for HTTP/HTTPS override authentication and disable user overrides. Valid values: `enable`, `disable`.
*/
closePorts?: pulumi.Input<string>;
/**
* Enable/disable embedding images into replacement messages (default = enable). Valid values: `enable`, `disable`.
*/
embedImage?: pulumi.Input<string>;
/**
* Enable/disable use of HTTPS for override authentication. Valid values: `enable`, `disable`.
*/
ovrdAuthHttps?: pulumi.Input<string>;
/**
* Port to use for FortiGuard Web Filter override authentication.
*/
ovrdAuthPort?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter HTTP override authentication
*/
ovrdAuthPortHttp?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter HTTPS override authentication in proxy mode.
*/
ovrdAuthPortHttps?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter HTTPS override authentication in flow mode.
*/
ovrdAuthPortHttpsFlow?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter Warning override authentication.
*/
ovrdAuthPortWarning?: pulumi.Input<number>;
/**
* Limit size of URL request packets sent to FortiGuard server (0 for default).
*/
requestPacketSizeLimit?: pulumi.Input<number>;
/**
* 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>;
/**
* Enable/disable use of HTTPS for warning and authentication. Valid values: `enable`, `disable`.
*/
warnAuthHttps?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Fortiguard resource.
*/
export interface FortiguardArgs {
/**
* Maximum percentage of available memory allocated to caching (1 - 15).
*/
cacheMemPercent?: pulumi.Input<number>;
/**
* Maximum permille of available memory allocated to caching (1 - 150).
*/
cacheMemPermille?: pulumi.Input<number>;
/**
* Cache entry expiration mode. Valid values: `ttl`, `db-ver`.
*/
cacheMode?: pulumi.Input<string>;
/**
* Enable/disable prefix matching in the cache. Valid values: `enable`, `disable`.
*/
cachePrefixMatch?: pulumi.Input<string>;
/**
* Close ports used for HTTP/HTTPS override authentication and disable user overrides. Valid values: `enable`, `disable`.
*/
closePorts?: pulumi.Input<string>;
/**
* Enable/disable embedding images into replacement messages (default = enable). Valid values: `enable`, `disable`.
*/
embedImage?: pulumi.Input<string>;
/**
* Enable/disable use of HTTPS for override authentication. Valid values: `enable`, `disable`.
*/
ovrdAuthHttps?: pulumi.Input<string>;
/**
* Port to use for FortiGuard Web Filter override authentication.
*/
ovrdAuthPort?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter HTTP override authentication
*/
ovrdAuthPortHttp?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter HTTPS override authentication in proxy mode.
*/
ovrdAuthPortHttps?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter HTTPS override authentication in flow mode.
*/
ovrdAuthPortHttpsFlow?: pulumi.Input<number>;
/**
* Port to use for FortiGuard Web Filter Warning override authentication.
*/
ovrdAuthPortWarning?: pulumi.Input<number>;
/**
* Limit size of URL request packets sent to FortiGuard server (0 for default).
*/
requestPacketSizeLimit?: pulumi.Input<number>;
/**
* 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>;
/**
* Enable/disable use of HTTPS for warning and authentication. Valid values: `enable`, `disable`.
*/
warnAuthHttps?: pulumi.Input<string>;
}