Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Sumologic Provider
  4. API Docs
  5. DataMaskRule
Viewing docs for sumologic 3.2.10
published on Thursday, Jul 23, 2026 by sumologic
Schema (JSON)
sumologic/terraform-provider-sumologic

sumologic.DataMaskRule

sumologic logo
Viewing docs for sumologic 3.2.10
published on Thursday, Jul 23, 2026 by sumologic
Schema (JSON)
sumologic/terraform-provider-sumologic

    Provides a Sumologic Data Mask Rule.

    Data mask rules allow you to define regex patterns for masking sensitive data in your search results at query time.

    Example Usage

    Basic rule

    import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";

const emailMask = new sumologic.DataMaskRule("email_mask", {
    name: "mask_email_addresses",
    regexPattern: "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}",
    maskString: "[EMAIL REDACTED]",
    enabled: true,
    description: "Masks email addresses in search results",
});

    import pulumi
import pulumi_sumologic as sumologic

email_mask = sumologic.DataMaskRule("email_mask",
    name="mask_email_addresses",
    regex_pattern="[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}",
    mask_string="[EMAIL REDACTED]",
    enabled=True,
    description="Masks email addresses in search results")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sumologic/v3/sumologic"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sumologic.NewDataMaskRule(ctx, "email_mask", &sumologic.DataMaskRuleArgs{
			Name:         pulumi.String("mask_email_addresses"),
			RegexPattern: pulumi.String("[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}"),
			MaskString:   pulumi.String("[EMAIL REDACTED]"),
			Enabled:      pulumi.Bool(true),
			Description:  pulumi.String("Masks email addresses in search results"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sumologic = Pulumi.Sumologic;

return await Deployment.RunAsync(() => 
{
    var emailMask = new Sumologic.DataMaskRule("email_mask", new()
    {
        Name = "mask_email_addresses",
        RegexPattern = "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}",
        MaskString = "[EMAIL REDACTED]",
        Enabled = true,
        Description = "Masks email addresses in search results",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.DataMaskRule;
import com.pulumi.sumologic.DataMaskRuleArgs;
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 emailMask = new DataMaskRule("emailMask", DataMaskRuleArgs.builder()
            .name("mask_email_addresses")
            .regexPattern("[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}")
            .maskString("[EMAIL REDACTED]")
            .enabled(true)
            .description("Masks email addresses in search results")
            .build());

    }
}

    resources:
  emailMask:
    type: sumologic:DataMaskRule
    name: email_mask
    properties:
      name: mask_email_addresses
      regexPattern: '[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}'
      maskString: '[EMAIL REDACTED]'
      enabled: true
      description: Masks email addresses in search results

    Example coming soon!

    Rule with default mask string

    import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";

const ipMask = new sumologic.DataMaskRule("ip_mask", {
    name: "mask_ip_addresses",
    regexPattern: "\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\b",
    enabled: true,
    description: "Masks IP addresses in search results",
});

    import pulumi
import pulumi_sumologic as sumologic

ip_mask = sumologic.DataMaskRule("ip_mask",
    name="mask_ip_addresses",
    regex_pattern="\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\b",
    enabled=True,
    description="Masks IP addresses in search results")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/sumologic/v3/sumologic"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sumologic.NewDataMaskRule(ctx, "ip_mask", &sumologic.DataMaskRuleArgs{
			Name:         pulumi.String("mask_ip_addresses"),
			RegexPattern: pulumi.String("\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\b"),
			Enabled:      pulumi.Bool(true),
			Description:  pulumi.String("Masks IP addresses in search results"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sumologic = Pulumi.Sumologic;

return await Deployment.RunAsync(() => 
{
    var ipMask = new Sumologic.DataMaskRule("ip_mask", new()
    {
        Name = "mask_ip_addresses",
        RegexPattern = "\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\b",
        Enabled = true,
        Description = "Masks IP addresses in search results",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.DataMaskRule;
import com.pulumi.sumologic.DataMaskRuleArgs;
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 ipMask = new DataMaskRule("ipMask", DataMaskRuleArgs.builder()
            .name("mask_ip_addresses")
            .regexPattern("\\b\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\b")
            .enabled(true)
            .description("Masks IP addresses in search results")
            .build());

    }
}

    resources:
  ipMask:
    type: sumologic:DataMaskRule
    name: ip_mask
    properties:
      name: mask_ip_addresses
      regexPattern: \b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b
      enabled: true
      description: Masks IP addresses in search results

    Example coming soon!

    Create DataMaskRule Resource

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

    Constructor syntax

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

@overload
def DataMaskRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 enabled: Optional[bool] = None,
                 regex_pattern: Optional[str] = None,
                 data_mask_rule_id: Optional[str] = None,
                 description: Optional[str] = None,
                 mask_string: Optional[str] = None,
                 name: Optional[str] = None)
    func NewDataMaskRule(ctx *Context, name string, args DataMaskRuleArgs, opts ...ResourceOption) (*DataMaskRule, error)
    public DataMaskRule(string name, DataMaskRuleArgs args, CustomResourceOptions? opts = null)
    public DataMaskRule(String name, DataMaskRuleArgs args)
public DataMaskRule(String name, DataMaskRuleArgs args, CustomResourceOptions options)

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


    resource "sumologic_data_mask_rule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DataMaskRuleArgs
    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 DataMaskRuleArgs
    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 DataMaskRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataMaskRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataMaskRuleArgs
    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 dataMaskRuleResource = new Sumologic.DataMaskRule("dataMaskRuleResource", new()
{
    Enabled = false,
    RegexPattern = "string",
    DataMaskRuleId = "string",
    Description = "string",
    MaskString = "string",
    Name = "string",
});

    example, err := sumologic.NewDataMaskRule(ctx, "dataMaskRuleResource", &sumologic.DataMaskRuleArgs{
	Enabled:        pulumi.Bool(false),
	RegexPattern:   pulumi.String("string"),
	DataMaskRuleId: pulumi.String("string"),
	Description:    pulumi.String("string"),
	MaskString:     pulumi.String("string"),
	Name:           pulumi.String("string"),
})

    resource "sumologic_data_mask_rule" "dataMaskRuleResource" {
  lifecycle {
    create_before_destroy = true
  }
  enabled           = false
  regex_pattern     = "string"
  data_mask_rule_id = "string"
  description       = "string"
  mask_string       = "string"
  name              = "string"
}

    var dataMaskRuleResource = new DataMaskRule("dataMaskRuleResource", DataMaskRuleArgs.builder()
    .enabled(false)
    .regexPattern("string")
    .dataMaskRuleId("string")
    .description("string")
    .maskString("string")
    .name("string")
    .build());

    data_mask_rule_resource = sumologic.DataMaskRule("dataMaskRuleResource",
    enabled=False,
    regex_pattern="string",
    data_mask_rule_id="string",
    description="string",
    mask_string="string",
    name="string")

    const dataMaskRuleResource = new sumologic.DataMaskRule("dataMaskRuleResource", {
    enabled: false,
    regexPattern: "string",
    dataMaskRuleId: "string",
    description: "string",
    maskString: "string",
    name: "string",
});

    type: sumologic:DataMaskRule
properties:
    dataMaskRuleId: string
    description: string
    enabled: false
    maskString: string
    name: string
    regexPattern: string

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

    Enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    RegexPattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    DataMaskRuleId string
    The unique identifier of the data mask rule.
    Description string
    A description of the rule. Maximum 512 characters.
    MaskString string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    Name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    Enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    RegexPattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    DataMaskRuleId string
    The unique identifier of the data mask rule.
    Description string
    A description of the rule. Maximum 512 characters.
    MaskString string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    Name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    regex_pattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    data_mask_rule_id string
    The unique identifier of the data mask rule.
    description string
    A description of the rule. Maximum 512 characters.
    mask_string string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    enabled Boolean
    Whether the rule is active. Only enabled rules are applied to search results.
    regexPattern String
    A valid regular expression pattern to match sensitive data that should be masked.
    dataMaskRuleId String
    The unique identifier of the data mask rule.
    description String
    A description of the rule. Maximum 512 characters.
    maskString String
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name String
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    enabled boolean
    Whether the rule is active. Only enabled rules are applied to search results.
    regexPattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    dataMaskRuleId string
    The unique identifier of the data mask rule.
    description string
    A description of the rule. Maximum 512 characters.
    maskString string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    regex_pattern str
    A valid regular expression pattern to match sensitive data that should be masked.
    data_mask_rule_id str
    The unique identifier of the data mask rule.
    description str
    A description of the rule. Maximum 512 characters.
    mask_string str
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name str
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    enabled Boolean
    Whether the rule is active. Only enabled rules are applied to search results.
    regexPattern String
    A valid regular expression pattern to match sensitive data that should be masked.
    dataMaskRuleId String
    The unique identifier of the data mask rule.
    description String
    A description of the rule. Maximum 512 characters.
    maskString String
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name String
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DataMaskRule Resource

    Get an existing DataMaskRule 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?: DataMaskRuleState, opts?: CustomResourceOptions): DataMaskRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_mask_rule_id: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        mask_string: Optional[str] = None,
        name: Optional[str] = None,
        regex_pattern: Optional[str] = None) -> DataMaskRule
    func GetDataMaskRule(ctx *Context, name string, id IDInput, state *DataMaskRuleState, opts ...ResourceOption) (*DataMaskRule, error)
    public static DataMaskRule Get(string name, Input<string> id, DataMaskRuleState? state, CustomResourceOptions? opts = null)
    public static DataMaskRule get(String name, Output<String> id, DataMaskRuleState state, CustomResourceOptions options)
    resources:  _:    type: sumologic:DataMaskRule    get:      id: ${id}
    import {
  to = sumologic_data_mask_rule.example
  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:
    DataMaskRuleId string
    The unique identifier of the data mask rule.
    Description string
    A description of the rule. Maximum 512 characters.
    Enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    MaskString string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    Name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    RegexPattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    DataMaskRuleId string
    The unique identifier of the data mask rule.
    Description string
    A description of the rule. Maximum 512 characters.
    Enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    MaskString string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    Name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    RegexPattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    data_mask_rule_id string
    The unique identifier of the data mask rule.
    description string
    A description of the rule. Maximum 512 characters.
    enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    mask_string string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    regex_pattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    dataMaskRuleId String
    The unique identifier of the data mask rule.
    description String
    A description of the rule. Maximum 512 characters.
    enabled Boolean
    Whether the rule is active. Only enabled rules are applied to search results.
    maskString String
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name String
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    regexPattern String
    A valid regular expression pattern to match sensitive data that should be masked.
    dataMaskRuleId string
    The unique identifier of the data mask rule.
    description string
    A description of the rule. Maximum 512 characters.
    enabled boolean
    Whether the rule is active. Only enabled rules are applied to search results.
    maskString string
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name string
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    regexPattern string
    A valid regular expression pattern to match sensitive data that should be masked.
    data_mask_rule_id str
    The unique identifier of the data mask rule.
    description str
    A description of the rule. Maximum 512 characters.
    enabled bool
    Whether the rule is active. Only enabled rules are applied to search results.
    mask_string str
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name str
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    regex_pattern str
    A valid regular expression pattern to match sensitive data that should be masked.
    dataMaskRuleId String
    The unique identifier of the data mask rule.
    description String
    A description of the rule. Maximum 512 characters.
    enabled Boolean
    Whether the rule is active. Only enabled rules are applied to search results.
    maskString String
    The replacement string to use when masking matched data. Must be between 1 and 64 characters. Defaults to ##redactedPII##.
    name String
    The name of the data mask rule. Must be between 1 and 128 characters. Cannot be changed after creation.
    regexPattern String
    A valid regular expression pattern to match sensitive data that should be masked.

    Import

    Data mask rules can be imported using the rule ID.

    hcl

    $ pulumi import sumologic:index/dataMaskRule:DataMaskRule example 000000000ABC1234

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

    Package Details

    Repository
    Sumo Logic sumologic/terraform-provider-sumologic
    License
    Notes
    This Pulumi package is based on the sumologic Terraform Provider.
    sumologic logo
    Viewing docs for sumologic 3.2.10
    published on Thursday, Jul 23, 2026 by sumologic
    Schema (JSON)
    sumologic/terraform-provider-sumologic

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial