UNPKG

@pulumiverse/fortios

Version:

A Pulumi package for creating and managing Fortios resources. Based on terraform-provider-fortios: version v1.16.0

311 lines (310 loc) 12.1 kB
import * as pulumi from "@pulumi/pulumi"; /** * Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as fortios from "@pulumiverse/fortios"; * * const trname = new fortios.dlp.Fpdocsource("trname", { * date: 1, * filePath: "/", * filePattern: "*", * keepModified: "enable", * period: "none", * removeDeleted: "enable", * scanOnCreation: "enable", * scanSubdirectories: "enable", * server: "1.1.1.1", * serverType: "samba", * todHour: 1, * todMin: 0, * username: "sgh", * vdom: "mgmt", * weekday: "sunday", * }); * ``` * * ## Import * * Dlp FpDocSource can be imported using any of these accepted formats: * * ```sh * $ pulumi import fortios:dlp/fpdocsource:Fpdocsource labelname {{name}} * ``` * * If you do not want to import arguments of block: * * $ export "FORTIOS_IMPORT_TABLE"="false" * * ```sh * $ pulumi import fortios:dlp/fpdocsource:Fpdocsource labelname {{name}} * ``` * * $ unset "FORTIOS_IMPORT_TABLE" */ export declare class Fpdocsource extends pulumi.CustomResource { /** * Get an existing Fpdocsource 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?: FpdocsourceState, opts?: pulumi.CustomResourceOptions): Fpdocsource; /** * Returns true if the given object is an instance of Fpdocsource. 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 Fpdocsource; /** * Day of the month on which to scan the server (1 - 31). */ readonly date: pulumi.Output<number>; /** * Path on the server to the fingerprint files (max 119 characters). */ readonly filePath: pulumi.Output<string>; /** * Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards. */ readonly filePattern: pulumi.Output<string>; /** * Enable so that when a file is changed on the server the FortiGate keeps the old fingerprint and adds a new fingerprint to the database. Valid values: `enable`, `disable`. */ readonly keepModified: pulumi.Output<string>; /** * Name of the DLP fingerprint database. */ readonly name: pulumi.Output<string>; /** * Password required to log into the file server. */ readonly password: pulumi.Output<string | undefined>; /** * Frequency for which the FortiGate checks the server for new or changed files. Valid values: `none`, `daily`, `weekly`, `monthly`. */ readonly period: pulumi.Output<string>; /** * Enable to keep the fingerprint database up to date when a file is deleted from the server. Valid values: `enable`, `disable`. */ readonly removeDeleted: pulumi.Output<string>; /** * Enable to keep the fingerprint database up to date when a file is added or changed on the server. Valid values: `enable`, `disable`. */ readonly scanOnCreation: pulumi.Output<string>; /** * Enable/disable scanning subdirectories to find files to create fingerprints from. Valid values: `enable`, `disable`. */ readonly scanSubdirectories: pulumi.Output<string>; /** * Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using fp-sensitivity. */ readonly sensitivity: pulumi.Output<string>; /** * IPv4 or IPv6 address of the server. */ readonly server: pulumi.Output<string>; /** * Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. Valid values: `samba`. */ readonly serverType: pulumi.Output<string>; /** * Hour of the day on which to scan the server (0 - 23, default = 1). */ readonly todHour: pulumi.Output<number>; /** * Minute of the hour on which to scan the server (0 - 59). */ readonly todMin: pulumi.Output<number>; /** * User name required to log into the file server. */ readonly username: pulumi.Output<string>; /** * Select the VDOM that can communicate with the file server. Valid values: `mgmt`, `current`. */ readonly vdom: 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>; /** * Day of the week on which to scan the server. Valid values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. */ readonly weekday: pulumi.Output<string>; /** * Create a Fpdocsource 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: FpdocsourceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Fpdocsource resources. */ export interface FpdocsourceState { /** * Day of the month on which to scan the server (1 - 31). */ date?: pulumi.Input<number>; /** * Path on the server to the fingerprint files (max 119 characters). */ filePath?: pulumi.Input<string>; /** * Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards. */ filePattern?: pulumi.Input<string>; /** * Enable so that when a file is changed on the server the FortiGate keeps the old fingerprint and adds a new fingerprint to the database. Valid values: `enable`, `disable`. */ keepModified?: pulumi.Input<string>; /** * Name of the DLP fingerprint database. */ name?: pulumi.Input<string>; /** * Password required to log into the file server. */ password?: pulumi.Input<string>; /** * Frequency for which the FortiGate checks the server for new or changed files. Valid values: `none`, `daily`, `weekly`, `monthly`. */ period?: pulumi.Input<string>; /** * Enable to keep the fingerprint database up to date when a file is deleted from the server. Valid values: `enable`, `disable`. */ removeDeleted?: pulumi.Input<string>; /** * Enable to keep the fingerprint database up to date when a file is added or changed on the server. Valid values: `enable`, `disable`. */ scanOnCreation?: pulumi.Input<string>; /** * Enable/disable scanning subdirectories to find files to create fingerprints from. Valid values: `enable`, `disable`. */ scanSubdirectories?: pulumi.Input<string>; /** * Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using fp-sensitivity. */ sensitivity?: pulumi.Input<string>; /** * IPv4 or IPv6 address of the server. */ server?: pulumi.Input<string>; /** * Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. Valid values: `samba`. */ serverType?: pulumi.Input<string>; /** * Hour of the day on which to scan the server (0 - 23, default = 1). */ todHour?: pulumi.Input<number>; /** * Minute of the hour on which to scan the server (0 - 59). */ todMin?: pulumi.Input<number>; /** * User name required to log into the file server. */ username?: pulumi.Input<string>; /** * Select the VDOM that can communicate with the file server. Valid values: `mgmt`, `current`. */ vdom?: 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>; /** * Day of the week on which to scan the server. Valid values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. */ weekday?: pulumi.Input<string>; } /** * The set of arguments for constructing a Fpdocsource resource. */ export interface FpdocsourceArgs { /** * Day of the month on which to scan the server (1 - 31). */ date?: pulumi.Input<number>; /** * Path on the server to the fingerprint files (max 119 characters). */ filePath?: pulumi.Input<string>; /** * Files matching this pattern on the server are fingerprinted. Optionally use the * and ? wildcards. */ filePattern?: pulumi.Input<string>; /** * Enable so that when a file is changed on the server the FortiGate keeps the old fingerprint and adds a new fingerprint to the database. Valid values: `enable`, `disable`. */ keepModified?: pulumi.Input<string>; /** * Name of the DLP fingerprint database. */ name?: pulumi.Input<string>; /** * Password required to log into the file server. */ password?: pulumi.Input<string>; /** * Frequency for which the FortiGate checks the server for new or changed files. Valid values: `none`, `daily`, `weekly`, `monthly`. */ period?: pulumi.Input<string>; /** * Enable to keep the fingerprint database up to date when a file is deleted from the server. Valid values: `enable`, `disable`. */ removeDeleted?: pulumi.Input<string>; /** * Enable to keep the fingerprint database up to date when a file is added or changed on the server. Valid values: `enable`, `disable`. */ scanOnCreation?: pulumi.Input<string>; /** * Enable/disable scanning subdirectories to find files to create fingerprints from. Valid values: `enable`, `disable`. */ scanSubdirectories?: pulumi.Input<string>; /** * Select a sensitivity or threat level for matches with this fingerprint database. Add sensitivities using fp-sensitivity. */ sensitivity?: pulumi.Input<string>; /** * IPv4 or IPv6 address of the server. */ server: pulumi.Input<string>; /** * Protocol used to communicate with the file server. Currently only Samba (SMB) servers are supported. Valid values: `samba`. */ serverType: pulumi.Input<string>; /** * Hour of the day on which to scan the server (0 - 23, default = 1). */ todHour?: pulumi.Input<number>; /** * Minute of the hour on which to scan the server (0 - 59). */ todMin?: pulumi.Input<number>; /** * User name required to log into the file server. */ username: pulumi.Input<string>; /** * Select the VDOM that can communicate with the file server. Valid values: `mgmt`, `current`. */ vdom?: 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>; /** * Day of the week on which to scan the server. Valid values: `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`. */ weekday?: pulumi.Input<string>; }