@pulumiverse/fortios
Version:
A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0
300 lines (299 loc) • 10.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configure IPS rules.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fortios from "@pulumiverse/fortios";
*
* // import first and then modify
* const trname = new fortios.ips.Rule("trname", {
* action: "block",
* application: "All",
* date: 1462435200,
* group: "backdoor",
* location: "server",
* log: "enable",
* logPacket: "disable",
* os: "All",
* rev: 6637,
* ruleId: 40473,
* service: "UDP, DNS",
* severity: "critical",
* status: "enable",
* });
* ```
*
* ## Import
*
* Ips Rule can be imported using any of these accepted formats:
*
* ```sh
* $ pulumi import fortios:ips/rule:Rule labelname {{name}}
* ```
*
* If you do not want to import arguments of block:
*
* $ export "FORTIOS_IMPORT_TABLE"="false"
*
* ```sh
* $ pulumi import fortios:ips/rule:Rule labelname {{name}}
* ```
*
* $ unset "FORTIOS_IMPORT_TABLE"
*/
export declare class Rule extends pulumi.CustomResource {
/**
* Get an existing Rule 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?: RuleState, opts?: pulumi.CustomResourceOptions): Rule;
/**
* Returns true if the given object is an instance of Rule. 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 Rule;
/**
* Action. Valid values: `pass`, `block`.
*/
readonly action: pulumi.Output<string>;
/**
* Vulnerable applications.
*/
readonly application: pulumi.Output<string>;
/**
* Date.
*/
readonly date: pulumi.Output<number>;
/**
* 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>;
/**
* Group.
*/
readonly group: pulumi.Output<string>;
/**
* Vulnerable location.
*/
readonly location: pulumi.Output<string>;
/**
* Enable/disable logging. Valid values: `disable`, `enable`.
*/
readonly log: pulumi.Output<string>;
/**
* Enable/disable packet logging. Valid values: `disable`, `enable`.
*/
readonly logPacket: pulumi.Output<string>;
/**
* Meta data. The structure of `metadata` block is documented below.
*/
readonly metadatas: pulumi.Output<outputs.ips.RuleMetadata[] | undefined>;
/**
* Rule name.
*/
readonly name: pulumi.Output<string>;
/**
* Vulnerable operation systems.
*/
readonly os: pulumi.Output<string>;
/**
* Revision.
*/
readonly rev: pulumi.Output<number>;
/**
* Rule ID.
*/
readonly ruleId: pulumi.Output<number>;
/**
* Vulnerable service.
*/
readonly service: pulumi.Output<string>;
/**
* Severity.
*/
readonly severity: pulumi.Output<string>;
/**
* Enable/disable status. Valid values: `disable`, `enable`.
*/
readonly status: 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 Rule 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?: RuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Rule resources.
*/
export interface RuleState {
/**
* Action. Valid values: `pass`, `block`.
*/
action?: pulumi.Input<string>;
/**
* Vulnerable applications.
*/
application?: pulumi.Input<string>;
/**
* Date.
*/
date?: pulumi.Input<number>;
/**
* 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>;
/**
* Group.
*/
group?: pulumi.Input<string>;
/**
* Vulnerable location.
*/
location?: pulumi.Input<string>;
/**
* Enable/disable logging. Valid values: `disable`, `enable`.
*/
log?: pulumi.Input<string>;
/**
* Enable/disable packet logging. Valid values: `disable`, `enable`.
*/
logPacket?: pulumi.Input<string>;
/**
* Meta data. The structure of `metadata` block is documented below.
*/
metadatas?: pulumi.Input<pulumi.Input<inputs.ips.RuleMetadata>[]>;
/**
* Rule name.
*/
name?: pulumi.Input<string>;
/**
* Vulnerable operation systems.
*/
os?: pulumi.Input<string>;
/**
* Revision.
*/
rev?: pulumi.Input<number>;
/**
* Rule ID.
*/
ruleId?: pulumi.Input<number>;
/**
* Vulnerable service.
*/
service?: pulumi.Input<string>;
/**
* Severity.
*/
severity?: pulumi.Input<string>;
/**
* Enable/disable status. Valid values: `disable`, `enable`.
*/
status?: 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 Rule resource.
*/
export interface RuleArgs {
/**
* Action. Valid values: `pass`, `block`.
*/
action?: pulumi.Input<string>;
/**
* Vulnerable applications.
*/
application?: pulumi.Input<string>;
/**
* Date.
*/
date?: pulumi.Input<number>;
/**
* 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>;
/**
* Group.
*/
group?: pulumi.Input<string>;
/**
* Vulnerable location.
*/
location?: pulumi.Input<string>;
/**
* Enable/disable logging. Valid values: `disable`, `enable`.
*/
log?: pulumi.Input<string>;
/**
* Enable/disable packet logging. Valid values: `disable`, `enable`.
*/
logPacket?: pulumi.Input<string>;
/**
* Meta data. The structure of `metadata` block is documented below.
*/
metadatas?: pulumi.Input<pulumi.Input<inputs.ips.RuleMetadata>[]>;
/**
* Rule name.
*/
name?: pulumi.Input<string>;
/**
* Vulnerable operation systems.
*/
os?: pulumi.Input<string>;
/**
* Revision.
*/
rev?: pulumi.Input<number>;
/**
* Rule ID.
*/
ruleId?: pulumi.Input<number>;
/**
* Vulnerable service.
*/
service?: pulumi.Input<string>;
/**
* Severity.
*/
severity?: pulumi.Input<string>;
/**
* Enable/disable status. Valid values: `disable`, `enable`.
*/
status?: 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>;
}