Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.CloudGuard.getDataMaskRule
Explore with Pulumi AI
This data source provides details about a specific Data Mask Rule resource in Oracle Cloud Infrastructure Cloud Guard service.
Returns a DataMaskRule resource, identified by dataMaskRuleId.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testDataMaskRule = oci.CloudGuard.getDataMaskRule({
    dataMaskRuleId: testDataMaskRuleOciCloudGuardDataMaskRule.id,
});
import pulumi
import pulumi_oci as oci
test_data_mask_rule = oci.CloudGuard.get_data_mask_rule(data_mask_rule_id=test_data_mask_rule_oci_cloud_guard_data_mask_rule["id"])
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.GetDataMaskRule(ctx, &cloudguard.GetDataMaskRuleArgs{
			DataMaskRuleId: testDataMaskRuleOciCloudGuardDataMaskRule.Id,
		}, nil)
		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 = Oci.CloudGuard.GetDataMaskRule.Invoke(new()
    {
        DataMaskRuleId = testDataMaskRuleOciCloudGuardDataMaskRule.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudGuard.CloudGuardFunctions;
import com.pulumi.oci.CloudGuard.inputs.GetDataMaskRuleArgs;
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) {
        final var testDataMaskRule = CloudGuardFunctions.getDataMaskRule(GetDataMaskRuleArgs.builder()
            .dataMaskRuleId(testDataMaskRuleOciCloudGuardDataMaskRule.id())
            .build());
    }
}
variables:
  testDataMaskRule:
    fn::invoke:
      function: oci:CloudGuard:getDataMaskRule
      arguments:
        dataMaskRuleId: ${testDataMaskRuleOciCloudGuardDataMaskRule.id}
Using getDataMaskRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDataMaskRule(args: GetDataMaskRuleArgs, opts?: InvokeOptions): Promise<GetDataMaskRuleResult>
function getDataMaskRuleOutput(args: GetDataMaskRuleOutputArgs, opts?: InvokeOptions): Output<GetDataMaskRuleResult>def get_data_mask_rule(data_mask_rule_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDataMaskRuleResult
def get_data_mask_rule_output(data_mask_rule_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDataMaskRuleResult]func LookupDataMaskRule(ctx *Context, args *LookupDataMaskRuleArgs, opts ...InvokeOption) (*LookupDataMaskRuleResult, error)
func LookupDataMaskRuleOutput(ctx *Context, args *LookupDataMaskRuleOutputArgs, opts ...InvokeOption) LookupDataMaskRuleResultOutput> Note: This function is named LookupDataMaskRule in the Go SDK.
public static class GetDataMaskRule 
{
    public static Task<GetDataMaskRuleResult> InvokeAsync(GetDataMaskRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetDataMaskRuleResult> Invoke(GetDataMaskRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDataMaskRuleResult> getDataMaskRule(GetDataMaskRuleArgs args, InvokeOptions options)
public static Output<GetDataMaskRuleResult> getDataMaskRule(GetDataMaskRuleArgs args, InvokeOptions options)
fn::invoke:
  function: oci:CloudGuard/getDataMaskRule:getDataMaskRule
  arguments:
    # arguments dictionaryThe following arguments are supported:
- DataMask stringRule Id 
- OCID of the data mask rule
- DataMask stringRule Id 
- OCID of the data mask rule
- dataMask StringRule Id 
- OCID of the data mask rule
- dataMask stringRule Id 
- OCID of the data mask rule
- data_mask_ strrule_ id 
- OCID of the data mask rule
- dataMask StringRule Id 
- OCID of the data mask rule
getDataMaskRule Result
The following output properties are available:
- CompartmentId string
- Compartment OCID where the resource is created
- DataMask List<string>Categories 
- List of data mask rule categories
- DataMask stringRule Id 
- DataMask stringRule Status 
- The current status of the data mask rule
- Dictionary<string, string>
- 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
- DisplayName string
- Data mask rule display name
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- IamGroup stringId 
- IAM Group ID associated with the data mask rule
- Id string
- Unique identifier that can't be changed after creation
- LifecyleDetails string
- Additional details on the substate of the lifecycle state [DEPRECATE]
- State string
- The current lifecycle state of the data mask rule
- 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"}
- TargetSelecteds List<GetData Mask Rule Target Selected> 
- 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
- Compartment OCID where the resource is created
- DataMask []stringCategories 
- List of data mask rule categories
- DataMask stringRule Id 
- DataMask stringRule Status 
- The current status of the data mask rule
- map[string]string
- 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
- DisplayName string
- Data mask rule display name
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- IamGroup stringId 
- IAM Group ID associated with the data mask rule
- Id string
- Unique identifier that can't be changed after creation
- LifecyleDetails string
- Additional details on the substate of the lifecycle state [DEPRECATE]
- State string
- The current lifecycle state of the data mask rule
- 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"}
- TargetSelecteds []GetData Mask Rule Target Selected 
- 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
- Compartment OCID where the resource is created
- dataMask List<String>Categories 
- List of data mask rule categories
- dataMask StringRule Id 
- dataMask StringRule Status 
- The current status of the data mask rule
- Map<String,String>
- 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
- displayName String
- Data mask rule display name
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- iamGroup StringId 
- IAM Group ID associated with the data mask rule
- id String
- Unique identifier that can't be changed after creation
- lifecyleDetails String
- Additional details on the substate of the lifecycle state [DEPRECATE]
- state String
- The current lifecycle state of the data mask rule
- 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"}
- targetSelecteds List<GetData Mask Rule Target Selected> 
- 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
- Compartment OCID where the resource is created
- dataMask string[]Categories 
- List of data mask rule categories
- dataMask stringRule Id 
- dataMask stringRule Status 
- The current status of the data mask rule
- {[key: string]: string}
- 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
- displayName string
- Data mask rule display name
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- iamGroup stringId 
- IAM Group ID associated with the data mask rule
- id string
- Unique identifier that can't be changed after creation
- lifecyleDetails string
- Additional details on the substate of the lifecycle state [DEPRECATE]
- state string
- The current lifecycle state of the data mask rule
- {[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"}
- targetSelecteds GetData Mask Rule Target Selected[] 
- 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
- Compartment OCID where the resource is created
- data_mask_ Sequence[str]categories 
- List of data mask rule categories
- data_mask_ strrule_ id 
- data_mask_ strrule_ status 
- The current status of the data mask rule
- Mapping[str, str]
- 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
- display_name str
- Data mask rule display name
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- iam_group_ strid 
- IAM Group ID associated with the data mask rule
- id str
- Unique identifier that can't be changed after creation
- lifecyle_details str
- Additional details on the substate of the lifecycle state [DEPRECATE]
- state str
- The current lifecycle state of the data mask rule
- 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_selecteds Sequence[GetData Mask Rule Target Selected] 
- 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
- Compartment OCID where the resource is created
- dataMask List<String>Categories 
- List of data mask rule categories
- dataMask StringRule Id 
- dataMask StringRule Status 
- The current status of the data mask rule
- Map<String>
- 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
- displayName String
- Data mask rule display name
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- iamGroup StringId 
- IAM Group ID associated with the data mask rule
- id String
- Unique identifier that can't be changed after creation
- lifecyleDetails String
- Additional details on the substate of the lifecycle state [DEPRECATE]
- state String
- The current lifecycle state of the data mask rule
- 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"}
- targetSelecteds List<Property Map>
- 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
GetDataMaskRuleTargetSelected     
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.