Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CloudGuard
  5. DataMaskRule
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.CloudGuard.DataMaskRule

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Data Mask Rule resource in Oracle Cloud Infrastructure Cloud Guard service.

    Creates a new DataMaskRule resource definition.

    Example Usage

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

const testDataMaskRule = new oci.cloudguard.DataMaskRule("test_data_mask_rule", {
    compartmentId: compartmentId,
    dataMaskCategories: dataMaskRuleDataMaskCategories,
    displayName: dataMaskRuleDisplayName,
    iamGroupId: testGroup.id,
    targetSelected: {
        kind: dataMaskRuleTargetSelectedKind,
        values: dataMaskRuleTargetSelectedValues,
    },
    dataMaskRuleStatus: dataMaskRuleDataMaskRuleStatus,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    description: dataMaskRuleDescription,
    freeformTags: {
        "bar-key": "value",
    },
    state: dataMaskRuleState,
});

    import pulumi
import pulumi_oci as oci

test_data_mask_rule = oci.cloud_guard.DataMaskRule("test_data_mask_rule",
    compartment_id=compartment_id,
    data_mask_categories=data_mask_rule_data_mask_categories,
    display_name=data_mask_rule_display_name,
    iam_group_id=test_group["id"],
    target_selected={
        "kind": data_mask_rule_target_selected_kind,
        "values": data_mask_rule_target_selected_values,
    },
    data_mask_rule_status=data_mask_rule_data_mask_rule_status,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    description=data_mask_rule_description,
    freeform_tags={
        "bar-key": "value",
    },
    state=data_mask_rule_state)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/cloudguard"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudguard.NewDataMaskRule(ctx, "test_data_mask_rule", &cloudguard.DataMaskRuleArgs{
			CompartmentId:      pulumi.Any(compartmentId),
			DataMaskCategories: pulumi.Any(dataMaskRuleDataMaskCategories),
			DisplayName:        pulumi.Any(dataMaskRuleDisplayName),
			IamGroupId:         pulumi.Any(testGroup.Id),
			TargetSelected: &cloudguard.DataMaskRuleTargetSelectedArgs{
				Kind:   pulumi.Any(dataMaskRuleTargetSelectedKind),
				Values: pulumi.Any(dataMaskRuleTargetSelectedValues),
			},
			DataMaskRuleStatus: pulumi.Any(dataMaskRuleDataMaskRuleStatus),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			Description: pulumi.Any(dataMaskRuleDescription),
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			State: pulumi.Any(dataMaskRuleState),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDataMaskRule = new Oci.CloudGuard.DataMaskRule("test_data_mask_rule", new()
    {
        CompartmentId = compartmentId,
        DataMaskCategories = dataMaskRuleDataMaskCategories,
        DisplayName = dataMaskRuleDisplayName,
        IamGroupId = testGroup.Id,
        TargetSelected = new Oci.CloudGuard.Inputs.DataMaskRuleTargetSelectedArgs
        {
            Kind = dataMaskRuleTargetSelectedKind,
            Values = dataMaskRuleTargetSelectedValues,
        },
        DataMaskRuleStatus = dataMaskRuleDataMaskRuleStatus,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        Description = dataMaskRuleDescription,
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        State = dataMaskRuleState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudGuard.DataMaskRule;
import com.pulumi.oci.CloudGuard.DataMaskRuleArgs;
import com.pulumi.oci.CloudGuard.inputs.DataMaskRuleTargetSelectedArgs;
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 testDataMaskRule = new DataMaskRule("testDataMaskRule", DataMaskRuleArgs.builder()
            .compartmentId(compartmentId)
            .dataMaskCategories(dataMaskRuleDataMaskCategories)
            .displayName(dataMaskRuleDisplayName)
            .iamGroupId(testGroup.id())
            .targetSelected(DataMaskRuleTargetSelectedArgs.builder()
                .kind(dataMaskRuleTargetSelectedKind)
                .values(dataMaskRuleTargetSelectedValues)
                .build())
            .dataMaskRuleStatus(dataMaskRuleDataMaskRuleStatus)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .description(dataMaskRuleDescription)
            .freeformTags(Map.of("bar-key", "value"))
            .state(dataMaskRuleState)
            .build());

    }
}

    resources:
  testDataMaskRule:
    type: oci:CloudGuard:DataMaskRule
    name: test_data_mask_rule
    properties:
      compartmentId: ${compartmentId}
      dataMaskCategories: ${dataMaskRuleDataMaskCategories}
      displayName: ${dataMaskRuleDisplayName}
      iamGroupId: ${testGroup.id}
      targetSelected:
        kind: ${dataMaskRuleTargetSelectedKind}
        values: ${dataMaskRuleTargetSelectedValues}
      dataMaskRuleStatus: ${dataMaskRuleDataMaskRuleStatus}
      definedTags:
        foo-namespace.bar-key: value
      description: ${dataMaskRuleDescription}
      freeformTags:
        bar-key: value
      state: ${dataMaskRuleState}

    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,
                 compartment_id: Optional[str] = None,
                 data_mask_categories: Optional[Sequence[str]] = None,
                 display_name: Optional[str] = None,
                 iam_group_id: Optional[str] = None,
                 target_selected: Optional[DataMaskRuleTargetSelectedArgs] = None,
                 data_mask_rule_status: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, str]] = None,
                 description: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, str]] = None,
                 state: 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: oci:CloudGuard:DataMaskRule
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 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 Oci.CloudGuard.DataMaskRule("dataMaskRuleResource", new()
{
    CompartmentId = "string",
    DataMaskCategories = new[]
    {
        "string",
    },
    DisplayName = "string",
    IamGroupId = "string",
    TargetSelected = new Oci.CloudGuard.Inputs.DataMaskRuleTargetSelectedArgs
    {
        Kind = "string",
        Values = new[]
        {
            "string",
        },
    },
    DataMaskRuleStatus = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    State = "string",
});

    example, err := cloudguard.NewDataMaskRule(ctx, "dataMaskRuleResource", &cloudguard.DataMaskRuleArgs{
	CompartmentId: pulumi.String("string"),
	DataMaskCategories: pulumi.StringArray{
		pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	IamGroupId:  pulumi.String("string"),
	TargetSelected: &cloudguard.DataMaskRuleTargetSelectedArgs{
		Kind: pulumi.String("string"),
		Values: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	DataMaskRuleStatus: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	State: pulumi.String("string"),
})

    var dataMaskRuleResource = new DataMaskRule("dataMaskRuleResource", DataMaskRuleArgs.builder()
    .compartmentId("string")
    .dataMaskCategories("string")
    .displayName("string")
    .iamGroupId("string")
    .targetSelected(DataMaskRuleTargetSelectedArgs.builder()
        .kind("string")
        .values("string")
        .build())
    .dataMaskRuleStatus("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .state("string")
    .build());

    data_mask_rule_resource = oci.cloud_guard.DataMaskRule("dataMaskRuleResource",
    compartment_id="string",
    data_mask_categories=["string"],
    display_name="string",
    iam_group_id="string",
    target_selected={
        "kind": "string",
        "values": ["string"],
    },
    data_mask_rule_status="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    state="string")

    const dataMaskRuleResource = new oci.cloudguard.DataMaskRule("dataMaskRuleResource", {
    compartmentId: "string",
    dataMaskCategories: ["string"],
    displayName: "string",
    iamGroupId: "string",
    targetSelected: {
        kind: "string",
        values: ["string"],
    },
    dataMaskRuleStatus: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    state: "string",
});

    type: oci:CloudGuard:DataMaskRule
properties:
    compartmentId: string
    dataMaskCategories:
        - string
    dataMaskRuleStatus: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    iamGroupId: string
    state: string
    targetSelected:
        kind: string
        values:
            - 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:

    CompartmentId string
    (Updatable) Compartment OCID where the resource is created
    DataMaskCategories List<string>
    (Updatable) Data mask rule categories
    DisplayName string

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    IamGroupId string
    (Updatable) IAM group ID associated with the data mask rule
    TargetSelected DataMaskRuleTargetSelected
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    DataMaskRuleStatus string
    (Updatable) The current status of the data mask rule
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The data mask rule description Avoid entering confidential information.
    FreeformTags Dictionary<string, string>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    State string
    The current lifecycle state of the data mask rule
    CompartmentId string
    (Updatable) Compartment OCID where the resource is created
    DataMaskCategories []string
    (Updatable) Data mask rule categories
    DisplayName string

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    IamGroupId string
    (Updatable) IAM group ID associated with the data mask rule
    TargetSelected DataMaskRuleTargetSelectedArgs
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    DataMaskRuleStatus string
    (Updatable) The current status of the data mask rule
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The data mask rule description Avoid entering confidential information.
    FreeformTags map[string]string

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    State string
    The current lifecycle state of the data mask rule
    compartmentId String
    (Updatable) Compartment OCID where the resource is created
    dataMaskCategories List<String>
    (Updatable) Data mask rule categories
    displayName String

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    iamGroupId String
    (Updatable) IAM group ID associated with the data mask rule
    targetSelected DataMaskRuleTargetSelected
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    dataMaskRuleStatus String
    (Updatable) The current status of the data mask rule
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The data mask rule description Avoid entering confidential information.
    freeformTags Map<String,String>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    state String
    The current lifecycle state of the data mask rule
    compartmentId string
    (Updatable) Compartment OCID where the resource is created
    dataMaskCategories string[]
    (Updatable) Data mask rule categories
    displayName string

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    iamGroupId string
    (Updatable) IAM group ID associated with the data mask rule
    targetSelected DataMaskRuleTargetSelected
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    dataMaskRuleStatus string
    (Updatable) The current status of the data mask rule
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    The data mask rule description Avoid entering confidential information.
    freeformTags {[key: string]: string}

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    state string
    The current lifecycle state of the data mask rule
    compartment_id str
    (Updatable) Compartment OCID where the resource is created
    data_mask_categories Sequence[str]
    (Updatable) Data mask rule categories
    display_name str

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    iam_group_id str
    (Updatable) IAM group ID associated with the data mask rule
    target_selected DataMaskRuleTargetSelectedArgs
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    data_mask_rule_status str
    (Updatable) The current status of the data mask rule
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    The data mask rule description Avoid entering confidential information.
    freeform_tags Mapping[str, str]

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    state str
    The current lifecycle state of the data mask rule
    compartmentId String
    (Updatable) Compartment OCID where the resource is created
    dataMaskCategories List<String>
    (Updatable) Data mask rule categories
    displayName String

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    iamGroupId String
    (Updatable) IAM group ID associated with the data mask rule
    targetSelected Property Map
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    dataMaskRuleStatus String
    (Updatable) The current status of the data mask rule
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The data mask rule description Avoid entering confidential information.
    freeformTags Map<String>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    state String
    The current lifecycle state of the data mask rule

    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.
    LifecyleDetails string
    Additional details on the substate of the lifecycle state [DEPRECATE]
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the target was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the target was updated. Format defined by RFC3339.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecyleDetails string
    Additional details on the substate of the lifecycle state [DEPRECATE]
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the target was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the target was updated. Format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecyleDetails String
    Additional details on the substate of the lifecycle state [DEPRECATE]
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the target was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the target was updated. Format defined by RFC3339.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecyleDetails string
    Additional details on the substate of the lifecycle state [DEPRECATE]
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the target was created. Format defined by RFC3339.
    timeUpdated string
    The date and time the target was updated. Format defined by RFC3339.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecyle_details str
    Additional details on the substate of the lifecycle state [DEPRECATE]
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the target was created. Format defined by RFC3339.
    time_updated str
    The date and time the target was updated. Format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecyleDetails String
    Additional details on the substate of the lifecycle state [DEPRECATE]
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the target was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the target was updated. Format defined by RFC3339.

    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,
        compartment_id: Optional[str] = None,
        data_mask_categories: Optional[Sequence[str]] = None,
        data_mask_rule_status: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        iam_group_id: Optional[str] = None,
        lifecyle_details: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        target_selected: Optional[DataMaskRuleTargetSelectedArgs] = None,
        time_created: Optional[str] = None,
        time_updated: 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: oci:CloudGuard:DataMaskRule    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:
    CompartmentId string
    (Updatable) Compartment OCID where the resource is created
    DataMaskCategories List<string>
    (Updatable) Data mask rule categories
    DataMaskRuleStatus string
    (Updatable) The current status of the data mask rule
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The data mask rule description Avoid entering confidential information.
    DisplayName string

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    FreeformTags Dictionary<string, string>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    IamGroupId string
    (Updatable) IAM group ID associated with the data mask rule
    LifecyleDetails string
    Additional details on the substate of the lifecycle state [DEPRECATE]
    State string
    The current lifecycle state of the data mask rule
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetSelected DataMaskRuleTargetSelected
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    TimeCreated string
    The date and time the target was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the target was updated. Format defined by RFC3339.
    CompartmentId string
    (Updatable) Compartment OCID where the resource is created
    DataMaskCategories []string
    (Updatable) Data mask rule categories
    DataMaskRuleStatus string
    (Updatable) The current status of the data mask rule
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    The data mask rule description Avoid entering confidential information.
    DisplayName string

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    FreeformTags map[string]string

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    IamGroupId string
    (Updatable) IAM group ID associated with the data mask rule
    LifecyleDetails string
    Additional details on the substate of the lifecycle state [DEPRECATE]
    State string
    The current lifecycle state of the data mask rule
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetSelected DataMaskRuleTargetSelectedArgs
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    TimeCreated string
    The date and time the target was created. Format defined by RFC3339.
    TimeUpdated string
    The date and time the target was updated. Format defined by RFC3339.
    compartmentId String
    (Updatable) Compartment OCID where the resource is created
    dataMaskCategories List<String>
    (Updatable) Data mask rule categories
    dataMaskRuleStatus String
    (Updatable) The current status of the data mask rule
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The data mask rule description Avoid entering confidential information.
    displayName String

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    freeformTags Map<String,String>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    iamGroupId String
    (Updatable) IAM group ID associated with the data mask rule
    lifecyleDetails String
    Additional details on the substate of the lifecycle state [DEPRECATE]
    state String
    The current lifecycle state of the data mask rule
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetSelected DataMaskRuleTargetSelected
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    timeCreated String
    The date and time the target was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the target was updated. Format defined by RFC3339.
    compartmentId string
    (Updatable) Compartment OCID where the resource is created
    dataMaskCategories string[]
    (Updatable) Data mask rule categories
    dataMaskRuleStatus string
    (Updatable) The current status of the data mask rule
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    The data mask rule description Avoid entering confidential information.
    displayName string

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    freeformTags {[key: string]: string}

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    iamGroupId string
    (Updatable) IAM group ID associated with the data mask rule
    lifecyleDetails string
    Additional details on the substate of the lifecycle state [DEPRECATE]
    state string
    The current lifecycle state of the data mask rule
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetSelected DataMaskRuleTargetSelected
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    timeCreated string
    The date and time the target was created. Format defined by RFC3339.
    timeUpdated string
    The date and time the target was updated. Format defined by RFC3339.
    compartment_id str
    (Updatable) Compartment OCID where the resource is created
    data_mask_categories Sequence[str]
    (Updatable) Data mask rule categories
    data_mask_rule_status str
    (Updatable) The current status of the data mask rule
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    The data mask rule description Avoid entering confidential information.
    display_name str

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    freeform_tags Mapping[str, str]

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    iam_group_id str
    (Updatable) IAM group ID associated with the data mask rule
    lifecyle_details str
    Additional details on the substate of the lifecycle state [DEPRECATE]
    state str
    The current lifecycle state of the data mask rule
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    target_selected DataMaskRuleTargetSelectedArgs
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    time_created str
    The date and time the target was created. Format defined by RFC3339.
    time_updated str
    The date and time the target was updated. Format defined by RFC3339.
    compartmentId String
    (Updatable) Compartment OCID where the resource is created
    dataMaskCategories List<String>
    (Updatable) Data mask rule categories
    dataMaskRuleStatus String
    (Updatable) The current status of the data mask rule
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    The data mask rule description Avoid entering confidential information.
    displayName String

    (Updatable) Data mask rule display name

    Avoid entering confidential information.

    freeformTags Map<String>

    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

    Avoid entering confidential information.

    iamGroupId String
    (Updatable) IAM group ID associated with the data mask rule
    lifecyleDetails String
    Additional details on the substate of the lifecycle state [DEPRECATE]
    state String
    The current lifecycle state of the data mask rule
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetSelected Property Map
    (Updatable) Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).
    timeCreated String
    The date and time the target was created. Format defined by RFC3339.
    timeUpdated String
    The date and time the target was updated. Format defined by RFC3339.

    Supporting Types

    DataMaskRuleTargetSelected, DataMaskRuleTargetSelectedArgs

    Kind string
    (Updatable) Kind of target selection to be used
    Values List<string>

    (Updatable) Types of targets

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Kind string
    (Updatable) Kind of target selection to be used
    Values []string

    (Updatable) Types of targets

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    kind String
    (Updatable) Kind of target selection to be used
    values List<String>

    (Updatable) Types of targets

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    kind string
    (Updatable) Kind of target selection to be used
    values string[]

    (Updatable) Types of targets

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    kind str
    (Updatable) Kind of target selection to be used
    values Sequence[str]

    (Updatable) Types of targets

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    kind String
    (Updatable) Kind of target selection to be used
    values List<String>

    (Updatable) Types of targets

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Import

    DataMaskRules can be imported using the id, e.g.

    $ pulumi import oci:CloudGuard/dataMaskRule:DataMaskRule test_data_mask_rule "id"

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci