Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.DataSafe.getMaskingPolicy

This data source provides details about a specific Masking Policy resource in Oracle Cloud Infrastructure Data Safe service.

Gets the details of the specified masking policy.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testMaskingPolicy = Oci.DataSafe.GetMaskingPolicy.Invoke(new()
    {
        MaskingPolicyId = oci_data_safe_masking_policy.Test_masking_policy.Id,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.GetMaskingPolicy(ctx, &datasafe.GetMaskingPolicyArgs{
			MaskingPolicyId: oci_data_safe_masking_policy.Test_masking_policy.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeFunctions;
import com.pulumi.oci.DataSafe.inputs.GetMaskingPolicyArgs;
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 testMaskingPolicy = DataSafeFunctions.getMaskingPolicy(GetMaskingPolicyArgs.builder()
            .maskingPolicyId(oci_data_safe_masking_policy.test_masking_policy().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_masking_policy = oci.DataSafe.get_masking_policy(masking_policy_id=oci_data_safe_masking_policy["test_masking_policy"]["id"])

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

const testMaskingPolicy = oci.DataSafe.getMaskingPolicy({
    maskingPolicyId: oci_data_safe_masking_policy.test_masking_policy.id,
});

variables:
  testMaskingPolicy:
    fn::invoke:
      Function: oci:DataSafe:getMaskingPolicy
      Arguments:
        maskingPolicyId: ${oci_data_safe_masking_policy.test_masking_policy.id}

Using getMaskingPolicy

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 getMaskingPolicy(args: GetMaskingPolicyArgs, opts?: InvokeOptions): Promise<GetMaskingPolicyResult>
function getMaskingPolicyOutput(args: GetMaskingPolicyOutputArgs, opts?: InvokeOptions): Output<GetMaskingPolicyResult>

def get_masking_policy(masking_policy_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetMaskingPolicyResult
def get_masking_policy_output(masking_policy_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetMaskingPolicyResult]

func GetMaskingPolicy(ctx *Context, args *GetMaskingPolicyArgs, opts ...InvokeOption) (*GetMaskingPolicyResult, error)
func GetMaskingPolicyOutput(ctx *Context, args *GetMaskingPolicyOutputArgs, opts ...InvokeOption) GetMaskingPolicyResultOutput

> Note: This function is named GetMaskingPolicy in the Go SDK.

public static class GetMaskingPolicy 
{
    public static Task<GetMaskingPolicyResult> InvokeAsync(GetMaskingPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetMaskingPolicyResult> Invoke(GetMaskingPolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMaskingPolicyResult> getMaskingPolicy(GetMaskingPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DataSafe/getMaskingPolicy:getMaskingPolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

MaskingPolicyId string: The OCID of the masking policy.

MaskingPolicyId string: The OCID of the masking policy.

maskingPolicyId String: The OCID of the masking policy.

maskingPolicyId string: The OCID of the masking policy.

masking_policy_id str: The OCID of the masking policy.

maskingPolicyId String: The OCID of the masking policy.

getMaskingPolicy Result

The following output properties are available:

AddMaskingColumnsFromSdmTrigger int
ColumnSources List<GetMaskingPolicyColumnSource>: The source of masking columns.
CompartmentId string: The OCID of the compartment that contains the masking policy.
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string: The description of the masking policy.
DisplayName string: The display name of the masking policy.
FreeformTags Dictionary<string, object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
Id string: The OCID of the masking policy.
IsDropTempTablesEnabled bool: Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.
IsRedoLoggingEnabled bool: Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.
IsRefreshStatsEnabled bool: Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.
MaskingPolicyId string
ParallelDegree string: Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUsi and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
PostMaskingScript string: A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.
PreMaskingScript string: A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.
Recompile string: Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used.
State string: The current state of the masking policy.
TimeCreated string: The date and time the masking policy was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the masking policy was last updated, in the format defined by RFC3339

AddMaskingColumnsFromSdmTrigger int
ColumnSources []GetMaskingPolicyColumnSource: The source of masking columns.
CompartmentId string: The OCID of the compartment that contains the masking policy.
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
Description string: The description of the masking policy.
DisplayName string: The display name of the masking policy.
FreeformTags map[string]interface{}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
Id string: The OCID of the masking policy.
IsDropTempTablesEnabled bool: Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.
IsRedoLoggingEnabled bool: Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.
IsRefreshStatsEnabled bool: Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.
MaskingPolicyId string
ParallelDegree string: Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUsi and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
PostMaskingScript string: A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.
PreMaskingScript string: A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.
Recompile string: Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used.
State string: The current state of the masking policy.
TimeCreated string: The date and time the masking policy was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the masking policy was last updated, in the format defined by RFC3339

addMaskingColumnsFromSdmTrigger Integer
columnSources List<GetMaskingPolicyColumnSource>: The source of masking columns.
compartmentId String: The OCID of the compartment that contains the masking policy.
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String: The description of the masking policy.
displayName String: The display name of the masking policy.
freeformTags Map<String,Object>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id String: The OCID of the masking policy.
isDropTempTablesEnabled Boolean: Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.
isRedoLoggingEnabled Boolean: Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.
isRefreshStatsEnabled Boolean: Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.
maskingPolicyId String
parallelDegree String: Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUsi and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
postMaskingScript String: A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.
preMaskingScript String: A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.
recompile String: Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used.
state String: The current state of the masking policy.
timeCreated String: The date and time the masking policy was created, in the format defined by RFC3339.
timeUpdated String: The date and time the masking policy was last updated, in the format defined by RFC3339

addMaskingColumnsFromSdmTrigger number
columnSources GetMaskingPolicyColumnSource[]: The source of masking columns.
compartmentId string: The OCID of the compartment that contains the masking policy.
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description string: The description of the masking policy.
displayName string: The display name of the masking policy.
freeformTags {[key: string]: any}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id string: The OCID of the masking policy.
isDropTempTablesEnabled boolean: Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.
isRedoLoggingEnabled boolean: Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.
isRefreshStatsEnabled boolean: Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.
maskingPolicyId string
parallelDegree string: Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUsi and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
postMaskingScript string: A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.
preMaskingScript string: A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.
recompile string: Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used.
state string: The current state of the masking policy.
timeCreated string: The date and time the masking policy was created, in the format defined by RFC3339.
timeUpdated string: The date and time the masking policy was last updated, in the format defined by RFC3339

add_masking_columns_from_sdm_trigger int
column_sources GetMaskingPolicyColumnSource]: The source of masking columns.
compartment_id str: The OCID of the compartment that contains the masking policy.
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description str: The description of the masking policy.
display_name str: The display name of the masking policy.
freeform_tags Mapping[str, Any]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id str: The OCID of the masking policy.
is_drop_temp_tables_enabled bool: Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.
is_redo_logging_enabled bool: Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.
is_refresh_stats_enabled bool: Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.
masking_policy_id str
parallel_degree str: Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUsi and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
post_masking_script str: A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.
pre_masking_script str: A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.
recompile str: Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used.
state str: The current state of the masking policy.
time_created str: The date and time the masking policy was created, in the format defined by RFC3339.
time_updated str: The date and time the masking policy was last updated, in the format defined by RFC3339

addMaskingColumnsFromSdmTrigger Number
columnSources List<Property Map>: The source of masking columns.
compartmentId String: The OCID of the compartment that contains the masking policy.
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
description String: The description of the masking policy.
displayName String: The display name of the masking policy.
freeformTags Map<Any>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
id String: The OCID of the masking policy.
isDropTempTablesEnabled Boolean: Indicates if the temporary tables created during a masking operation should be dropped after masking. It's enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.
isRedoLoggingEnabled Boolean: Indicates if redo logging is enabled during a masking operation. It's disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.
isRefreshStatsEnabled Boolean: Indicates if statistics gathering is enabled. It's enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.
maskingPolicyId String
parallelDegree String: Specifies options to enable parallel execution when running data masking. Allowed values are 'NONE' (no parallelism), 'DEFAULT' (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUsi and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
postMaskingScript String: A post-masking script, which can contain SQL and PL/SQL statements. It's executed after the core masking script generated using the masking policy. It's usually used to perform additional transformation or cleanup work after masking.
preMaskingScript String: A pre-masking script, which can contain SQL and PL/SQL statements. It's executed before the core masking script generated using the masking policy. It's usually used to perform any preparation or prerequisite work before masking data.
recompile String: Specifies how to recompile invalid objects post data masking. Allowed values are 'SERIAL' (recompile in serial), 'PARALLEL' (recompile in parallel), 'NONE' (do not recompile). If it's set to PARALLEL, the value of parallelDegree attribute is used.
state String: The current state of the masking policy.
timeCreated String: The date and time the masking policy was created, in the format defined by RFC3339.
timeUpdated String: The date and time the masking policy was last updated, in the format defined by RFC3339

Supporting Types

GetMaskingPolicyColumnSource

ColumnSource string: The source of masking columns.
SensitiveDataModelId string: The OCID of the sensitive data model that's used as the source of masking columns.
TargetId string: The OCID of the target database that's used as the source of masking columns.

ColumnSource string: The source of masking columns.
SensitiveDataModelId string: The OCID of the sensitive data model that's used as the source of masking columns.
TargetId string: The OCID of the target database that's used as the source of masking columns.

columnSource String: The source of masking columns.
sensitiveDataModelId String: The OCID of the sensitive data model that's used as the source of masking columns.
targetId String: The OCID of the target database that's used as the source of masking columns.

columnSource string: The source of masking columns.
sensitiveDataModelId string: The OCID of the sensitive data model that's used as the source of masking columns.
targetId string: The OCID of the target database that's used as the source of masking columns.

column_source str: The source of masking columns.
sensitive_data_model_id str: The OCID of the sensitive data model that's used as the source of masking columns.
target_id str: The OCID of the target database that's used as the source of masking columns.

columnSource String: The source of masking columns.
sensitiveDataModelId String: The OCID of the sensitive data model that's used as the source of masking columns.
targetId String: The OCID of the target database that's used as the source of masking columns.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.