Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.DataSafe.getMaskingPolicy
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMaskingPolicy = oci.DataSafe.getMaskingPolicy({
maskingPolicyId: testMaskingPolicyOciDataSafeMaskingPolicy.id,
});
import pulumi
import pulumi_oci as oci
test_masking_policy = oci.DataSafe.get_masking_policy(masking_policy_id=test_masking_policy_oci_data_safe_masking_policy["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: testMaskingPolicyOciDataSafeMaskingPolicy.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 testMaskingPolicy = Oci.DataSafe.GetMaskingPolicy.Invoke(new()
{
MaskingPolicyId = testMaskingPolicyOciDataSafeMaskingPolicy.Id,
});
});
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(testMaskingPolicyOciDataSafeMaskingPolicy.id())
.build());
}
}
variables:
testMaskingPolicy:
fn::invoke:
Function: oci:DataSafe:getMaskingPolicy
Arguments:
maskingPolicyId: ${testMaskingPolicyOciDataSafeMaskingPolicy.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:
- Masking
Policy stringId - The OCID of the masking policy.
- Masking
Policy stringId - The OCID of the masking policy.
- masking
Policy StringId - The OCID of the masking policy.
- masking
Policy stringId - The OCID of the masking policy.
- masking_
policy_ strid - The OCID of the masking policy.
- masking
Policy StringId - The OCID of the masking policy.
getMaskingPolicy Result
The following output properties are available:
- Add
Masking intColumns From Sdm Trigger - Column
Sources List<GetMasking Policy Column Source> - The source of masking columns.
- Compartment
Id string - The OCID of the compartment that contains the masking policy.
- Dictionary<string, string>
- 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.
- Display
Name string - The display name of the masking policy.
- Dictionary<string, string>
- 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"}
- Generate
Health intReport Trigger - Id string
- The OCID of the masking policy.
- Is
Drop boolTemp Tables Enabled - 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 boolLogging Enabled - 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 boolStats Enabled - 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 stringId - Parallel
Degree 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 CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
- Post
Masking stringScript - 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 stringScript - 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. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.
- State string
- The current state of the masking policy.
- Time
Created string - The date and time the masking policy was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the masking policy was last updated, in the format defined by RFC3339
- Add
Masking intColumns From Sdm Trigger - Column
Sources []GetMasking Policy Column Source - The source of masking columns.
- Compartment
Id string - The OCID of the compartment that contains the masking policy.
- map[string]string
- 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.
- Display
Name string - The display name of the masking policy.
- map[string]string
- 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"}
- Generate
Health intReport Trigger - Id string
- The OCID of the masking policy.
- Is
Drop boolTemp Tables Enabled - 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 boolLogging Enabled - 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 boolStats Enabled - 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 stringId - Parallel
Degree 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 CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
- Post
Masking stringScript - 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 stringScript - 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. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.
- State string
- The current state of the masking policy.
- Time
Created string - The date and time the masking policy was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the masking policy was last updated, in the format defined by RFC3339
- add
Masking IntegerColumns From Sdm Trigger - column
Sources List<GetMasking Policy Column Source> - The source of masking columns.
- compartment
Id String - The OCID of the compartment that contains the masking policy.
- Map<String,String>
- 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.
- display
Name String - The display name of the masking policy.
- Map<String,String>
- 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"}
- generate
Health IntegerReport Trigger - id String
- The OCID of the masking policy.
- is
Drop BooleanTemp Tables Enabled - 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 BooleanLogging Enabled - 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 BooleanStats Enabled - 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 StringId - parallel
Degree 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 CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
- post
Masking StringScript - 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 StringScript - 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. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.
- state String
- The current state of the masking policy.
- time
Created String - The date and time the masking policy was created, in the format defined by RFC3339.
- time
Updated String - The date and time the masking policy was last updated, in the format defined by RFC3339
- add
Masking numberColumns From Sdm Trigger - column
Sources GetMasking Policy Column Source[] - The source of masking columns.
- compartment
Id string - The OCID of the compartment that contains the masking policy.
- {[key: string]: string}
- 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.
- display
Name string - The display name of the masking policy.
- {[key: string]: string}
- 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"}
- generate
Health numberReport Trigger - id string
- The OCID of the masking policy.
- is
Drop booleanTemp Tables Enabled - 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 booleanLogging Enabled - 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 booleanStats Enabled - 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 stringId - parallel
Degree 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 CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
- post
Masking stringScript - 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 stringScript - 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. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.
- state string
- The current state of the masking policy.
- time
Created string - The date and time the masking policy was created, in the format defined by RFC3339.
- time
Updated string - The date and time the masking policy was last updated, in the format defined by RFC3339
- add_
masking_ intcolumns_ from_ sdm_ trigger - column_
sources Sequence[datasafe.Get Masking Policy Column Source] - The source of masking columns.
- compartment_
id str - The OCID of the compartment that contains the masking policy.
- Mapping[str, str]
- 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.
- Mapping[str, str]
- 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"}
- generate_
health_ intreport_ trigger - id str
- The OCID of the masking policy.
- is_
drop_ booltemp_ tables_ enabled - 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_ boollogging_ enabled - 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_ boolstats_ enabled - 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_ strid - 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 CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
- post_
masking_ strscript - 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_ strscript - 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. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.
- 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
- add
Masking NumberColumns From Sdm Trigger - column
Sources List<Property Map> - The source of masking columns.
- compartment
Id String - The OCID of the compartment that contains the masking policy.
- Map<String>
- 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.
- display
Name String - The display name of the masking policy.
- Map<String>
- 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"}
- generate
Health NumberReport Trigger - id String
- The OCID of the masking policy.
- is
Drop BooleanTemp Tables Enabled - 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 BooleanLogging Enabled - 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 BooleanStats Enabled - 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 StringId - parallel
Degree 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 CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.
- post
Masking StringScript - 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 StringScript - 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. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.
- state String
- The current state of the masking policy.
- time
Created String - The date and time the masking policy was created, in the format defined by RFC3339.
- time
Updated String - The date and time the masking policy was last updated, in the format defined by RFC3339
Supporting Types
GetMaskingPolicyColumnSource
- Column
Source string - The source of masking columns.
- Sensitive
Data stringModel Id - The OCID of the sensitive data model that's used as the source of masking columns.
- Target
Id string - The OCID of the target database that's used as the source of masking columns.
- Column
Source string - The source of masking columns.
- Sensitive
Data stringModel Id - The OCID of the sensitive data model that's used as the source of masking columns.
- Target
Id string - The OCID of the target database that's used as the source of masking columns.
- column
Source String - The source of masking columns.
- sensitive
Data StringModel Id - The OCID of the sensitive data model that's used as the source of masking columns.
- target
Id String - The OCID of the target database that's used as the source of masking columns.
- column
Source string - The source of masking columns.
- sensitive
Data stringModel Id - The OCID of the sensitive data model that's used as the source of masking columns.
- target
Id 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_ strmodel_ id - 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.
- column
Source String - The source of masking columns.
- sensitive
Data StringModel Id - The OCID of the sensitive data model that's used as the source of masking columns.
- target
Id 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.