Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getLibraryMaskingFormat
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.getLibraryMaskingFormat

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

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

    Gets the details of the specified library masking format.

    Example Usage

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

const testLibraryMaskingFormat = oci.DataSafe.getLibraryMaskingFormat({
    libraryMaskingFormatId: oci_data_safe_library_masking_format.test_library_masking_format.id,
});

    import pulumi
import pulumi_oci as oci

test_library_masking_format = oci.DataSafe.get_library_masking_format(library_masking_format_id=oci_data_safe_library_masking_format["test_library_masking_format"]["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.GetLibraryMaskingFormat(ctx, &datasafe.GetLibraryMaskingFormatArgs{
			LibraryMaskingFormatId: oci_data_safe_library_masking_format.Test_library_masking_format.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 testLibraryMaskingFormat = Oci.DataSafe.GetLibraryMaskingFormat.Invoke(new()
    {
        LibraryMaskingFormatId = oci_data_safe_library_masking_format.Test_library_masking_format.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.GetLibraryMaskingFormatArgs;
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 testLibraryMaskingFormat = DataSafeFunctions.getLibraryMaskingFormat(GetLibraryMaskingFormatArgs.builder()
            .libraryMaskingFormatId(oci_data_safe_library_masking_format.test_library_masking_format().id())
            .build());

    }
}

    variables:
  testLibraryMaskingFormat:
    fn::invoke:
      Function: oci:DataSafe:getLibraryMaskingFormat
      Arguments:
        libraryMaskingFormatId: ${oci_data_safe_library_masking_format.test_library_masking_format.id}

    Using getLibraryMaskingFormat

    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 getLibraryMaskingFormat(args: GetLibraryMaskingFormatArgs, opts?: InvokeOptions): Promise<GetLibraryMaskingFormatResult>
function getLibraryMaskingFormatOutput(args: GetLibraryMaskingFormatOutputArgs, opts?: InvokeOptions): Output<GetLibraryMaskingFormatResult>
    def get_library_masking_format(library_masking_format_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetLibraryMaskingFormatResult
def get_library_masking_format_output(library_masking_format_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetLibraryMaskingFormatResult]
    func GetLibraryMaskingFormat(ctx *Context, args *GetLibraryMaskingFormatArgs, opts ...InvokeOption) (*GetLibraryMaskingFormatResult, error)
func GetLibraryMaskingFormatOutput(ctx *Context, args *GetLibraryMaskingFormatOutputArgs, opts ...InvokeOption) GetLibraryMaskingFormatResultOutput

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

    public static class GetLibraryMaskingFormat 
{
    public static Task<GetLibraryMaskingFormatResult> InvokeAsync(GetLibraryMaskingFormatArgs args, InvokeOptions? opts = null)
    public static Output<GetLibraryMaskingFormatResult> Invoke(GetLibraryMaskingFormatInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLibraryMaskingFormatResult> getLibraryMaskingFormat(GetLibraryMaskingFormatArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    LibraryMaskingFormatId string
    The OCID of the library masking format.
    LibraryMaskingFormatId string
    The OCID of the library masking format.
    libraryMaskingFormatId String
    The OCID of the library masking format.
    libraryMaskingFormatId string
    The OCID of the library masking format.
    library_masking_format_id str
    The OCID of the library masking format.
    libraryMaskingFormatId String
    The OCID of the library masking format.

    getLibraryMaskingFormat Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment that contains the library masking format.
    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 format entry.
    DisplayName string
    The display name of the library masking format.
    FormatEntries List<GetLibraryMaskingFormatFormatEntry>
    An array of format entries. The combined output of all the format entries is used for masking.
    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 library masking format.
    LibraryMaskingFormatId string
    The OCID of the library masking format.
    SensitiveTypeIds List<string>
    An array of OCIDs of the sensitive types compatible with the library masking format.
    Source string
    Specifies whether the library masking format is user-defined or predefined.
    State string
    The current state of the library masking format.
    TimeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    TimeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    CompartmentId string
    The OCID of the compartment that contains the library masking format.
    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 format entry.
    DisplayName string
    The display name of the library masking format.
    FormatEntries []GetLibraryMaskingFormatFormatEntry
    An array of format entries. The combined output of all the format entries is used for masking.
    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 library masking format.
    LibraryMaskingFormatId string
    The OCID of the library masking format.
    SensitiveTypeIds []string
    An array of OCIDs of the sensitive types compatible with the library masking format.
    Source string
    Specifies whether the library masking format is user-defined or predefined.
    State string
    The current state of the library masking format.
    TimeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    TimeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartmentId String
    The OCID of the compartment that contains the library masking format.
    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 format entry.
    displayName String
    The display name of the library masking format.
    formatEntries List<GetLibraryMaskingFormatFormatEntry>
    An array of format entries. The combined output of all the format entries is used for masking.
    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 library masking format.
    libraryMaskingFormatId String
    The OCID of the library masking format.
    sensitiveTypeIds List<String>
    An array of OCIDs of the sensitive types compatible with the library masking format.
    source String
    Specifies whether the library masking format is user-defined or predefined.
    state String
    The current state of the library masking format.
    timeCreated String
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated String
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartmentId string
    The OCID of the compartment that contains the library masking format.
    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 format entry.
    displayName string
    The display name of the library masking format.
    formatEntries GetLibraryMaskingFormatFormatEntry[]
    An array of format entries. The combined output of all the format entries is used for masking.
    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 library masking format.
    libraryMaskingFormatId string
    The OCID of the library masking format.
    sensitiveTypeIds string[]
    An array of OCIDs of the sensitive types compatible with the library masking format.
    source string
    Specifies whether the library masking format is user-defined or predefined.
    state string
    The current state of the library masking format.
    timeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartment_id str
    The OCID of the compartment that contains the library masking format.
    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 format entry.
    display_name str
    The display name of the library masking format.
    format_entries Sequence[datasafe.GetLibraryMaskingFormatFormatEntry]
    An array of format entries. The combined output of all the format entries is used for masking.
    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 library masking format.
    library_masking_format_id str
    The OCID of the library masking format.
    sensitive_type_ids Sequence[str]
    An array of OCIDs of the sensitive types compatible with the library masking format.
    source str
    Specifies whether the library masking format is user-defined or predefined.
    state str
    The current state of the library masking format.
    time_created str
    The date and time the library masking format was created, in the format defined by RFC3339
    time_updated str
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartmentId String
    The OCID of the compartment that contains the library masking format.
    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 format entry.
    displayName String
    The display name of the library masking format.
    formatEntries List<Property Map>
    An array of format entries. The combined output of all the format entries is used for masking.
    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 library masking format.
    libraryMaskingFormatId String
    The OCID of the library masking format.
    sensitiveTypeIds List<String>
    An array of OCIDs of the sensitive types compatible with the library masking format.
    source String
    Specifies whether the library masking format is user-defined or predefined.
    state String
    The current state of the library masking format.
    timeCreated String
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated String
    The date and time the library masking format was updated, in the format defined by RFC3339

    Supporting Types

    GetLibraryMaskingFormatFormatEntry

    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, null value, or SQL expression.
    SchemaName string
    The name of the schema that contains the substitution 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, null value, or SQL expression.
    SchemaName string
    The name of the schema that contains the substitution 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, null value, or SQL expression.
    schemaName String
    The name of the schema that contains the substitution 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, null value, or SQL expression.
    schemaName string
    The name of the schema that contains the substitution 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, null value, or SQL expression.
    schema_name str
    The name of the schema that contains the substitution 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, null value, or SQL expression.
    schemaName String
    The name of the schema that contains the substitution 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.
    oci logo
    Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-oci