@bdzscaler/pulumi-zia/dlpdictionaries.d.ts

A Pulumi package for creating and managing zia cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * * [Official documentation](https://help.zscaler.com/zia/adding-custom-dlp-dictionary)
 * * [API documentation](https://help.zscaler.com/zia/data-loss-prevention#/dlpDictionaries-post)
 *
 * The **zia_dlp_dictionaries** resource allows the creation and management of ZIA DLP dictionaries in the Zscaler Internet Access cloud or via the API.
 *
 * ## Example Usage
 *
 * ### With Hierarchical Identifiers
 *
 * ## Import
 *
 * Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.
 *
 * Visit
 *
 * **zia_dlp_dictionaries** can be imported by using `<DICTIONARY ID>` or `<DICTIONARY_NAME>` as the import ID.
 *
 * For example:
 *
 * ```sh
 * $ pulumi import zia:index/dLPDictionaries:DLPDictionaries example <dictionary_id>
 * ```
 *
 * or
 *
 * ```sh
 * $ pulumi import zia:index/dLPDictionaries:DLPDictionaries example <dictionary_name>
 * ```
 */
export declare class DLPDictionaries extends pulumi.CustomResource {
    /**
     * Get an existing DLPDictionaries 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?: DLPDictionariesState, opts?: pulumi.CustomResourceOptions): DLPDictionaries;
    /**
     * Returns true if the given object is an instance of DLPDictionaries.  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 DLPDictionaries;
    /**
     * The list of Bank Identification Number (BIN) values that are included or excluded from the Credit Cards dictionary. BIN
     * values can be specified only for Diners Club, Mastercard, RuPay, and Visa cards. Up to 512 BIN values can be configured
     * in a dictionary. Note: This field is applicable only to the predefined Credit Cards dictionary and its clones.
     */
    readonly binNumbers: pulumi.Output<number[] | undefined>;
    /**
     * The DLP confidence threshold for predefined dictionaries
     */
    readonly confidenceLevelForPredefinedDict: pulumi.Output<string | undefined>;
    /**
     * The DLP confidence threshold
     */
    readonly confidenceThreshold: pulumi.Output<string | undefined>;
    /**
     * The DLP dictionary proximity length.
     */
    readonly custom: pulumi.Output<boolean>;
    readonly customPhraseMatchType: pulumi.Output<string>;
    /**
     * The desciption of the DLP dictionary
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * ID of the predefined dictionary (original source dictionary) that is used for cloning. This field is applicable only to
     * cloned dictionaries. Only a limited set of identification-based predefined dictionaries (e.g., Credit Cards, Social
     * Security Numbers, National Identification Numbers, etc.) can be cloned. Up to 4 clones can be created from a predefined
     * dictionary.
     */
    readonly dictTemplateId: pulumi.Output<number | undefined>;
    readonly dictionaryId: pulumi.Output<number>;
    /**
     * The DLP dictionary type.
     */
    readonly dictionaryType: pulumi.Output<string | undefined>;
    /**
     * Exact Data Match (EDM) related information for custom DLP dictionaries.
     */
    readonly exactDataMatchDetails: pulumi.Output<outputs.DLPDictionariesExactDataMatchDetail[] | undefined>;
    /**
     * List of hierarchical identifiers for the DLP dictionary.
     */
    readonly hierarchicalIdentifiers: pulumi.Output<string[] | undefined>;
    /**
     * List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
     */
    readonly idmProfileMatchAccuracies: pulumi.Output<outputs.DLPDictionariesIdmProfileMatchAccuracy[]>;
    /**
     * Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed
     * Document Match (IDM) Dictionary.
     */
    readonly ignoreExactMatchIdmDict: pulumi.Output<boolean | undefined>;
    /**
     * A true value denotes that the specified Bank Identification Number (BIN) values are included in the Credit Cards
     * dictionary. A false value denotes that the specified BIN values are excluded from the Credit Cards dictionary.Note: This
     * field is applicable only to the predefined Credit Cards dictionary and its clones.
     */
    readonly includeBinNumbers: pulumi.Output<boolean>;
    /**
     * The DLP dictionary's name
     */
    readonly name: pulumi.Output<string>;
    /**
     * List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP
     * dictionaries
     */
    readonly patterns: pulumi.Output<outputs.DLPDictionariesPattern[]>;
    readonly phrases: pulumi.Output<outputs.DLPDictionariesPhrase[]>;
    /**
     * The DLP dictionary proximity length.
     */
    readonly proximity: pulumi.Output<number | undefined>;
    /**
     * Create a DLPDictionaries 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?: DLPDictionariesArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DLPDictionaries resources.
 */
export interface DLPDictionariesState {
    /**
     * The list of Bank Identification Number (BIN) values that are included or excluded from the Credit Cards dictionary. BIN
     * values can be specified only for Diners Club, Mastercard, RuPay, and Visa cards. Up to 512 BIN values can be configured
     * in a dictionary. Note: This field is applicable only to the predefined Credit Cards dictionary and its clones.
     */
    binNumbers?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * The DLP confidence threshold for predefined dictionaries
     */
    confidenceLevelForPredefinedDict?: pulumi.Input<string>;
    /**
     * The DLP confidence threshold
     */
    confidenceThreshold?: pulumi.Input<string>;
    /**
     * The DLP dictionary proximity length.
     */
    custom?: pulumi.Input<boolean>;
    customPhraseMatchType?: pulumi.Input<string>;
    /**
     * The desciption of the DLP dictionary
     */
    description?: pulumi.Input<string>;
    /**
     * ID of the predefined dictionary (original source dictionary) that is used for cloning. This field is applicable only to
     * cloned dictionaries. Only a limited set of identification-based predefined dictionaries (e.g., Credit Cards, Social
     * Security Numbers, National Identification Numbers, etc.) can be cloned. Up to 4 clones can be created from a predefined
     * dictionary.
     */
    dictTemplateId?: pulumi.Input<number>;
    dictionaryId?: pulumi.Input<number>;
    /**
     * The DLP dictionary type.
     */
    dictionaryType?: pulumi.Input<string>;
    /**
     * Exact Data Match (EDM) related information for custom DLP dictionaries.
     */
    exactDataMatchDetails?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesExactDataMatchDetail>[]>;
    /**
     * List of hierarchical identifiers for the DLP dictionary.
     */
    hierarchicalIdentifiers?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
     */
    idmProfileMatchAccuracies?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesIdmProfileMatchAccuracy>[]>;
    /**
     * Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed
     * Document Match (IDM) Dictionary.
     */
    ignoreExactMatchIdmDict?: pulumi.Input<boolean>;
    /**
     * A true value denotes that the specified Bank Identification Number (BIN) values are included in the Credit Cards
     * dictionary. A false value denotes that the specified BIN values are excluded from the Credit Cards dictionary.Note: This
     * field is applicable only to the predefined Credit Cards dictionary and its clones.
     */
    includeBinNumbers?: pulumi.Input<boolean>;
    /**
     * The DLP dictionary's name
     */
    name?: pulumi.Input<string>;
    /**
     * List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP
     * dictionaries
     */
    patterns?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesPattern>[]>;
    phrases?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesPhrase>[]>;
    /**
     * The DLP dictionary proximity length.
     */
    proximity?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a DLPDictionaries resource.
 */
export interface DLPDictionariesArgs {
    /**
     * The list of Bank Identification Number (BIN) values that are included or excluded from the Credit Cards dictionary. BIN
     * values can be specified only for Diners Club, Mastercard, RuPay, and Visa cards. Up to 512 BIN values can be configured
     * in a dictionary. Note: This field is applicable only to the predefined Credit Cards dictionary and its clones.
     */
    binNumbers?: pulumi.Input<pulumi.Input<number>[]>;
    /**
     * The DLP confidence threshold for predefined dictionaries
     */
    confidenceLevelForPredefinedDict?: pulumi.Input<string>;
    /**
     * The DLP confidence threshold
     */
    confidenceThreshold?: pulumi.Input<string>;
    /**
     * The DLP dictionary proximity length.
     */
    custom?: pulumi.Input<boolean>;
    customPhraseMatchType?: pulumi.Input<string>;
    /**
     * The desciption of the DLP dictionary
     */
    description?: pulumi.Input<string>;
    /**
     * ID of the predefined dictionary (original source dictionary) that is used for cloning. This field is applicable only to
     * cloned dictionaries. Only a limited set of identification-based predefined dictionaries (e.g., Credit Cards, Social
     * Security Numbers, National Identification Numbers, etc.) can be cloned. Up to 4 clones can be created from a predefined
     * dictionary.
     */
    dictTemplateId?: pulumi.Input<number>;
    /**
     * The DLP dictionary type.
     */
    dictionaryType?: pulumi.Input<string>;
    /**
     * Exact Data Match (EDM) related information for custom DLP dictionaries.
     */
    exactDataMatchDetails?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesExactDataMatchDetail>[]>;
    /**
     * List of hierarchical identifiers for the DLP dictionary.
     */
    hierarchicalIdentifiers?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
     */
    idmProfileMatchAccuracies?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesIdmProfileMatchAccuracy>[]>;
    /**
     * Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed
     * Document Match (IDM) Dictionary.
     */
    ignoreExactMatchIdmDict?: pulumi.Input<boolean>;
    /**
     * A true value denotes that the specified Bank Identification Number (BIN) values are included in the Credit Cards
     * dictionary. A false value denotes that the specified BIN values are excluded from the Credit Cards dictionary.Note: This
     * field is applicable only to the predefined Credit Cards dictionary and its clones.
     */
    includeBinNumbers?: pulumi.Input<boolean>;
    /**
     * The DLP dictionary's name
     */
    name?: pulumi.Input<string>;
    /**
     * List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP
     * dictionaries
     */
    patterns?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesPattern>[]>;
    phrases?: pulumi.Input<pulumi.Input<inputs.DLPDictionariesPhrase>[]>;
    /**
     * The DLP dictionary proximity length.
     */
    proximity?: pulumi.Input<number>;
}