1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CloudGuard
  5. getDataMaskRule
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.CloudGuard.getDataMaskRule

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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/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 GetDataMaskRule(ctx *Context, args *GetDataMaskRuleArgs, opts ...InvokeOption) (*GetDataMaskRuleResult, error)
    func GetDataMaskRuleOutput(ctx *Context, args *GetDataMaskRuleOutputArgs, opts ...InvokeOption) GetDataMaskRuleResultOutput

    > Note: This function is named GetDataMaskRule 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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:CloudGuard/getDataMaskRule:getDataMaskRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DataMaskRuleId string
    OCID of the data mask rule
    DataMaskRuleId string
    OCID of the data mask rule
    dataMaskRuleId String
    OCID of the data mask rule
    dataMaskRuleId string
    OCID of the data mask rule
    data_mask_rule_id str
    OCID of the data mask rule
    dataMaskRuleId String
    OCID of the data mask rule

    getDataMaskRule Result

    The following output properties are available:

    CompartmentId string
    Compartment OCID where the resource is created
    DataMaskCategories List<string>
    List of data mask rule categories
    DataMaskRuleId string
    DataMaskRuleStatus string
    The current status of the data mask rule
    DefinedTags Dictionary<string, object>
    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
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IamGroupId string
    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
    SystemTags Dictionary<string, object>
    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<GetDataMaskRuleTargetSelected>
    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
    DataMaskCategories []string
    List of data mask rule categories
    DataMaskRuleId string
    DataMaskRuleStatus string
    The current status of the data mask rule
    DefinedTags map[string]interface{}
    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
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    IamGroupId string
    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
    SystemTags map[string]interface{}
    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 []GetDataMaskRuleTargetSelected
    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
    dataMaskCategories List<String>
    List of data mask rule categories
    dataMaskRuleId String
    dataMaskRuleStatus String
    The current status of the data mask rule
    definedTags Map<String,Object>
    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
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    iamGroupId String
    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
    systemTags Map<String,Object>
    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<GetDataMaskRuleTargetSelected>
    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
    dataMaskCategories string[]
    List of data mask rule categories
    dataMaskRuleId string
    dataMaskRuleStatus string
    The current status of the data mask rule
    definedTags {[key: string]: any}
    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
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    iamGroupId string
    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
    systemTags {[key: string]: any}
    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 GetDataMaskRuleTargetSelected[]
    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_categories Sequence[str]
    List of data mask rule categories
    data_mask_rule_id str
    data_mask_rule_status str
    The current status of the data mask rule
    defined_tags Mapping[str, Any]
    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
    freeform_tags Mapping[str, Any]
    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_id str
    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
    system_tags Mapping[str, Any]
    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[cloudguard.GetDataMaskRuleTargetSelected]
    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
    dataMaskCategories List<String>
    List of data mask rule categories
    dataMaskRuleId String
    dataMaskRuleStatus String
    The current status of the data mask rule
    definedTags Map<Any>
    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
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    iamGroupId String
    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
    systemTags Map<Any>
    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

    Kind string
    Kind of target selection to be used
    Values List<string>
    Types of targets
    Kind string
    Kind of target selection to be used
    Values []string
    Types of targets
    kind String
    Kind of target selection to be used
    values List<String>
    Types of targets
    kind string
    Kind of target selection to be used
    values string[]
    Types of targets
    kind str
    Kind of target selection to be used
    values Sequence[str]
    Types of targets
    kind String
    Kind of target selection to be used
    values List<String>
    Types of targets

    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 v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi