Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. DLPDictionaries
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

zia.DLPDictionaries

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

    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

    import * as pulumi from "@pulumi/pulumi";
import * as zia from "@bdzscaler/pulumi-zia";

const example = new zia.DLPDictionaries("example", {
    customPhraseMatchType: "MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY",
    description: "Your Description",
    dictionaryType: "PATTERNS_AND_PHRASES",
    patterns: [{
        action: "PATTERN_COUNT_TYPE_UNIQUE",
        pattern: "YourPattern",
    }],
    phrases: [{
        action: "PHRASE_COUNT_TYPE_ALL",
        phrase: "YourPhrase",
    }],
});

    import pulumi
import zscaler_pulumi_zia as zia

example = zia.DLPDictionaries("example",
    custom_phrase_match_type="MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY",
    description="Your Description",
    dictionary_type="PATTERNS_AND_PHRASES",
    patterns=[zia.DLPDictionariesPatternArgs(
        action="PATTERN_COUNT_TYPE_UNIQUE",
        pattern="YourPattern",
    )],
    phrases=[zia.DLPDictionariesPhraseArgs(
        action="PHRASE_COUNT_TYPE_ALL",
        phrase="YourPhrase",
    )])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zia/sdk/go/zia"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.NewDLPDictionaries(ctx, "example", &zia.DLPDictionariesArgs{
			CustomPhraseMatchType: pulumi.String("MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY"),
			Description:           pulumi.String("Your Description"),
			DictionaryType:        pulumi.String("PATTERNS_AND_PHRASES"),
			Patterns: zia.DLPDictionariesPatternArray{
				&zia.DLPDictionariesPatternArgs{
					Action:  pulumi.String("PATTERN_COUNT_TYPE_UNIQUE"),
					Pattern: pulumi.String("YourPattern"),
				},
			},
			Phrases: zia.DLPDictionariesPhraseArray{
				&zia.DLPDictionariesPhraseArgs{
					Action: pulumi.String("PHRASE_COUNT_TYPE_ALL"),
					Phrase: pulumi.String("YourPhrase"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = zscaler.PulumiPackage.Zia;

return await Deployment.RunAsync(() => 
{
    var example = new Zia.DLPDictionaries("example", new()
    {
        CustomPhraseMatchType = "MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY",
        Description = "Your Description",
        DictionaryType = "PATTERNS_AND_PHRASES",
        Patterns = new[]
        {
            new Zia.Inputs.DLPDictionariesPatternArgs
            {
                Action = "PATTERN_COUNT_TYPE_UNIQUE",
                Pattern = "YourPattern",
            },
        },
        Phrases = new[]
        {
            new Zia.Inputs.DLPDictionariesPhraseArgs
            {
                Action = "PHRASE_COUNT_TYPE_ALL",
                Phrase = "YourPhrase",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.DLPDictionaries;
import com.pulumi.zia.DLPDictionariesArgs;
import com.pulumi.zia.inputs.DLPDictionariesPatternArgs;
import com.pulumi.zia.inputs.DLPDictionariesPhraseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new DLPDictionaries("example", DLPDictionariesArgs.builder()
            .customPhraseMatchType("MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY")
            .description("Your Description")
            .dictionaryType("PATTERNS_AND_PHRASES")
            .patterns(DLPDictionariesPatternArgs.builder()
                .action("PATTERN_COUNT_TYPE_UNIQUE")
                .pattern("YourPattern")
                .build())
            .phrases(DLPDictionariesPhraseArgs.builder()
                .action("PHRASE_COUNT_TYPE_ALL")
                .phrase("YourPhrase")
                .build())
            .build());

    }
}

    resources:
  example:
    type: zia:DLPDictionaries
    properties:
      customPhraseMatchType: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY
      description: Your Description
      dictionaryType: PATTERNS_AND_PHRASES
      patterns:
        - action: PATTERN_COUNT_TYPE_UNIQUE
          pattern: YourPattern
      phrases:
        - action: PHRASE_COUNT_TYPE_ALL
          phrase: YourPhrase

    Create DLPDictionaries Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DLPDictionaries(name: string, args?: DLPDictionariesArgs, opts?: CustomResourceOptions);
    @overload
def DLPDictionaries(resource_name: str,
                    args: Optional[DLPDictionariesArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def DLPDictionaries(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bin_numbers: Optional[Sequence[int]] = None,
                    confidence_threshold: Optional[str] = None,
                    custom_phrase_match_type: Optional[str] = None,
                    description: Optional[str] = None,
                    dict_template_id: Optional[int] = None,
                    dictionary_type: Optional[str] = None,
                    exact_data_match_details: Optional[Sequence[DLPDictionariesExactDataMatchDetailArgs]] = None,
                    idm_profile_match_accuracies: Optional[Sequence[DLPDictionariesIdmProfileMatchAccuracyArgs]] = None,
                    ignore_exact_match_idm_dict: Optional[bool] = None,
                    include_bin_numbers: Optional[bool] = None,
                    name: Optional[str] = None,
                    patterns: Optional[Sequence[DLPDictionariesPatternArgs]] = None,
                    phrases: Optional[Sequence[DLPDictionariesPhraseArgs]] = None,
                    proximity: Optional[int] = None)
    func NewDLPDictionaries(ctx *Context, name string, args *DLPDictionariesArgs, opts ...ResourceOption) (*DLPDictionaries, error)
    public DLPDictionaries(string name, DLPDictionariesArgs? args = null, CustomResourceOptions? opts = null)
    public DLPDictionaries(String name, DLPDictionariesArgs args)
public DLPDictionaries(String name, DLPDictionariesArgs args, CustomResourceOptions options)

    type: zia:DLPDictionaries
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DLPDictionariesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DLPDictionariesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DLPDictionariesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DLPDictionariesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DLPDictionariesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dlpdictionariesResource = new Zia.DLPDictionaries("dlpdictionariesResource", new()
{
    BinNumbers = new[]
    {
        0,
    },
    ConfidenceThreshold = "string",
    CustomPhraseMatchType = "string",
    Description = "string",
    DictTemplateId = 0,
    DictionaryType = "string",
    ExactDataMatchDetails = new[]
    {
        new Zia.Inputs.DLPDictionariesExactDataMatchDetailArgs
        {
            DictionaryEdmMappingId = 0,
            PrimaryField = 0,
            SchemaId = 0,
            SecondaryFieldMatchOn = "string",
            SecondaryFields = new[]
            {
                0,
            },
        },
    },
    IdmProfileMatchAccuracies = new[]
    {
        new Zia.Inputs.DLPDictionariesIdmProfileMatchAccuracyArgs
        {
            AdpIdmProfiles = new[]
            {
                new Zia.Inputs.DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfileArgs
                {
                    Extensions = 
                    {
                        { "string", "string" },
                    },
                    Id = 0,
                },
            },
            MatchAccuracy = "string",
        },
    },
    IgnoreExactMatchIdmDict = false,
    IncludeBinNumbers = false,
    Name = "string",
    Patterns = new[]
    {
        new Zia.Inputs.DLPDictionariesPatternArgs
        {
            Action = "string",
            Pattern = "string",
        },
    },
    Phrases = new[]
    {
        new Zia.Inputs.DLPDictionariesPhraseArgs
        {
            Action = "string",
            Phrase = "string",
        },
    },
    Proximity = 0,
});

    example, err := zia.NewDLPDictionaries(ctx, "dlpdictionariesResource", &zia.DLPDictionariesArgs{
	BinNumbers: pulumi.IntArray{
		pulumi.Int(0),
	},
	ConfidenceThreshold:   pulumi.String("string"),
	CustomPhraseMatchType: pulumi.String("string"),
	Description:           pulumi.String("string"),
	DictTemplateId:        pulumi.Int(0),
	DictionaryType:        pulumi.String("string"),
	ExactDataMatchDetails: zia.DLPDictionariesExactDataMatchDetailArray{
		&zia.DLPDictionariesExactDataMatchDetailArgs{
			DictionaryEdmMappingId: pulumi.Int(0),
			PrimaryField:           pulumi.Int(0),
			SchemaId:               pulumi.Int(0),
			SecondaryFieldMatchOn:  pulumi.String("string"),
			SecondaryFields: pulumi.IntArray{
				pulumi.Int(0),
			},
		},
	},
	IdmProfileMatchAccuracies: zia.DLPDictionariesIdmProfileMatchAccuracyArray{
		&zia.DLPDictionariesIdmProfileMatchAccuracyArgs{
			AdpIdmProfiles: zia.DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfileArray{
				&zia.DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfileArgs{
					Extensions: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					Id: pulumi.Int(0),
				},
			},
			MatchAccuracy: pulumi.String("string"),
		},
	},
	IgnoreExactMatchIdmDict: pulumi.Bool(false),
	IncludeBinNumbers:       pulumi.Bool(false),
	Name:                    pulumi.String("string"),
	Patterns: zia.DLPDictionariesPatternArray{
		&zia.DLPDictionariesPatternArgs{
			Action:  pulumi.String("string"),
			Pattern: pulumi.String("string"),
		},
	},
	Phrases: zia.DLPDictionariesPhraseArray{
		&zia.DLPDictionariesPhraseArgs{
			Action: pulumi.String("string"),
			Phrase: pulumi.String("string"),
		},
	},
	Proximity: pulumi.Int(0),
})

    var dlpdictionariesResource = new DLPDictionaries("dlpdictionariesResource", DLPDictionariesArgs.builder()
    .binNumbers(0)
    .confidenceThreshold("string")
    .customPhraseMatchType("string")
    .description("string")
    .dictTemplateId(0)
    .dictionaryType("string")
    .exactDataMatchDetails(DLPDictionariesExactDataMatchDetailArgs.builder()
        .dictionaryEdmMappingId(0)
        .primaryField(0)
        .schemaId(0)
        .secondaryFieldMatchOn("string")
        .secondaryFields(0)
        .build())
    .idmProfileMatchAccuracies(DLPDictionariesIdmProfileMatchAccuracyArgs.builder()
        .adpIdmProfiles(DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfileArgs.builder()
            .extensions(Map.of("string", "string"))
            .id(0)
            .build())
        .matchAccuracy("string")
        .build())
    .ignoreExactMatchIdmDict(false)
    .includeBinNumbers(false)
    .name("string")
    .patterns(DLPDictionariesPatternArgs.builder()
        .action("string")
        .pattern("string")
        .build())
    .phrases(DLPDictionariesPhraseArgs.builder()
        .action("string")
        .phrase("string")
        .build())
    .proximity(0)
    .build());

    dlpdictionaries_resource = zia.DLPDictionaries("dlpdictionariesResource",
    bin_numbers=[0],
    confidence_threshold="string",
    custom_phrase_match_type="string",
    description="string",
    dict_template_id=0,
    dictionary_type="string",
    exact_data_match_details=[{
        "dictionary_edm_mapping_id": 0,
        "primary_field": 0,
        "schema_id": 0,
        "secondary_field_match_on": "string",
        "secondary_fields": [0],
    }],
    idm_profile_match_accuracies=[{
        "adp_idm_profiles": [{
            "extensions": {
                "string": "string",
            },
            "id": 0,
        }],
        "match_accuracy": "string",
    }],
    ignore_exact_match_idm_dict=False,
    include_bin_numbers=False,
    name="string",
    patterns=[{
        "action": "string",
        "pattern": "string",
    }],
    phrases=[{
        "action": "string",
        "phrase": "string",
    }],
    proximity=0)

    const dlpdictionariesResource = new zia.DLPDictionaries("dlpdictionariesResource", {
    binNumbers: [0],
    confidenceThreshold: "string",
    customPhraseMatchType: "string",
    description: "string",
    dictTemplateId: 0,
    dictionaryType: "string",
    exactDataMatchDetails: [{
        dictionaryEdmMappingId: 0,
        primaryField: 0,
        schemaId: 0,
        secondaryFieldMatchOn: "string",
        secondaryFields: [0],
    }],
    idmProfileMatchAccuracies: [{
        adpIdmProfiles: [{
            extensions: {
                string: "string",
            },
            id: 0,
        }],
        matchAccuracy: "string",
    }],
    ignoreExactMatchIdmDict: false,
    includeBinNumbers: false,
    name: "string",
    patterns: [{
        action: "string",
        pattern: "string",
    }],
    phrases: [{
        action: "string",
        phrase: "string",
    }],
    proximity: 0,
});

    type: zia:DLPDictionaries
properties:
    binNumbers:
        - 0
    confidenceThreshold: string
    customPhraseMatchType: string
    description: string
    dictTemplateId: 0
    dictionaryType: string
    exactDataMatchDetails:
        - dictionaryEdmMappingId: 0
          primaryField: 0
          schemaId: 0
          secondaryFieldMatchOn: string
          secondaryFields:
            - 0
    idmProfileMatchAccuracies:
        - adpIdmProfiles:
            - extensions:
                string: string
              id: 0
          matchAccuracy: string
    ignoreExactMatchIdmDict: false
    includeBinNumbers: false
    name: string
    patterns:
        - action: string
          pattern: string
    phrases:
        - action: string
          phrase: string
    proximity: 0

    DLPDictionaries Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DLPDictionaries resource accepts the following input properties:

    BinNumbers List<int>
    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.
    ConfidenceThreshold string
    The DLP confidence threshold
    CustomPhraseMatchType string
    Description string
    The desciption of the DLP dictionary
    DictTemplateId int
    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.
    DictionaryType string
    The DLP dictionary type.
    ExactDataMatchDetails List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesExactDataMatchDetail>
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    IdmProfileMatchAccuracies List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesIdmProfileMatchAccuracy>
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    IgnoreExactMatchIdmDict bool
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    IncludeBinNumbers bool
    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.
    Name string
    The DLP dictionary's name
    Patterns List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesPattern>
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    Phrases List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesPhrase>
    Proximity int
    The DLP dictionary proximity length.
    BinNumbers []int
    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.
    ConfidenceThreshold string
    The DLP confidence threshold
    CustomPhraseMatchType string
    Description string
    The desciption of the DLP dictionary
    DictTemplateId int
    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.
    DictionaryType string
    The DLP dictionary type.
    ExactDataMatchDetails []DLPDictionariesExactDataMatchDetailArgs
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    IdmProfileMatchAccuracies []DLPDictionariesIdmProfileMatchAccuracyArgs
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    IgnoreExactMatchIdmDict bool
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    IncludeBinNumbers bool
    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.
    Name string
    The DLP dictionary's name
    Patterns []DLPDictionariesPatternArgs
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    Phrases []DLPDictionariesPhraseArgs
    Proximity int
    The DLP dictionary proximity length.
    binNumbers List<Integer>
    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.
    confidenceThreshold String
    The DLP confidence threshold
    customPhraseMatchType String
    description String
    The desciption of the DLP dictionary
    dictTemplateId Integer
    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.
    dictionaryType String
    The DLP dictionary type.
    exactDataMatchDetails List<DLPDictionariesExactDataMatchDetail>
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idmProfileMatchAccuracies List<DLPDictionariesIdmProfileMatchAccuracy>
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignoreExactMatchIdmDict Boolean
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    includeBinNumbers 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.
    name String
    The DLP dictionary's name
    patterns List<DLPDictionariesPattern>
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases List<DLPDictionariesPhrase>
    proximity Integer
    The DLP dictionary proximity length.
    binNumbers number[]
    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.
    confidenceThreshold string
    The DLP confidence threshold
    customPhraseMatchType string
    description string
    The desciption of the DLP dictionary
    dictTemplateId 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.
    dictionaryType string
    The DLP dictionary type.
    exactDataMatchDetails DLPDictionariesExactDataMatchDetail[]
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idmProfileMatchAccuracies DLPDictionariesIdmProfileMatchAccuracy[]
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignoreExactMatchIdmDict boolean
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    includeBinNumbers 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.
    name string
    The DLP dictionary's name
    patterns DLPDictionariesPattern[]
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases DLPDictionariesPhrase[]
    proximity number
    The DLP dictionary proximity length.
    bin_numbers Sequence[int]
    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.
    confidence_threshold str
    The DLP confidence threshold
    custom_phrase_match_type str
    description str
    The desciption of the DLP dictionary
    dict_template_id int
    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.
    dictionary_type str
    The DLP dictionary type.
    exact_data_match_details Sequence[DLPDictionariesExactDataMatchDetailArgs]
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idm_profile_match_accuracies Sequence[DLPDictionariesIdmProfileMatchAccuracyArgs]
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignore_exact_match_idm_dict bool
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    include_bin_numbers bool
    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.
    name str
    The DLP dictionary's name
    patterns Sequence[DLPDictionariesPatternArgs]
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases Sequence[DLPDictionariesPhraseArgs]
    proximity int
    The DLP dictionary proximity length.
    binNumbers List<Number>
    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.
    confidenceThreshold String
    The DLP confidence threshold
    customPhraseMatchType String
    description String
    The desciption of the DLP dictionary
    dictTemplateId 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.
    dictionaryType String
    The DLP dictionary type.
    exactDataMatchDetails List<Property Map>
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idmProfileMatchAccuracies List<Property Map>
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignoreExactMatchIdmDict Boolean
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    includeBinNumbers 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.
    name String
    The DLP dictionary's name
    patterns List<Property Map>
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases List<Property Map>
    proximity Number
    The DLP dictionary proximity length.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DLPDictionaries resource produces the following output properties:

    DictionaryId int
    Id string
    The provider-assigned unique ID for this managed resource.
    DictionaryId int
    Id string
    The provider-assigned unique ID for this managed resource.
    dictionaryId Integer
    id String
    The provider-assigned unique ID for this managed resource.
    dictionaryId number
    id string
    The provider-assigned unique ID for this managed resource.
    dictionary_id int
    id str
    The provider-assigned unique ID for this managed resource.
    dictionaryId Number
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DLPDictionaries Resource

    Get an existing DLPDictionaries resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DLPDictionariesState, opts?: CustomResourceOptions): DLPDictionaries
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bin_numbers: Optional[Sequence[int]] = None,
        confidence_threshold: Optional[str] = None,
        custom_phrase_match_type: Optional[str] = None,
        description: Optional[str] = None,
        dict_template_id: Optional[int] = None,
        dictionary_id: Optional[int] = None,
        dictionary_type: Optional[str] = None,
        exact_data_match_details: Optional[Sequence[DLPDictionariesExactDataMatchDetailArgs]] = None,
        idm_profile_match_accuracies: Optional[Sequence[DLPDictionariesIdmProfileMatchAccuracyArgs]] = None,
        ignore_exact_match_idm_dict: Optional[bool] = None,
        include_bin_numbers: Optional[bool] = None,
        name: Optional[str] = None,
        patterns: Optional[Sequence[DLPDictionariesPatternArgs]] = None,
        phrases: Optional[Sequence[DLPDictionariesPhraseArgs]] = None,
        proximity: Optional[int] = None) -> DLPDictionaries
    func GetDLPDictionaries(ctx *Context, name string, id IDInput, state *DLPDictionariesState, opts ...ResourceOption) (*DLPDictionaries, error)
    public static DLPDictionaries Get(string name, Input<string> id, DLPDictionariesState? state, CustomResourceOptions? opts = null)
    public static DLPDictionaries get(String name, Output<String> id, DLPDictionariesState state, CustomResourceOptions options)
    resources:  _:    type: zia:DLPDictionaries    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BinNumbers List<int>
    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.
    ConfidenceThreshold string
    The DLP confidence threshold
    CustomPhraseMatchType string
    Description string
    The desciption of the DLP dictionary
    DictTemplateId int
    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.
    DictionaryId int
    DictionaryType string
    The DLP dictionary type.
    ExactDataMatchDetails List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesExactDataMatchDetail>
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    IdmProfileMatchAccuracies List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesIdmProfileMatchAccuracy>
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    IgnoreExactMatchIdmDict bool
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    IncludeBinNumbers bool
    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.
    Name string
    The DLP dictionary's name
    Patterns List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesPattern>
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    Phrases List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesPhrase>
    Proximity int
    The DLP dictionary proximity length.
    BinNumbers []int
    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.
    ConfidenceThreshold string
    The DLP confidence threshold
    CustomPhraseMatchType string
    Description string
    The desciption of the DLP dictionary
    DictTemplateId int
    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.
    DictionaryId int
    DictionaryType string
    The DLP dictionary type.
    ExactDataMatchDetails []DLPDictionariesExactDataMatchDetailArgs
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    IdmProfileMatchAccuracies []DLPDictionariesIdmProfileMatchAccuracyArgs
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    IgnoreExactMatchIdmDict bool
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    IncludeBinNumbers bool
    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.
    Name string
    The DLP dictionary's name
    Patterns []DLPDictionariesPatternArgs
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    Phrases []DLPDictionariesPhraseArgs
    Proximity int
    The DLP dictionary proximity length.
    binNumbers List<Integer>
    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.
    confidenceThreshold String
    The DLP confidence threshold
    customPhraseMatchType String
    description String
    The desciption of the DLP dictionary
    dictTemplateId Integer
    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.
    dictionaryId Integer
    dictionaryType String
    The DLP dictionary type.
    exactDataMatchDetails List<DLPDictionariesExactDataMatchDetail>
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idmProfileMatchAccuracies List<DLPDictionariesIdmProfileMatchAccuracy>
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignoreExactMatchIdmDict Boolean
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    includeBinNumbers 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.
    name String
    The DLP dictionary's name
    patterns List<DLPDictionariesPattern>
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases List<DLPDictionariesPhrase>
    proximity Integer
    The DLP dictionary proximity length.
    binNumbers number[]
    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.
    confidenceThreshold string
    The DLP confidence threshold
    customPhraseMatchType string
    description string
    The desciption of the DLP dictionary
    dictTemplateId 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.
    dictionaryId number
    dictionaryType string
    The DLP dictionary type.
    exactDataMatchDetails DLPDictionariesExactDataMatchDetail[]
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idmProfileMatchAccuracies DLPDictionariesIdmProfileMatchAccuracy[]
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignoreExactMatchIdmDict boolean
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    includeBinNumbers 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.
    name string
    The DLP dictionary's name
    patterns DLPDictionariesPattern[]
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases DLPDictionariesPhrase[]
    proximity number
    The DLP dictionary proximity length.
    bin_numbers Sequence[int]
    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.
    confidence_threshold str
    The DLP confidence threshold
    custom_phrase_match_type str
    description str
    The desciption of the DLP dictionary
    dict_template_id int
    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.
    dictionary_id int
    dictionary_type str
    The DLP dictionary type.
    exact_data_match_details Sequence[DLPDictionariesExactDataMatchDetailArgs]
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idm_profile_match_accuracies Sequence[DLPDictionariesIdmProfileMatchAccuracyArgs]
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignore_exact_match_idm_dict bool
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    include_bin_numbers bool
    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.
    name str
    The DLP dictionary's name
    patterns Sequence[DLPDictionariesPatternArgs]
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases Sequence[DLPDictionariesPhraseArgs]
    proximity int
    The DLP dictionary proximity length.
    binNumbers List<Number>
    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.
    confidenceThreshold String
    The DLP confidence threshold
    customPhraseMatchType String
    description String
    The desciption of the DLP dictionary
    dictTemplateId 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.
    dictionaryId Number
    dictionaryType String
    The DLP dictionary type.
    exactDataMatchDetails List<Property Map>
    Exact Data Match (EDM) related information for custom DLP dictionaries.
    idmProfileMatchAccuracies List<Property Map>
    List of Indexed Document Match (IDM) profiles and their corresponding match accuracy for custom DLP dictionaries.
    ignoreExactMatchIdmDict Boolean
    Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary.
    includeBinNumbers 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.
    name String
    The DLP dictionary's name
    patterns List<Property Map>
    List containing the patterns used within a custom DLP dictionary. This attribute is not applicable to predefined DLP dictionaries
    phrases List<Property Map>
    proximity Number
    The DLP dictionary proximity length.

    Supporting Types

    DLPDictionariesExactDataMatchDetail, DLPDictionariesExactDataMatchDetailArgs

    DictionaryEdmMappingId int
    The unique identifier for the EDM mapping
    PrimaryField int
    The EDM template's primary field.
    SchemaId int
    The unique identifier for the EDM template (or schema).
    SecondaryFieldMatchOn string
    The EDM secondary field to match on.
    SecondaryFields List<int>
    The EDM template's secondary fields.
    DictionaryEdmMappingId int
    The unique identifier for the EDM mapping
    PrimaryField int
    The EDM template's primary field.
    SchemaId int
    The unique identifier for the EDM template (or schema).
    SecondaryFieldMatchOn string
    The EDM secondary field to match on.
    SecondaryFields []int
    The EDM template's secondary fields.
    dictionaryEdmMappingId Integer
    The unique identifier for the EDM mapping
    primaryField Integer
    The EDM template's primary field.
    schemaId Integer
    The unique identifier for the EDM template (or schema).
    secondaryFieldMatchOn String
    The EDM secondary field to match on.
    secondaryFields List<Integer>
    The EDM template's secondary fields.
    dictionaryEdmMappingId number
    The unique identifier for the EDM mapping
    primaryField number
    The EDM template's primary field.
    schemaId number
    The unique identifier for the EDM template (or schema).
    secondaryFieldMatchOn string
    The EDM secondary field to match on.
    secondaryFields number[]
    The EDM template's secondary fields.
    dictionary_edm_mapping_id int
    The unique identifier for the EDM mapping
    primary_field int
    The EDM template's primary field.
    schema_id int
    The unique identifier for the EDM template (or schema).
    secondary_field_match_on str
    The EDM secondary field to match on.
    secondary_fields Sequence[int]
    The EDM template's secondary fields.
    dictionaryEdmMappingId Number
    The unique identifier for the EDM mapping
    primaryField Number
    The EDM template's primary field.
    schemaId Number
    The unique identifier for the EDM template (or schema).
    secondaryFieldMatchOn String
    The EDM secondary field to match on.
    secondaryFields List<Number>
    The EDM template's secondary fields.

    DLPDictionariesIdmProfileMatchAccuracy, DLPDictionariesIdmProfileMatchAccuracyArgs

    AdpIdmProfiles List<zscaler.PulumiPackage.Zia.Inputs.DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfile>
    The action applied to a DLP dictionary using patterns
    MatchAccuracy string
    The IDM template match accuracy.
    AdpIdmProfiles []DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfile
    The action applied to a DLP dictionary using patterns
    MatchAccuracy string
    The IDM template match accuracy.
    adpIdmProfiles List<DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfile>
    The action applied to a DLP dictionary using patterns
    matchAccuracy String
    The IDM template match accuracy.
    adpIdmProfiles DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfile[]
    The action applied to a DLP dictionary using patterns
    matchAccuracy string
    The IDM template match accuracy.
    adp_idm_profiles Sequence[DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfile]
    The action applied to a DLP dictionary using patterns
    match_accuracy str
    The IDM template match accuracy.
    adpIdmProfiles List<Property Map>
    The action applied to a DLP dictionary using patterns
    matchAccuracy String
    The IDM template match accuracy.

    DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfile, DLPDictionariesIdmProfileMatchAccuracyAdpIdmProfileArgs

    Extensions Dictionary<string, string>
    Id int
    Extensions map[string]string
    Id int
    extensions Map<String,String>
    id Integer
    extensions {[key: string]: string}
    id number
    extensions Mapping[str, str]
    id int
    extensions Map<String>
    id Number

    DLPDictionariesPattern, DLPDictionariesPatternArgs

    Action string
    The action applied to a DLP dictionary using patterns
    Pattern string
    DLP dictionary pattern
    Action string
    The action applied to a DLP dictionary using patterns
    Pattern string
    DLP dictionary pattern
    action String
    The action applied to a DLP dictionary using patterns
    pattern String
    DLP dictionary pattern
    action string
    The action applied to a DLP dictionary using patterns
    pattern string
    DLP dictionary pattern
    action str
    The action applied to a DLP dictionary using patterns
    pattern str
    DLP dictionary pattern
    action String
    The action applied to a DLP dictionary using patterns
    pattern String
    DLP dictionary pattern

    DLPDictionariesPhrase, DLPDictionariesPhraseArgs

    Action string
    Phrase string
    DLP dictionary phrase
    Action string
    Phrase string
    DLP dictionary phrase
    action String
    phrase String
    DLP dictionary phrase
    action string
    phrase string
    DLP dictionary phrase
    action str
    phrase str
    DLP dictionary phrase
    action String
    phrase String
    DLP dictionary phrase

    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:

    $ pulumi import zia:index/dLPDictionaries:DLPDictionaries example <dictionary_id>

    or

    $ pulumi import zia:index/dLPDictionaries:DLPDictionaries example <dictionary_name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zia