@bdzscaler/pulumi-zia
Version:
A Pulumi package for creating and managing zia cloud resources.
105 lines (104 loc) • 5.05 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
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)
*
* Use the **zia_dlp_dictionaries** data source to get information about a DLP dictionary option available in the Zscaler Internet Access.
*/
export declare function getDLPDictionaries(args?: GetDLPDictionariesArgs, opts?: pulumi.InvokeOptions): Promise<GetDLPDictionariesResult>;
/**
* A collection of arguments for invoking getDLPDictionaries.
*/
export interface GetDLPDictionariesArgs {
/**
* Unique identifier for the DLP dictionary
*/
id?: number;
/**
* DLP dictionary name
*/
name?: string;
}
/**
* A collection of values returned by getDLPDictionaries.
*/
export interface GetDLPDictionariesResult {
/**
* (Boolean) 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: number[];
/**
* (Optional) The DLP confidence threshold for predefined dictionaries. The following values are supported:
* * `CONFIDENCE_LEVEL_LOW`
* * `CONFIDENCE_LEVEL_MEDIUM`
* * `CONFIDENCE_LEVEL_HIGH`
*/
readonly confidenceLevelForPredefinedDict: string;
/**
* (String) he DLP confidence threshold. [`CONFIDENCE_LEVEL_LOW`, `CONFIDENCE_LEVEL_MEDIUM` `CONFIDENCE_LEVEL_HIGH` ]
*/
readonly confidenceThreshold: string;
/**
* (Boolean) This value is set to true for custom DLP dictionaries.
*/
readonly custom: boolean;
/**
* (String) The DLP custom phrase match type. [ `MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY`, `MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY` ]
*/
readonly customPhraseMatchType: string;
readonly description: string;
/**
* (Number) 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: number;
/**
* (String) The DLP dictionary type. The cloud service API only supports custom DLP dictionaries that are using the `PATTERNS_AND_PHRASES` type.
*/
readonly dictionaryType: string;
readonly exactDataMatchDetails: outputs.GetDLPDictionariesExactDataMatchDetail[];
readonly id: number;
readonly idmProfileMatchAccuracies: outputs.GetDLPDictionariesIdmProfileMatchAccuracy[];
/**
* (Boolean) Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
*/
readonly ignoreExactMatchIdmDict: boolean;
/**
* (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.
*/
readonly includeBinNumbers: boolean;
readonly name: string;
/**
* (Boolean) Indicates whether the name is localized or not. This is always set to True for predefined DLP dictionaries.
*/
readonly nameL10nTag: boolean;
readonly patterns: outputs.GetDLPDictionariesPattern[];
readonly phrases: outputs.GetDLPDictionariesPhrase[];
/**
* (Boolean) This field is set to true if the dictionary is cloned from a predefined dictionary. Otherwise, it is set to false.
*/
readonly predefinedClone: boolean;
readonly proximity: number;
readonly proximityLengthEnabled: boolean;
readonly thresholdType: string;
}
/**
* * [Official documentation](https://help.zscaler.com/zia/adding-custom-dlp-dictionary)
* * [API documentation](https://help.zscaler.com/zia/data-loss-prevention#/dlpDictionaries-post)
*
* Use the **zia_dlp_dictionaries** data source to get information about a DLP dictionary option available in the Zscaler Internet Access.
*/
export declare function getDLPDictionariesOutput(args?: GetDLPDictionariesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDLPDictionariesResult>;
/**
* A collection of arguments for invoking getDLPDictionaries.
*/
export interface GetDLPDictionariesOutputArgs {
/**
* Unique identifier for the DLP dictionary
*/
id?: pulumi.Input<number>;
/**
* DLP dictionary name
*/
name?: pulumi.Input<string>;
}