Oracle Cloud Infrastructure v2.28.0, Mar 27 25

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

oci.DataSafe.getMaskingPoliciesMaskingColumn

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

Example Usage

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

const testMaskingPoliciesMaskingColumn = oci.DataSafe.getMaskingPoliciesMaskingColumn({
    maskingColumnKey: maskingPoliciesMaskingColumnMaskingColumnKey,
    maskingPolicyId: testMaskingPolicy.id,
});

import pulumi
import pulumi_oci as oci

test_masking_policies_masking_column = oci.DataSafe.get_masking_policies_masking_column(masking_column_key=masking_policies_masking_column_masking_column_key,
    masking_policy_id=test_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.GetMaskingPoliciesMaskingColumn(ctx, &datasafe.GetMaskingPoliciesMaskingColumnArgs{
			MaskingColumnKey: maskingPoliciesMaskingColumnMaskingColumnKey,
			MaskingPolicyId:  testMaskingPolicy.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 testMaskingPoliciesMaskingColumn = Oci.DataSafe.GetMaskingPoliciesMaskingColumn.Invoke(new()
    {
        MaskingColumnKey = maskingPoliciesMaskingColumnMaskingColumnKey,
        MaskingPolicyId = testMaskingPolicy.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.GetMaskingPoliciesMaskingColumnArgs;
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 testMaskingPoliciesMaskingColumn = DataSafeFunctions.getMaskingPoliciesMaskingColumn(GetMaskingPoliciesMaskingColumnArgs.builder()
            .maskingColumnKey(maskingPoliciesMaskingColumnMaskingColumnKey)
            .maskingPolicyId(testMaskingPolicy.id())
            .build());

    }
}

variables:
  testMaskingPoliciesMaskingColumn:
    fn::invoke:
      function: oci:DataSafe:getMaskingPoliciesMaskingColumn
      arguments:
        maskingColumnKey: ${maskingPoliciesMaskingColumnMaskingColumnKey}
        maskingPolicyId: ${testMaskingPolicy.id}

Using getMaskingPoliciesMaskingColumn

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 getMaskingPoliciesMaskingColumn(args: GetMaskingPoliciesMaskingColumnArgs, opts?: InvokeOptions): Promise<GetMaskingPoliciesMaskingColumnResult>
function getMaskingPoliciesMaskingColumnOutput(args: GetMaskingPoliciesMaskingColumnOutputArgs, opts?: InvokeOptions): Output<GetMaskingPoliciesMaskingColumnResult>

def get_masking_policies_masking_column(masking_column_key: Optional[str] = None,
                                        masking_policy_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetMaskingPoliciesMaskingColumnResult
def get_masking_policies_masking_column_output(masking_column_key: Optional[pulumi.Input[str]] = None,
                                        masking_policy_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetMaskingPoliciesMaskingColumnResult]

func GetMaskingPoliciesMaskingColumn(ctx *Context, args *GetMaskingPoliciesMaskingColumnArgs, opts ...InvokeOption) (*GetMaskingPoliciesMaskingColumnResult, error)
func GetMaskingPoliciesMaskingColumnOutput(ctx *Context, args *GetMaskingPoliciesMaskingColumnOutputArgs, opts ...InvokeOption) GetMaskingPoliciesMaskingColumnResultOutput

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

public static class GetMaskingPoliciesMaskingColumn 
{
    public static Task<GetMaskingPoliciesMaskingColumnResult> InvokeAsync(GetMaskingPoliciesMaskingColumnArgs args, InvokeOptions? opts = null)
    public static Output<GetMaskingPoliciesMaskingColumnResult> Invoke(GetMaskingPoliciesMaskingColumnInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMaskingPoliciesMaskingColumnResult> getMaskingPoliciesMaskingColumn(GetMaskingPoliciesMaskingColumnArgs args, InvokeOptions options)
public static Output<GetMaskingPoliciesMaskingColumnResult> getMaskingPoliciesMaskingColumn(GetMaskingPoliciesMaskingColumnArgs args, InvokeOptions options)

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

The following arguments are supported:

MaskingColumnKey string: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
MaskingPolicyId string: The OCID of the masking policy.

MaskingColumnKey string: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
MaskingPolicyId string: The OCID of the masking policy.

maskingColumnKey String: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
maskingPolicyId String: The OCID of the masking policy.

maskingColumnKey string: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
maskingPolicyId string: The OCID of the masking policy.

masking_column_key str: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
masking_policy_id str: The OCID of the masking policy.

maskingColumnKey String: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
maskingPolicyId String: The OCID of the masking policy.

getMaskingPoliciesMaskingColumn Result

The following output properties are available:

ChildColumns List<string>: An array of child columns that are in referential relationship with the masking column.
ColumnName string: The name of the substitution column.
DataType string: The data type of the masking column.
Id string
IsMaskingEnabled bool: Indicates whether data masking is enabled for the masking column.
Key string: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
LifecycleDetails string: Details about the current state of the masking column.
MaskingColumnGroup string: The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.
MaskingColumnKey string
MaskingFormats List<GetMaskingPoliciesMaskingColumnMaskingFormat>: An array of masking formats assigned to the masking column.
MaskingPolicyId string: The OCID of the masking policy that contains the masking column.
Object string: The name of the object (table or editioning view) that contains the database column.
ObjectType string: The type of the object that contains the database column.
SchemaName string: The name of the schema that contains the database column.
SensitiveTypeId string: The OCID of the sensitive type associated with the masking column.
State string: The current state of the masking column.
TimeCreated string: The date and time the masking column was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the masking column was last updated, in the format defined by RFC3339.

ChildColumns []string: An array of child columns that are in referential relationship with the masking column.
ColumnName string: The name of the substitution column.
DataType string: The data type of the masking column.
Id string
IsMaskingEnabled bool: Indicates whether data masking is enabled for the masking column.
Key string: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
LifecycleDetails string: Details about the current state of the masking column.
MaskingColumnGroup string: The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.
MaskingColumnKey string
MaskingFormats []GetMaskingPoliciesMaskingColumnMaskingFormat: An array of masking formats assigned to the masking column.
MaskingPolicyId string: The OCID of the masking policy that contains the masking column.
Object string: The name of the object (table or editioning view) that contains the database column.
ObjectType string: The type of the object that contains the database column.
SchemaName string: The name of the schema that contains the database column.
SensitiveTypeId string: The OCID of the sensitive type associated with the masking column.
State string: The current state of the masking column.
TimeCreated string: The date and time the masking column was created, in the format defined by RFC3339.
TimeUpdated string: The date and time the masking column was last updated, in the format defined by RFC3339.

childColumns List<String>: An array of child columns that are in referential relationship with the masking column.
columnName String: The name of the substitution column.
dataType String: The data type of the masking column.
id String
isMaskingEnabled Boolean: Indicates whether data masking is enabled for the masking column.
key String: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
lifecycleDetails String: Details about the current state of the masking column.
maskingColumnGroup String: The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.
maskingColumnKey String
maskingFormats List<GetMaskingPoliciesMaskingColumnMaskingFormat>: An array of masking formats assigned to the masking column.
maskingPolicyId String: The OCID of the masking policy that contains the masking column.
object String: The name of the object (table or editioning view) that contains the database column.
objectType String: The type of the object that contains the database column.
schemaName String: The name of the schema that contains the database column.
sensitiveTypeId String: The OCID of the sensitive type associated with the masking column.
state String: The current state of the masking column.
timeCreated String: The date and time the masking column was created, in the format defined by RFC3339.
timeUpdated String: The date and time the masking column was last updated, in the format defined by RFC3339.

childColumns string[]: An array of child columns that are in referential relationship with the masking column.
columnName string: The name of the substitution column.
dataType string: The data type of the masking column.
id string
isMaskingEnabled boolean: Indicates whether data masking is enabled for the masking column.
key string: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
lifecycleDetails string: Details about the current state of the masking column.
maskingColumnGroup string: The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.
maskingColumnKey string
maskingFormats GetMaskingPoliciesMaskingColumnMaskingFormat[]: An array of masking formats assigned to the masking column.
maskingPolicyId string: The OCID of the masking policy that contains the masking column.
object string: The name of the object (table or editioning view) that contains the database column.
objectType string: The type of the object that contains the database column.
schemaName string: The name of the schema that contains the database column.
sensitiveTypeId string: The OCID of the sensitive type associated with the masking column.
state string: The current state of the masking column.
timeCreated string: The date and time the masking column was created, in the format defined by RFC3339.
timeUpdated string: The date and time the masking column was last updated, in the format defined by RFC3339.

child_columns Sequence[str]: An array of child columns that are in referential relationship with the masking column.
column_name str: The name of the substitution column.
data_type str: The data type of the masking column.
id str
is_masking_enabled bool: Indicates whether data masking is enabled for the masking column.
key str: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
lifecycle_details str: Details about the current state of the masking column.
masking_column_group str: The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.
masking_column_key str
masking_formats Sequence[datasafe.GetMaskingPoliciesMaskingColumnMaskingFormat]: An array of masking formats assigned to the masking column.
masking_policy_id str: The OCID of the masking policy that contains the masking column.
object str: The name of the object (table or editioning view) that contains the database column.
object_type str: The type of the object that contains the database column.
schema_name str: The name of the schema that contains the database column.
sensitive_type_id str: The OCID of the sensitive type associated with the masking column.
state str: The current state of the masking column.
time_created str: The date and time the masking column was created, in the format defined by RFC3339.
time_updated str: The date and time the masking column was last updated, in the format defined by RFC3339.

childColumns List<String>: An array of child columns that are in referential relationship with the masking column.
columnName String: The name of the substitution column.
dataType String: The data type of the masking column.
id String
isMaskingEnabled Boolean: Indicates whether data masking is enabled for the masking column.
key String: The unique key that identifies the masking column. It's numeric and unique within a masking policy.
lifecycleDetails String: Details about the current state of the masking column.
maskingColumnGroup String: The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.
maskingColumnKey String
maskingFormats List<Property Map>: An array of masking formats assigned to the masking column.
maskingPolicyId String: The OCID of the masking policy that contains the masking column.
object String: The name of the object (table or editioning view) that contains the database column.
objectType String: The type of the object that contains the database column.
schemaName String: The name of the schema that contains the database column.
sensitiveTypeId String: The OCID of the sensitive type associated with the masking column.
state String: The current state of the masking column.
timeCreated String: The date and time the masking column was created, in the format defined by RFC3339.
timeUpdated String: The date and time the masking column was last updated, in the format defined by RFC3339.

Supporting Types

GetMaskingPoliciesMaskingColumnMaskingFormat

Condition string: A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions.
Description string: The description of the format entry.
FormatEntries List<GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry>: An array of format entries. The combined output of all the format entries is used for masking the column data values.

Condition string: A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions.
Description string: The description of the format entry.
FormatEntries []GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry: An array of format entries. The combined output of all the format entries is used for masking the column data values.

condition String: A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions.
description String: The description of the format entry.
formatEntries List<GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry>: An array of format entries. The combined output of all the format entries is used for masking the column data values.

condition string: A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions.
description string: The description of the format entry.
formatEntries GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry[]: An array of format entries. The combined output of all the format entries is used for masking the column data values.

condition str: A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions.
description str: The description of the format entry.
format_entries Sequence[datasafe.GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry]: An array of format entries. The combined output of all the format entries is used for masking the column data values.

condition String: A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions.
description String: The description of the format entry.
formatEntries List<Property Map>: An array of format entries. The combined output of all the format entries is used for masking the column data values.

GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry

ColumnName string: The name of the substitution column.
Description string: The description of the format entry.
EndDate string: The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
EndLength int: The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
EndValue double: The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
FixedNumber double: The constant number to be used for masking.
FixedString string: The constant string to be used for masking.
GroupingColumns List<string>: One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
Length int: The number of characters that should be there in the substring. It should be an integer and greater than zero.
LibraryMaskingFormatId string: The OCID of the library masking format.
Pattern string: The pattern that should be used to mask data.
PostProcessingFunction string: The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
RandomLists List<string>: A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
RegularExpression string: The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.
ReplaceWith string: The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value.
SchemaName string: The name of the schema that contains the database column.
SqlExpression string: The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
StartDate string: The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
StartLength int: The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
StartPosition int: The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
StartValue double: The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
TableName string: The name of the table that contains the substitution column.
Type string: The type of the format entry.
UserDefinedFunction string: The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

ColumnName string: The name of the substitution column.
Description string: The description of the format entry.
EndDate string: The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
EndLength int: The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
EndValue float64: The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
FixedNumber float64: The constant number to be used for masking.
FixedString string: The constant string to be used for masking.
GroupingColumns []string: One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
Length int: The number of characters that should be there in the substring. It should be an integer and greater than zero.
LibraryMaskingFormatId string: The OCID of the library masking format.
Pattern string: The pattern that should be used to mask data.
PostProcessingFunction string: The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
RandomLists []string: A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
RegularExpression string: The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.
ReplaceWith string: The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value.
SchemaName string: The name of the schema that contains the database column.
SqlExpression string: The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
StartDate string: The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
StartLength int: The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
StartPosition int: The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
StartValue float64: The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
TableName string: The name of the table that contains the substitution column.
Type string: The type of the format entry.
UserDefinedFunction string: The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

columnName String: The name of the substitution column.
description String: The description of the format entry.
endDate String: The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
endLength Integer: The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
endValue Double: The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
fixedNumber Double: The constant number to be used for masking.
fixedString String: The constant string to be used for masking.
groupingColumns List<String>: One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
length Integer: The number of characters that should be there in the substring. It should be an integer and greater than zero.
libraryMaskingFormatId String: The OCID of the library masking format.
pattern String: The pattern that should be used to mask data.
postProcessingFunction String: The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
randomLists List<String>: A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
regularExpression String: The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.
replaceWith String: The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value.
schemaName String: The name of the schema that contains the database column.
sqlExpression String: The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
startDate String: The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
startLength Integer: The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
startPosition Integer: The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
startValue Double: The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
tableName String: The name of the table that contains the substitution column.
type String: The type of the format entry.
userDefinedFunction String: The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

columnName string: The name of the substitution column.
description string: The description of the format entry.
endDate string: The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
endLength number: The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
endValue number: The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
fixedNumber number: The constant number to be used for masking.
fixedString string: The constant string to be used for masking.
groupingColumns string[]: One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
length number: The number of characters that should be there in the substring. It should be an integer and greater than zero.
libraryMaskingFormatId string: The OCID of the library masking format.
pattern string: The pattern that should be used to mask data.
postProcessingFunction string: The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
randomLists string[]: A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
regularExpression string: The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.
replaceWith string: The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value.
schemaName string: The name of the schema that contains the database column.
sqlExpression string: The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
startDate string: The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
startLength number: The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
startPosition number: The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
startValue number: The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
tableName string: The name of the table that contains the substitution column.
type string: The type of the format entry.
userDefinedFunction string: The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

column_name str: The name of the substitution column.
description str: The description of the format entry.
end_date str: The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
end_length int: The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
end_value float: The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
fixed_number float: The constant number to be used for masking.
fixed_string str: The constant string to be used for masking.
grouping_columns Sequence[str]: One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
length int: The number of characters that should be there in the substring. It should be an integer and greater than zero.
library_masking_format_id str: The OCID of the library masking format.
pattern str: The pattern that should be used to mask data.
post_processing_function str: The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
random_lists Sequence[str]: A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
regular_expression str: The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.
replace_with str: The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value.
schema_name str: The name of the schema that contains the database column.
sql_expression str: The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
start_date str: The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
start_length int: The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
start_position int: The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
start_value float: The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
table_name str: The name of the table that contains the substitution column.
type str: The type of the format entry.
user_defined_function str: The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

columnName String: The name of the substitution column.
description String: The description of the format entry.
endDate String: The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
endLength Number: The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
endValue Number: The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
fixedNumber Number: The constant number to be used for masking.
fixedString String: The constant string to be used for masking.
groupingColumns List<String>: One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
length Number: The number of characters that should be there in the substring. It should be an integer and greater than zero.
libraryMaskingFormatId String: The OCID of the library masking format.
pattern String: The pattern that should be used to mask data.
postProcessingFunction String: The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
randomLists List<String>: A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
regularExpression String: The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.
replaceWith String: The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number or null value.
schemaName String: The name of the schema that contains the database column.
sqlExpression String: The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
startDate String: The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
startLength Number: The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
startPosition Number: The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
startValue Number: The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
tableName String: The name of the table that contains the substitution column.
type String: The type of the format entry.
userDefinedFunction String: The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

Package Details

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

Oracle Cloud Infrastructure v2.28.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataSafe.getMaskingPoliciesMaskingColumn

On this page

On this page

Example Usage

Using getMaskingPoliciesMaskingColumn

getMaskingPoliciesMaskingColumn Result

Supporting Types

GetMaskingPoliciesMaskingColumnMaskingFormat

GetMaskingPoliciesMaskingColumnMaskingFormatFormatEntry

Package Details

On this page

On this page