1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. DlpDictionary
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.DlpDictionary

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    The zia_dlp_dictionaries resource manages DLP (Data Loss Prevention) dictionaries in the Zscaler Internet Access (ZIA) cloud service. DLP dictionaries are used to define custom or predefined patterns and phrases that identify sensitive data for DLP policy enforcement.

    For more information, see the ZIA Data Loss Prevention documentation.

    Example Usage

    Basic DLP Dictionary

    Example coming soon!

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.NewDlpDictionary(ctx, "example", &zia.DlpDictionaryArgs{
			Name:                  pulumi.StringRef("Example DLP Dictionary"),
			Description:           pulumi.StringRef("Custom DLP dictionary for detecting sensitive patterns"),
			DictionaryType:        pulumi.StringRef("PATTERNS_AND_PHRASES"),
			CustomPhraseMatchType: pulumi.StringRef("MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY"),
		})
		return err
	})
}

    Example coming soon!

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

const example = new zia.DlpDictionary("example", {
    name: "Example DLP Dictionary",
    description: "Custom DLP dictionary for detecting sensitive patterns",
    dictionaryType: "PATTERNS_AND_PHRASES",
    customPhraseMatchType: "MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY",
    phrases: [{
        action: "PHRASE_COUNT_TYPE_ALL",
        phrase: "confidential",
    }],
    patterns: [{
        action: "PATTERN_COUNT_TYPE_ALL",
        pattern: "\\b\\d{3}-\\d{2}-\\d{4}\\b",
    }],
});

    import zscaler_pulumi_zia as zia

example = zia.DlpDictionary("example",
    name="Example DLP Dictionary",
    description="Custom DLP dictionary for detecting sensitive patterns",
    dictionary_type="PATTERNS_AND_PHRASES",
    custom_phrase_match_type="MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY",
    phrases=[{
        "action": "PHRASE_COUNT_TYPE_ALL",
        "phrase": "confidential",
    }],
    patterns=[{
        "action": "PATTERN_COUNT_TYPE_ALL",
        "pattern": "\\b\\d{3}-\\d{2}-\\d{4}\\b",
    }],
)

    resources:
  example:
    type: zia:DlpDictionary
    properties:
      name: Example DLP Dictionary
      description: Custom DLP dictionary for detecting sensitive patterns
      dictionaryType: PATTERNS_AND_PHRASES
      customPhraseMatchType: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY
      phrases:
        - action: PHRASE_COUNT_TYPE_ALL
          phrase: confidential
      patterns:
        - action: PATTERN_COUNT_TYPE_ALL
          pattern: "\\b\\d{3}-\\d{2}-\\d{4}\\b"

    Create DlpDictionary Resource

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

    Constructor syntax

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

@overload
def DlpDictionary(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  confidence_threshold: Optional[str] = None,
                  custom: Optional[bool] = None,
                  custom_phrase_match_type: Optional[str] = None,
                  description: Optional[str] = None,
                  dictionary_type: Optional[str] = None,
                  hierarchical_identifiers: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  patterns: Optional[Sequence[DlpDictionaryPatternInputArgs]] = None,
                  phrases: Optional[Sequence[DlpDictionaryPhraseInputArgs]] = None,
                  proximity: Optional[int] = None,
                  proximity_enabled_for_custom_dictionary: Optional[bool] = None)
    func NewDlpDictionary(ctx *Context, name string, args *DlpDictionaryArgs, opts ...ResourceOption) (*DlpDictionary, error)
    public DlpDictionary(string name, DlpDictionaryArgs? args = null, CustomResourceOptions? opts = null)
    public DlpDictionary(String name, DlpDictionaryArgs args)
public DlpDictionary(String name, DlpDictionaryArgs args, CustomResourceOptions options)

    type: zia:DlpDictionary
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 DlpDictionaryArgs
    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 DlpDictionaryArgs
    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 DlpDictionaryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DlpDictionaryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DlpDictionaryArgs
    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 dlpDictionaryResource = new Zia.DlpDictionary("dlpDictionaryResource", new()
{
    ConfidenceThreshold = "string",
    Custom = false,
    CustomPhraseMatchType = "string",
    Description = "string",
    DictionaryType = "string",
    HierarchicalIdentifiers = new[]
    {
        "string",
    },
    Name = "string",
    Patterns = new[]
    {
        new Zia.Inputs.DlpDictionaryPatternInputArgs
        {
            Action = "string",
            Pattern = "string",
        },
    },
    Phrases = new[]
    {
        new Zia.Inputs.DlpDictionaryPhraseInputArgs
        {
            Action = "string",
            Phrase = "string",
        },
    },
    Proximity = 0,
    ProximityEnabledForCustomDictionary = false,
});

    example, err := zia.NewDlpDictionary(ctx, "dlpDictionaryResource", &zia.DlpDictionaryArgs{
	ConfidenceThreshold:   pulumi.String("string"),
	Custom:                pulumi.Bool(false),
	CustomPhraseMatchType: pulumi.String("string"),
	Description:           pulumi.String("string"),
	DictionaryType:        pulumi.String("string"),
	HierarchicalIdentifiers: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Patterns: pulumizia.DlpDictionaryPatternInputArray{
		&pulumizia.DlpDictionaryPatternInputArgs{
			Action:  pulumi.String("string"),
			Pattern: pulumi.String("string"),
		},
	},
	Phrases: pulumizia.DlpDictionaryPhraseInputArray{
		&pulumizia.DlpDictionaryPhraseInputArgs{
			Action: pulumi.String("string"),
			Phrase: pulumi.String("string"),
		},
	},
	Proximity:                           pulumi.Int(0),
	ProximityEnabledForCustomDictionary: pulumi.Bool(false),
})

    var dlpDictionaryResource = new DlpDictionary("dlpDictionaryResource", DlpDictionaryArgs.builder()
    .confidenceThreshold("string")
    .custom(false)
    .customPhraseMatchType("string")
    .description("string")
    .dictionaryType("string")
    .hierarchicalIdentifiers("string")
    .name("string")
    .patterns(DlpDictionaryPatternInputArgs.builder()
        .action("string")
        .pattern("string")
        .build())
    .phrases(DlpDictionaryPhraseInputArgs.builder()
        .action("string")
        .phrase("string")
        .build())
    .proximity(0)
    .proximityEnabledForCustomDictionary(false)
    .build());

    dlp_dictionary_resource = zia.DlpDictionary("dlpDictionaryResource",
    confidence_threshold="string",
    custom=False,
    custom_phrase_match_type="string",
    description="string",
    dictionary_type="string",
    hierarchical_identifiers=["string"],
    name="string",
    patterns=[{
        "action": "string",
        "pattern": "string",
    }],
    phrases=[{
        "action": "string",
        "phrase": "string",
    }],
    proximity=0,
    proximity_enabled_for_custom_dictionary=False)

    const dlpDictionaryResource = new zia.DlpDictionary("dlpDictionaryResource", {
    confidenceThreshold: "string",
    custom: false,
    customPhraseMatchType: "string",
    description: "string",
    dictionaryType: "string",
    hierarchicalIdentifiers: ["string"],
    name: "string",
    patterns: [{
        action: "string",
        pattern: "string",
    }],
    phrases: [{
        action: "string",
        phrase: "string",
    }],
    proximity: 0,
    proximityEnabledForCustomDictionary: false,
});

    type: zia:DlpDictionary
properties:
    confidenceThreshold: string
    custom: false
    customPhraseMatchType: string
    description: string
    dictionaryType: string
    hierarchicalIdentifiers:
        - string
    name: string
    patterns:
        - action: string
          pattern: string
    phrases:
        - action: string
          phrase: string
    proximity: 0
    proximityEnabledForCustomDictionary: false

    DlpDictionary 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 DlpDictionary resource accepts the following input properties:

    ConfidenceThreshold string
    The DLP confidence threshold. Valid values: CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_HIGH.
    Custom bool
    If true, this is a custom DLP dictionary; false indicates a predefined dictionary.
    CustomPhraseMatchType string
    The match type for custom phrases. Valid values: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY, MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY.
    Description string
    A description of the DLP dictionary.
    DictionaryType string
    The type of DLP dictionary. Valid values: PATTERNS_AND_PHRASES, EXACT_DATA_MATCH, INDEXED_DATA_MATCH.
    HierarchicalIdentifiers List<string>
    List of hierarchical identifiers for the DLP dictionary.
    Name string
    The name of the DLP dictionary. Must be unique.
    Patterns List<zscaler.PulumiPackage.Zia.Inputs.DlpDictionaryPatternInput>
    List of DLP dictionary patterns with their match actions.
    Phrases List<zscaler.PulumiPackage.Zia.Inputs.DlpDictionaryPhraseInput>
    List of DLP dictionary phrases with their match actions.
    Proximity int
    The proximity length for dictionary matching. Specifies the distance between phrases/patterns for a match.
    ProximityEnabledForCustomDictionary bool
    If true, proximity matching is enabled for this custom DLP dictionary.
    ConfidenceThreshold string
    The DLP confidence threshold. Valid values: CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_HIGH.
    Custom bool
    If true, this is a custom DLP dictionary; false indicates a predefined dictionary.
    CustomPhraseMatchType string
    The match type for custom phrases. Valid values: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY, MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY.
    Description string
    A description of the DLP dictionary.
    DictionaryType string
    The type of DLP dictionary. Valid values: PATTERNS_AND_PHRASES, EXACT_DATA_MATCH, INDEXED_DATA_MATCH.
    HierarchicalIdentifiers []string
    List of hierarchical identifiers for the DLP dictionary.
    Name string
    The name of the DLP dictionary. Must be unique.
    Patterns []DlpDictionaryPatternInputArgs
    List of DLP dictionary patterns with their match actions.
    Phrases []DlpDictionaryPhraseInputArgs
    List of DLP dictionary phrases with their match actions.
    Proximity int
    The proximity length for dictionary matching. Specifies the distance between phrases/patterns for a match.
    ProximityEnabledForCustomDictionary bool
    If true, proximity matching is enabled for this custom DLP dictionary.
    confidenceThreshold String
    The DLP confidence threshold. Valid values: CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_HIGH.
    custom Boolean
    If true, this is a custom DLP dictionary; false indicates a predefined dictionary.
    customPhraseMatchType String
    The match type for custom phrases. Valid values: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY, MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY.
    description String
    A description of the DLP dictionary.
    dictionaryType String
    The type of DLP dictionary. Valid values: PATTERNS_AND_PHRASES, EXACT_DATA_MATCH, INDEXED_DATA_MATCH.
    hierarchicalIdentifiers List<String>
    List of hierarchical identifiers for the DLP dictionary.
    name String
    The name of the DLP dictionary. Must be unique.
    patterns List<DlpDictionaryPatternInput>
    List of DLP dictionary patterns with their match actions.
    phrases List<DlpDictionaryPhraseInput>
    List of DLP dictionary phrases with their match actions.
    proximity Integer
    The proximity length for dictionary matching. Specifies the distance between phrases/patterns for a match.
    proximityEnabledForCustomDictionary Boolean
    If true, proximity matching is enabled for this custom DLP dictionary.
    confidenceThreshold string
    The DLP confidence threshold. Valid values: CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_HIGH.
    custom boolean
    If true, this is a custom DLP dictionary; false indicates a predefined dictionary.
    customPhraseMatchType string
    The match type for custom phrases. Valid values: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY, MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY.
    description string
    A description of the DLP dictionary.
    dictionaryType string
    The type of DLP dictionary. Valid values: PATTERNS_AND_PHRASES, EXACT_DATA_MATCH, INDEXED_DATA_MATCH.
    hierarchicalIdentifiers string[]
    List of hierarchical identifiers for the DLP dictionary.
    name string
    The name of the DLP dictionary. Must be unique.
    patterns DlpDictionaryPatternInput[]
    List of DLP dictionary patterns with their match actions.
    phrases DlpDictionaryPhraseInput[]
    List of DLP dictionary phrases with their match actions.
    proximity number
    The proximity length for dictionary matching. Specifies the distance between phrases/patterns for a match.
    proximityEnabledForCustomDictionary boolean
    If true, proximity matching is enabled for this custom DLP dictionary.
    confidence_threshold str
    The DLP confidence threshold. Valid values: CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_HIGH.
    custom bool
    If true, this is a custom DLP dictionary; false indicates a predefined dictionary.
    custom_phrase_match_type str
    The match type for custom phrases. Valid values: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY, MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY.
    description str
    A description of the DLP dictionary.
    dictionary_type str
    The type of DLP dictionary. Valid values: PATTERNS_AND_PHRASES, EXACT_DATA_MATCH, INDEXED_DATA_MATCH.
    hierarchical_identifiers Sequence[str]
    List of hierarchical identifiers for the DLP dictionary.
    name str
    The name of the DLP dictionary. Must be unique.
    patterns Sequence[DlpDictionaryPatternInputArgs]
    List of DLP dictionary patterns with their match actions.
    phrases Sequence[DlpDictionaryPhraseInputArgs]
    List of DLP dictionary phrases with their match actions.
    proximity int
    The proximity length for dictionary matching. Specifies the distance between phrases/patterns for a match.
    proximity_enabled_for_custom_dictionary bool
    If true, proximity matching is enabled for this custom DLP dictionary.
    confidenceThreshold String
    The DLP confidence threshold. Valid values: CONFIDENCE_LEVEL_LOW, CONFIDENCE_LEVEL_MEDIUM, CONFIDENCE_LEVEL_HIGH.
    custom Boolean
    If true, this is a custom DLP dictionary; false indicates a predefined dictionary.
    customPhraseMatchType String
    The match type for custom phrases. Valid values: MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY, MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY.
    description String
    A description of the DLP dictionary.
    dictionaryType String
    The type of DLP dictionary. Valid values: PATTERNS_AND_PHRASES, EXACT_DATA_MATCH, INDEXED_DATA_MATCH.
    hierarchicalIdentifiers List<String>
    List of hierarchical identifiers for the DLP dictionary.
    name String
    The name of the DLP dictionary. Must be unique.
    patterns List<Property Map>
    List of DLP dictionary patterns with their match actions.
    phrases List<Property Map>
    List of DLP dictionary phrases with their match actions.
    proximity Number
    The proximity length for dictionary matching. Specifies the distance between phrases/patterns for a match.
    proximityEnabledForCustomDictionary Boolean
    If true, proximity matching is enabled for this custom DLP dictionary.

    Outputs

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

    DictionaryId int
    The system-generated ID of the DLP dictionary.
    Id string
    The provider-assigned unique ID for this managed resource.
    DictionaryId int
    The system-generated ID of the DLP dictionary.
    Id string
    The provider-assigned unique ID for this managed resource.
    dictionaryId Integer
    The system-generated ID of the DLP dictionary.
    id String
    The provider-assigned unique ID for this managed resource.
    dictionaryId number
    The system-generated ID of the DLP dictionary.
    id string
    The provider-assigned unique ID for this managed resource.
    dictionary_id int
    The system-generated ID of the DLP dictionary.
    id str
    The provider-assigned unique ID for this managed resource.
    dictionaryId Number
    The system-generated ID of the DLP dictionary.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DlpDictionaryPatternInput, DlpDictionaryPatternInputArgs

    Action string
    Pattern string
    Action string
    Pattern string
    action String
    pattern String
    action string
    pattern string
    action String
    pattern String

    DlpDictionaryPhraseInput, DlpDictionaryPhraseInputArgs

    Action string
    Phrase string
    Action string
    Phrase string
    action String
    phrase String
    action string
    phrase string
    action str
    phrase str
    action String
    phrase String

    Import

    An existing DLP Dictionary can be imported using its resource ID, e.g.

    $ pulumi import zia:index:DlpDictionary example 12345

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.