@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
375 lines (374 loc) • 15.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Web proxy address configuration.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* const trname = new fortios.firewall.Proxyaddress("trname", {
* caseSensitivity: "disable",
* color: 2,
* referrer: "enable",
* type: "host-regex",
* visibility: "enable",
* });
* ```
*
* ## Import
*
* Firewall ProxyAddress can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:firewall/proxyaddress:Proxyaddress labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:firewall/proxyaddress:Proxyaddress labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Proxyaddress extends pulumi.CustomResource {
/**
* Get an existing Proxyaddress 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?: ProxyaddressState, opts?: pulumi.CustomResourceOptions): Proxyaddress;
/**
* Returns true if the given object is an instance of Proxyaddress. 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 Proxyaddress;
/**
* SaaS application. The structure of `application` block is documented below.
*/
readonly applications: pulumi.Output<outputs.firewall.ProxyaddressApplication[] | undefined>;
/**
* Enable to make the pattern case sensitive. Valid values: `disable`, `enable`.
*/
readonly caseSensitivity: pulumi.Output<string>;
/**
* FortiGuard category ID. The structure of `category` block is documented below.
*/
readonly categories: pulumi.Output<outputs.firewall.ProxyaddressCategory[] | undefined>;
/**
* Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1).
*/
readonly color: pulumi.Output<number>;
/**
* 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>;
/**
* 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>;
/**
* HTTP header name as a regular expression.
*/
readonly header: pulumi.Output<string>;
/**
* HTTP header group. The structure of `headerGroup` block is documented below.
*/
readonly headerGroups: pulumi.Output<outputs.firewall.ProxyaddressHeaderGroup[] | undefined>;
/**
* Name of HTTP header.
*/
readonly headerName: pulumi.Output<string>;
/**
* Address object for the host.
*/
readonly host: pulumi.Output<string>;
/**
* Host name as a regular expression.
*/
readonly hostRegex: pulumi.Output<string>;
/**
* HTTP request methods to be used. Valid values: `get`, `post`, `put`, `head`, `connect`, `trace`, `options`, `delete`.
*/
readonly method: pulumi.Output<string>;
/**
* Address name.
*/
readonly name: pulumi.Output<string>;
/**
* URL path as a regular expression.
*/
readonly path: pulumi.Output<string>;
/**
* Match the query part of the URL as a regular expression.
*/
readonly query: pulumi.Output<string>;
/**
* Enable/disable use of referrer field in the HTTP header to match the address. Valid values: `enable`, `disable`.
*/
readonly referrer: pulumi.Output<string>;
/**
* Config object tagging. The structure of `tagging` block is documented below.
*/
readonly taggings: pulumi.Output<outputs.firewall.ProxyaddressTagging[] | undefined>;
/**
* Proxy address type.
*/
readonly type: pulumi.Output<string>;
/**
* Names of browsers to be used as user agent.
*/
readonly ua: pulumi.Output<string>;
/**
* Maximum version of the user agent specified in dotted notation. For example, use 120 with the ua field set to "chrome" to require Google Chrome's maximum version must be 120.
*/
readonly uaMaxVer: pulumi.Output<string>;
/**
* Minimum version of the user agent specified in dotted notation. For example, use 90.0.1 with the ua field set to "chrome" to require Google Chrome's minimum version must be 90.0.1.
*/
readonly uaMinVer: pulumi.Output<string>;
/**
* Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
*/
readonly uuid: 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>;
/**
* Enable/disable visibility of the object in the GUI. Valid values: `enable`, `disable`.
*/
readonly visibility: pulumi.Output<string>;
/**
* Create a Proxyaddress 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?: ProxyaddressArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Proxyaddress resources.
*/
export interface ProxyaddressState {
/**
* SaaS application. The structure of `application` block is documented below.
*/
applications?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressApplication>[]>;
/**
* Enable to make the pattern case sensitive. Valid values: `disable`, `enable`.
*/
caseSensitivity?: pulumi.Input<string>;
/**
* FortiGuard category ID. The structure of `category` block is documented below.
*/
categories?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressCategory>[]>;
/**
* Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1).
*/
color?: pulumi.Input<number>;
/**
* 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>;
/**
* 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>;
/**
* HTTP header name as a regular expression.
*/
header?: pulumi.Input<string>;
/**
* HTTP header group. The structure of `headerGroup` block is documented below.
*/
headerGroups?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressHeaderGroup>[]>;
/**
* Name of HTTP header.
*/
headerName?: pulumi.Input<string>;
/**
* Address object for the host.
*/
host?: pulumi.Input<string>;
/**
* Host name as a regular expression.
*/
hostRegex?: pulumi.Input<string>;
/**
* HTTP request methods to be used. Valid values: `get`, `post`, `put`, `head`, `connect`, `trace`, `options`, `delete`.
*/
method?: pulumi.Input<string>;
/**
* Address name.
*/
name?: pulumi.Input<string>;
/**
* URL path as a regular expression.
*/
path?: pulumi.Input<string>;
/**
* Match the query part of the URL as a regular expression.
*/
query?: pulumi.Input<string>;
/**
* Enable/disable use of referrer field in the HTTP header to match the address. Valid values: `enable`, `disable`.
*/
referrer?: pulumi.Input<string>;
/**
* Config object tagging. The structure of `tagging` block is documented below.
*/
taggings?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressTagging>[]>;
/**
* Proxy address type.
*/
type?: pulumi.Input<string>;
/**
* Names of browsers to be used as user agent.
*/
ua?: pulumi.Input<string>;
/**
* Maximum version of the user agent specified in dotted notation. For example, use 120 with the ua field set to "chrome" to require Google Chrome's maximum version must be 120.
*/
uaMaxVer?: pulumi.Input<string>;
/**
* Minimum version of the user agent specified in dotted notation. For example, use 90.0.1 with the ua field set to "chrome" to require Google Chrome's minimum version must be 90.0.1.
*/
uaMinVer?: pulumi.Input<string>;
/**
* Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
*/
uuid?: 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>;
/**
* Enable/disable visibility of the object in the GUI. Valid values: `enable`, `disable`.
*/
visibility?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Proxyaddress resource.
*/
export interface ProxyaddressArgs {
/**
* SaaS application. The structure of `application` block is documented below.
*/
applications?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressApplication>[]>;
/**
* Enable to make the pattern case sensitive. Valid values: `disable`, `enable`.
*/
caseSensitivity?: pulumi.Input<string>;
/**
* FortiGuard category ID. The structure of `category` block is documented below.
*/
categories?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressCategory>[]>;
/**
* Integer value to determine the color of the icon in the GUI (1 - 32, default = 0, which sets value to 1).
*/
color?: pulumi.Input<number>;
/**
* 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>;
/**
* 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>;
/**
* HTTP header name as a regular expression.
*/
header?: pulumi.Input<string>;
/**
* HTTP header group. The structure of `headerGroup` block is documented below.
*/
headerGroups?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressHeaderGroup>[]>;
/**
* Name of HTTP header.
*/
headerName?: pulumi.Input<string>;
/**
* Address object for the host.
*/
host?: pulumi.Input<string>;
/**
* Host name as a regular expression.
*/
hostRegex?: pulumi.Input<string>;
/**
* HTTP request methods to be used. Valid values: `get`, `post`, `put`, `head`, `connect`, `trace`, `options`, `delete`.
*/
method?: pulumi.Input<string>;
/**
* Address name.
*/
name?: pulumi.Input<string>;
/**
* URL path as a regular expression.
*/
path?: pulumi.Input<string>;
/**
* Match the query part of the URL as a regular expression.
*/
query?: pulumi.Input<string>;
/**
* Enable/disable use of referrer field in the HTTP header to match the address. Valid values: `enable`, `disable`.
*/
referrer?: pulumi.Input<string>;
/**
* Config object tagging. The structure of `tagging` block is documented below.
*/
taggings?: pulumi.Input<pulumi.Input<inputs.firewall.ProxyaddressTagging>[]>;
/**
* Proxy address type.
*/
type?: pulumi.Input<string>;
/**
* Names of browsers to be used as user agent.
*/
ua?: pulumi.Input<string>;
/**
* Maximum version of the user agent specified in dotted notation. For example, use 120 with the ua field set to "chrome" to require Google Chrome's maximum version must be 120.
*/
uaMaxVer?: pulumi.Input<string>;
/**
* Minimum version of the user agent specified in dotted notation. For example, use 90.0.1 with the ua field set to "chrome" to require Google Chrome's minimum version must be 90.0.1.
*/
uaMinVer?: pulumi.Input<string>;
/**
* Universally Unique Identifier (UUID; automatically assigned but can be manually reset).
*/
uuid?: 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>;
/**
* Enable/disable visibility of the object in the GUI. Valid values: `enable`, `disable`.
*/
visibility?: pulumi.Input<string>;
}