Oracle Cloud Infrastructure v1.41.0, Jun 19 24

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.DataSafe.MaskingPoliciesMaskingColumn

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

Creates a new masking column in the specified masking policy. Use this operation to add parent columns only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column.

Using the maskingFormats attribute, you can assign one or more masking formats to a column. You need to specify a condition as part of each masking format. It enables you to do conditional masking so that you can mask the column data values differently using different masking conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.

You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do group or compound masking that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

Example Usage

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

const testMaskingPoliciesMaskingColumn = new oci.datasafe.MaskingPoliciesMaskingColumn("test_masking_policies_masking_column", {
    columnName: maskingPoliciesMaskingColumnColumnName,
    maskingPolicyId: testMaskingPolicy.id,
    object: maskingPoliciesMaskingColumnObject,
    schemaName: maskingPoliciesMaskingColumnSchemaName,
    isMaskingEnabled: maskingPoliciesMaskingColumnIsMaskingEnabled,
    maskingColumnGroup: maskingPoliciesMaskingColumnMaskingColumnGroup,
    maskingFormats: [{
        formatEntries: [{
            type: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesType,
            columnName: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesColumnName,
            description: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesDescription,
            endDate: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndDate,
            endLength: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndLength,
            endValue: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndValue,
            fixedNumber: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedNumber,
            fixedString: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedString,
            groupingColumns: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesGroupingColumns,
            length: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesLength,
            libraryMaskingFormatId: testLibraryMaskingFormat.id,
            pattern: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPattern,
            postProcessingFunction: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPostProcessingFunction,
            randomLists: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRandomList,
            regularExpression: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRegularExpression,
            replaceWith: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesReplaceWith,
            schemaName: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSchemaName,
            sqlExpression: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSqlExpression,
            startDate: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartDate,
            startLength: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartLength,
            startPosition: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartPosition,
            startValue: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartValue,
            tableName: testTable.name,
            userDefinedFunction: maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesUserDefinedFunction,
        }],
        condition: maskingPoliciesMaskingColumnMaskingFormatsCondition,
        description: maskingPoliciesMaskingColumnMaskingFormatsDescription,
    }],
    objectType: maskingPoliciesMaskingColumnObjectType,
    sensitiveTypeId: testSensitiveType.id,
});

import pulumi
import pulumi_oci as oci

test_masking_policies_masking_column = oci.data_safe.MaskingPoliciesMaskingColumn("test_masking_policies_masking_column",
    column_name=masking_policies_masking_column_column_name,
    masking_policy_id=test_masking_policy["id"],
    object=masking_policies_masking_column_object,
    schema_name=masking_policies_masking_column_schema_name,
    is_masking_enabled=masking_policies_masking_column_is_masking_enabled,
    masking_column_group=masking_policies_masking_column_masking_column_group,
    masking_formats=[oci.data_safe.MaskingPoliciesMaskingColumnMaskingFormatArgs(
        format_entries=[oci.data_safe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs(
            type=masking_policies_masking_column_masking_formats_format_entries_type,
            column_name=masking_policies_masking_column_masking_formats_format_entries_column_name,
            description=masking_policies_masking_column_masking_formats_format_entries_description,
            end_date=masking_policies_masking_column_masking_formats_format_entries_end_date,
            end_length=masking_policies_masking_column_masking_formats_format_entries_end_length,
            end_value=masking_policies_masking_column_masking_formats_format_entries_end_value,
            fixed_number=masking_policies_masking_column_masking_formats_format_entries_fixed_number,
            fixed_string=masking_policies_masking_column_masking_formats_format_entries_fixed_string,
            grouping_columns=masking_policies_masking_column_masking_formats_format_entries_grouping_columns,
            length=masking_policies_masking_column_masking_formats_format_entries_length,
            library_masking_format_id=test_library_masking_format["id"],
            pattern=masking_policies_masking_column_masking_formats_format_entries_pattern,
            post_processing_function=masking_policies_masking_column_masking_formats_format_entries_post_processing_function,
            random_lists=masking_policies_masking_column_masking_formats_format_entries_random_list,
            regular_expression=masking_policies_masking_column_masking_formats_format_entries_regular_expression,
            replace_with=masking_policies_masking_column_masking_formats_format_entries_replace_with,
            schema_name=masking_policies_masking_column_masking_formats_format_entries_schema_name,
            sql_expression=masking_policies_masking_column_masking_formats_format_entries_sql_expression,
            start_date=masking_policies_masking_column_masking_formats_format_entries_start_date,
            start_length=masking_policies_masking_column_masking_formats_format_entries_start_length,
            start_position=masking_policies_masking_column_masking_formats_format_entries_start_position,
            start_value=masking_policies_masking_column_masking_formats_format_entries_start_value,
            table_name=test_table["name"],
            user_defined_function=masking_policies_masking_column_masking_formats_format_entries_user_defined_function,
        )],
        condition=masking_policies_masking_column_masking_formats_condition,
        description=masking_policies_masking_column_masking_formats_description,
    )],
    object_type=masking_policies_masking_column_object_type,
    sensitive_type_id=test_sensitive_type["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.NewMaskingPoliciesMaskingColumn(ctx, "test_masking_policies_masking_column", &DataSafe.MaskingPoliciesMaskingColumnArgs{
			ColumnName:         pulumi.Any(maskingPoliciesMaskingColumnColumnName),
			MaskingPolicyId:    pulumi.Any(testMaskingPolicy.Id),
			Object:             pulumi.Any(maskingPoliciesMaskingColumnObject),
			SchemaName:         pulumi.Any(maskingPoliciesMaskingColumnSchemaName),
			IsMaskingEnabled:   pulumi.Any(maskingPoliciesMaskingColumnIsMaskingEnabled),
			MaskingColumnGroup: pulumi.Any(maskingPoliciesMaskingColumnMaskingColumnGroup),
			MaskingFormats: datasafe.MaskingPoliciesMaskingColumnMaskingFormatArray{
				&datasafe.MaskingPoliciesMaskingColumnMaskingFormatArgs{
					FormatEntries: datasafe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArray{
						&datasafe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs{
							Type:                   pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesType),
							ColumnName:             pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesColumnName),
							Description:            pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesDescription),
							EndDate:                pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndDate),
							EndLength:              pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndLength),
							EndValue:               pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndValue),
							FixedNumber:            pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedNumber),
							FixedString:            pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedString),
							GroupingColumns:        pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesGroupingColumns),
							Length:                 pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesLength),
							LibraryMaskingFormatId: pulumi.Any(testLibraryMaskingFormat.Id),
							Pattern:                pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPattern),
							PostProcessingFunction: pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPostProcessingFunction),
							RandomLists:            pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRandomList),
							RegularExpression:      pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRegularExpression),
							ReplaceWith:            pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesReplaceWith),
							SchemaName:             pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSchemaName),
							SqlExpression:          pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSqlExpression),
							StartDate:              pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartDate),
							StartLength:            pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartLength),
							StartPosition:          pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartPosition),
							StartValue:             pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartValue),
							TableName:              pulumi.Any(testTable.Name),
							UserDefinedFunction:    pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesUserDefinedFunction),
						},
					},
					Condition:   pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsCondition),
					Description: pulumi.Any(maskingPoliciesMaskingColumnMaskingFormatsDescription),
				},
			},
			ObjectType:      pulumi.Any(maskingPoliciesMaskingColumnObjectType),
			SensitiveTypeId: pulumi.Any(testSensitiveType.Id),
		})
		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 = new Oci.DataSafe.MaskingPoliciesMaskingColumn("test_masking_policies_masking_column", new()
    {
        ColumnName = maskingPoliciesMaskingColumnColumnName,
        MaskingPolicyId = testMaskingPolicy.Id,
        Object = maskingPoliciesMaskingColumnObject,
        SchemaName = maskingPoliciesMaskingColumnSchemaName,
        IsMaskingEnabled = maskingPoliciesMaskingColumnIsMaskingEnabled,
        MaskingColumnGroup = maskingPoliciesMaskingColumnMaskingColumnGroup,
        MaskingFormats = new[]
        {
            new Oci.DataSafe.Inputs.MaskingPoliciesMaskingColumnMaskingFormatArgs
            {
                FormatEntries = new[]
                {
                    new Oci.DataSafe.Inputs.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs
                    {
                        Type = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesType,
                        ColumnName = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesColumnName,
                        Description = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesDescription,
                        EndDate = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndDate,
                        EndLength = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndLength,
                        EndValue = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndValue,
                        FixedNumber = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedNumber,
                        FixedString = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedString,
                        GroupingColumns = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesGroupingColumns,
                        Length = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesLength,
                        LibraryMaskingFormatId = testLibraryMaskingFormat.Id,
                        Pattern = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPattern,
                        PostProcessingFunction = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPostProcessingFunction,
                        RandomLists = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRandomList,
                        RegularExpression = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRegularExpression,
                        ReplaceWith = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesReplaceWith,
                        SchemaName = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSchemaName,
                        SqlExpression = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSqlExpression,
                        StartDate = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartDate,
                        StartLength = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartLength,
                        StartPosition = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartPosition,
                        StartValue = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartValue,
                        TableName = testTable.Name,
                        UserDefinedFunction = maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesUserDefinedFunction,
                    },
                },
                Condition = maskingPoliciesMaskingColumnMaskingFormatsCondition,
                Description = maskingPoliciesMaskingColumnMaskingFormatsDescription,
            },
        },
        ObjectType = maskingPoliciesMaskingColumnObjectType,
        SensitiveTypeId = testSensitiveType.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.MaskingPoliciesMaskingColumn;
import com.pulumi.oci.DataSafe.MaskingPoliciesMaskingColumnArgs;
import com.pulumi.oci.DataSafe.inputs.MaskingPoliciesMaskingColumnMaskingFormatArgs;
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) {
        var testMaskingPoliciesMaskingColumn = new MaskingPoliciesMaskingColumn("testMaskingPoliciesMaskingColumn", MaskingPoliciesMaskingColumnArgs.builder()
            .columnName(maskingPoliciesMaskingColumnColumnName)
            .maskingPolicyId(testMaskingPolicy.id())
            .object(maskingPoliciesMaskingColumnObject)
            .schemaName(maskingPoliciesMaskingColumnSchemaName)
            .isMaskingEnabled(maskingPoliciesMaskingColumnIsMaskingEnabled)
            .maskingColumnGroup(maskingPoliciesMaskingColumnMaskingColumnGroup)
            .maskingFormats(MaskingPoliciesMaskingColumnMaskingFormatArgs.builder()
                .formatEntries(MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs.builder()
                    .type(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesType)
                    .columnName(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesColumnName)
                    .description(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesDescription)
                    .endDate(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndDate)
                    .endLength(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndLength)
                    .endValue(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndValue)
                    .fixedNumber(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedNumber)
                    .fixedString(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedString)
                    .groupingColumns(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesGroupingColumns)
                    .length(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesLength)
                    .libraryMaskingFormatId(testLibraryMaskingFormat.id())
                    .pattern(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPattern)
                    .postProcessingFunction(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPostProcessingFunction)
                    .randomLists(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRandomList)
                    .regularExpression(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRegularExpression)
                    .replaceWith(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesReplaceWith)
                    .schemaName(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSchemaName)
                    .sqlExpression(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSqlExpression)
                    .startDate(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartDate)
                    .startLength(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartLength)
                    .startPosition(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartPosition)
                    .startValue(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartValue)
                    .tableName(testTable.name())
                    .userDefinedFunction(maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesUserDefinedFunction)
                    .build())
                .condition(maskingPoliciesMaskingColumnMaskingFormatsCondition)
                .description(maskingPoliciesMaskingColumnMaskingFormatsDescription)
                .build())
            .objectType(maskingPoliciesMaskingColumnObjectType)
            .sensitiveTypeId(testSensitiveType.id())
            .build());

    }
}

resources:
  testMaskingPoliciesMaskingColumn:
    type: oci:DataSafe:MaskingPoliciesMaskingColumn
    name: test_masking_policies_masking_column
    properties:
      columnName: ${maskingPoliciesMaskingColumnColumnName}
      maskingPolicyId: ${testMaskingPolicy.id}
      object: ${maskingPoliciesMaskingColumnObject}
      schemaName: ${maskingPoliciesMaskingColumnSchemaName}
      isMaskingEnabled: ${maskingPoliciesMaskingColumnIsMaskingEnabled}
      maskingColumnGroup: ${maskingPoliciesMaskingColumnMaskingColumnGroup}
      maskingFormats:
        - formatEntries:
            - type: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesType}
              columnName: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesColumnName}
              description: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesDescription}
              endDate: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndDate}
              endLength: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndLength}
              endValue: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesEndValue}
              fixedNumber: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedNumber}
              fixedString: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesFixedString}
              groupingColumns: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesGroupingColumns}
              length: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesLength}
              libraryMaskingFormatId: ${testLibraryMaskingFormat.id}
              pattern: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPattern}
              postProcessingFunction: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesPostProcessingFunction}
              randomLists: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRandomList}
              regularExpression: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesRegularExpression}
              replaceWith: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesReplaceWith}
              schemaName: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSchemaName}
              sqlExpression: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesSqlExpression}
              startDate: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartDate}
              startLength: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartLength}
              startPosition: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartPosition}
              startValue: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesStartValue}
              tableName: ${testTable.name}
              userDefinedFunction: ${maskingPoliciesMaskingColumnMaskingFormatsFormatEntriesUserDefinedFunction}
          condition: ${maskingPoliciesMaskingColumnMaskingFormatsCondition}
          description: ${maskingPoliciesMaskingColumnMaskingFormatsDescription}
      objectType: ${maskingPoliciesMaskingColumnObjectType}
      sensitiveTypeId: ${testSensitiveType.id}

Create MaskingPoliciesMaskingColumn Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MaskingPoliciesMaskingColumn(name: string, args: MaskingPoliciesMaskingColumnArgs, opts?: CustomResourceOptions);

@overload
def MaskingPoliciesMaskingColumn(resource_name: str,
                                 args: MaskingPoliciesMaskingColumnArgs,
                                 opts: Optional[ResourceOptions] = None)

@overload
def MaskingPoliciesMaskingColumn(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 column_name: Optional[str] = None,
                                 masking_policy_id: Optional[str] = None,
                                 object: Optional[str] = None,
                                 schema_name: Optional[str] = None,
                                 is_masking_enabled: Optional[bool] = None,
                                 masking_column_group: Optional[str] = None,
                                 masking_formats: Optional[Sequence[_datasafe.MaskingPoliciesMaskingColumnMaskingFormatArgs]] = None,
                                 object_type: Optional[str] = None,
                                 sensitive_type_id: Optional[str] = None)

func NewMaskingPoliciesMaskingColumn(ctx *Context, name string, args MaskingPoliciesMaskingColumnArgs, opts ...ResourceOption) (*MaskingPoliciesMaskingColumn, error)

public MaskingPoliciesMaskingColumn(string name, MaskingPoliciesMaskingColumnArgs args, CustomResourceOptions? opts = null)

public MaskingPoliciesMaskingColumn(String name, MaskingPoliciesMaskingColumnArgs args)
public MaskingPoliciesMaskingColumn(String name, MaskingPoliciesMaskingColumnArgs args, CustomResourceOptions options)

type: oci:DataSafe:MaskingPoliciesMaskingColumn
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args MaskingPoliciesMaskingColumnArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args MaskingPoliciesMaskingColumnArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MaskingPoliciesMaskingColumnArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MaskingPoliciesMaskingColumnArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MaskingPoliciesMaskingColumnArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var maskingPoliciesMaskingColumnResource = new Oci.DataSafe.MaskingPoliciesMaskingColumn("maskingPoliciesMaskingColumnResource", new()
{
    ColumnName = "string",
    MaskingPolicyId = "string",
    Object = "string",
    SchemaName = "string",
    IsMaskingEnabled = false,
    MaskingColumnGroup = "string",
    MaskingFormats = new[]
    {
        new Oci.DataSafe.Inputs.MaskingPoliciesMaskingColumnMaskingFormatArgs
        {
            FormatEntries = new[]
            {
                new Oci.DataSafe.Inputs.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs
                {
                    Type = "string",
                    RandomLists = new[]
                    {
                        "string",
                    },
                    UserDefinedFunction = "string",
                    PostProcessingFunction = "string",
                    EndValue = 0,
                    FixedNumber = 0,
                    FixedString = "string",
                    GroupingColumns = new[]
                    {
                        "string",
                    },
                    Length = 0,
                    LibraryMaskingFormatId = "string",
                    RegularExpression = "string",
                    EndLength = 0,
                    EndDate = "string",
                    Pattern = "string",
                    ReplaceWith = "string",
                    SchemaName = "string",
                    SqlExpression = "string",
                    StartDate = "string",
                    StartLength = 0,
                    StartPosition = 0,
                    StartValue = 0,
                    TableName = "string",
                    Description = "string",
                    ColumnName = "string",
                },
            },
            Condition = "string",
            Description = "string",
        },
    },
    ObjectType = "string",
    SensitiveTypeId = "string",
});

example, err := DataSafe.NewMaskingPoliciesMaskingColumn(ctx, "maskingPoliciesMaskingColumnResource", &DataSafe.MaskingPoliciesMaskingColumnArgs{
	ColumnName:         pulumi.String("string"),
	MaskingPolicyId:    pulumi.String("string"),
	Object:             pulumi.String("string"),
	SchemaName:         pulumi.String("string"),
	IsMaskingEnabled:   pulumi.Bool(false),
	MaskingColumnGroup: pulumi.String("string"),
	MaskingFormats: datasafe.MaskingPoliciesMaskingColumnMaskingFormatArray{
		&datasafe.MaskingPoliciesMaskingColumnMaskingFormatArgs{
			FormatEntries: datasafe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArray{
				&datasafe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs{
					Type: pulumi.String("string"),
					RandomLists: pulumi.StringArray{
						pulumi.String("string"),
					},
					UserDefinedFunction:    pulumi.String("string"),
					PostProcessingFunction: pulumi.String("string"),
					EndValue:               pulumi.Float64(0),
					FixedNumber:            pulumi.Float64(0),
					FixedString:            pulumi.String("string"),
					GroupingColumns: pulumi.StringArray{
						pulumi.String("string"),
					},
					Length:                 pulumi.Int(0),
					LibraryMaskingFormatId: pulumi.String("string"),
					RegularExpression:      pulumi.String("string"),
					EndLength:              pulumi.Int(0),
					EndDate:                pulumi.String("string"),
					Pattern:                pulumi.String("string"),
					ReplaceWith:            pulumi.String("string"),
					SchemaName:             pulumi.String("string"),
					SqlExpression:          pulumi.String("string"),
					StartDate:              pulumi.String("string"),
					StartLength:            pulumi.Int(0),
					StartPosition:          pulumi.Int(0),
					StartValue:             pulumi.Float64(0),
					TableName:              pulumi.String("string"),
					Description:            pulumi.String("string"),
					ColumnName:             pulumi.String("string"),
				},
			},
			Condition:   pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	ObjectType:      pulumi.String("string"),
	SensitiveTypeId: pulumi.String("string"),
})

var maskingPoliciesMaskingColumnResource = new MaskingPoliciesMaskingColumn("maskingPoliciesMaskingColumnResource", MaskingPoliciesMaskingColumnArgs.builder()
    .columnName("string")
    .maskingPolicyId("string")
    .object("string")
    .schemaName("string")
    .isMaskingEnabled(false)
    .maskingColumnGroup("string")
    .maskingFormats(MaskingPoliciesMaskingColumnMaskingFormatArgs.builder()
        .formatEntries(MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs.builder()
            .type("string")
            .randomLists("string")
            .userDefinedFunction("string")
            .postProcessingFunction("string")
            .endValue(0)
            .fixedNumber(0)
            .fixedString("string")
            .groupingColumns("string")
            .length(0)
            .libraryMaskingFormatId("string")
            .regularExpression("string")
            .endLength(0)
            .endDate("string")
            .pattern("string")
            .replaceWith("string")
            .schemaName("string")
            .sqlExpression("string")
            .startDate("string")
            .startLength(0)
            .startPosition(0)
            .startValue(0)
            .tableName("string")
            .description("string")
            .columnName("string")
            .build())
        .condition("string")
        .description("string")
        .build())
    .objectType("string")
    .sensitiveTypeId("string")
    .build());

masking_policies_masking_column_resource = oci.data_safe.MaskingPoliciesMaskingColumn("maskingPoliciesMaskingColumnResource",
    column_name="string",
    masking_policy_id="string",
    object="string",
    schema_name="string",
    is_masking_enabled=False,
    masking_column_group="string",
    masking_formats=[oci.data_safe.MaskingPoliciesMaskingColumnMaskingFormatArgs(
        format_entries=[oci.data_safe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs(
            type="string",
            random_lists=["string"],
            user_defined_function="string",
            post_processing_function="string",
            end_value=0,
            fixed_number=0,
            fixed_string="string",
            grouping_columns=["string"],
            length=0,
            library_masking_format_id="string",
            regular_expression="string",
            end_length=0,
            end_date="string",
            pattern="string",
            replace_with="string",
            schema_name="string",
            sql_expression="string",
            start_date="string",
            start_length=0,
            start_position=0,
            start_value=0,
            table_name="string",
            description="string",
            column_name="string",
        )],
        condition="string",
        description="string",
    )],
    object_type="string",
    sensitive_type_id="string")

const maskingPoliciesMaskingColumnResource = new oci.datasafe.MaskingPoliciesMaskingColumn("maskingPoliciesMaskingColumnResource", {
    columnName: "string",
    maskingPolicyId: "string",
    object: "string",
    schemaName: "string",
    isMaskingEnabled: false,
    maskingColumnGroup: "string",
    maskingFormats: [{
        formatEntries: [{
            type: "string",
            randomLists: ["string"],
            userDefinedFunction: "string",
            postProcessingFunction: "string",
            endValue: 0,
            fixedNumber: 0,
            fixedString: "string",
            groupingColumns: ["string"],
            length: 0,
            libraryMaskingFormatId: "string",
            regularExpression: "string",
            endLength: 0,
            endDate: "string",
            pattern: "string",
            replaceWith: "string",
            schemaName: "string",
            sqlExpression: "string",
            startDate: "string",
            startLength: 0,
            startPosition: 0,
            startValue: 0,
            tableName: "string",
            description: "string",
            columnName: "string",
        }],
        condition: "string",
        description: "string",
    }],
    objectType: "string",
    sensitiveTypeId: "string",
});

type: oci:DataSafe:MaskingPoliciesMaskingColumn
properties:
    columnName: string
    isMaskingEnabled: false
    maskingColumnGroup: string
    maskingFormats:
        - condition: string
          description: string
          formatEntries:
            - columnName: string
              description: string
              endDate: string
              endLength: 0
              endValue: 0
              fixedNumber: 0
              fixedString: string
              groupingColumns:
                - string
              length: 0
              libraryMaskingFormatId: string
              pattern: string
              postProcessingFunction: string
              randomLists:
                - string
              regularExpression: string
              replaceWith: string
              schemaName: string
              sqlExpression: string
              startDate: string
              startLength: 0
              startPosition: 0
              startValue: 0
              tableName: string
              type: string
              userDefinedFunction: string
    maskingPolicyId: string
    object: string
    objectType: string
    schemaName: string
    sensitiveTypeId: string

MaskingPoliciesMaskingColumn Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MaskingPoliciesMaskingColumn resource accepts the following input properties:

ColumnName string

The name of the database column. This attribute cannot be updated for an existing masking column. Note that the same name is used for the masking column. There is no separate displayName attribute for the masking column.

MaskingPolicyId string

The OCID of the masking policy.

Object string

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

SchemaName string

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

IsMaskingEnabled bool

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the column.

MaskingColumnGroup string

(Updatable) The group of the masking column. It's a masking group identifier and can be any string of acceptable length. 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.

MaskingFormats List<MaskingPoliciesMaskingColumnMaskingFormat>

(Updatable) The masking formats to be assigned to the masking column. You can specify a condition as part of each masking format. 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. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.

ObjectType string

(Updatable) The type of the object that contains the database column.

SensitiveTypeId string

(Updatable) The OCID of the sensitive type to be associated with the masking column. Note that if the maskingFormats attribute isn't provided while creating a masking column, the default masking format associated with the specified sensitive type is assigned to the masking column.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

ColumnName string

MaskingPolicyId string

The OCID of the masking policy.

Object string

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

SchemaName string

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

IsMaskingEnabled bool

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the column.

MaskingColumnGroup string

MaskingFormats []MaskingPoliciesMaskingColumnMaskingFormatArgs

ObjectType string

(Updatable) The type of the object that contains the database column.

SensitiveTypeId string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

columnName String

maskingPolicyId String

The OCID of the masking policy.

object String

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

schemaName String

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

isMaskingEnabled Boolean

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the column.

maskingColumnGroup String

maskingFormats List<MaskingPoliciesMaskingColumnMaskingFormat>

objectType String

(Updatable) The type of the object that contains the database column.

sensitiveTypeId String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

columnName string

maskingPolicyId string

The OCID of the masking policy.

object string

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

schemaName string

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

isMaskingEnabled boolean

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the column.

maskingColumnGroup string

maskingFormats MaskingPoliciesMaskingColumnMaskingFormat[]

objectType string

(Updatable) The type of the object that contains the database column.

sensitiveTypeId string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

column_name str

masking_policy_id str

The OCID of the masking policy.

object str

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

schema_name str

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

is_masking_enabled bool

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the column.

masking_column_group str

masking_formats Sequence[datasafe.MaskingPoliciesMaskingColumnMaskingFormatArgs]

object_type str

(Updatable) The type of the object that contains the database column.

sensitive_type_id str

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

columnName String

maskingPolicyId String

The OCID of the masking policy.

object String

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

schemaName String

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

isMaskingEnabled Boolean

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the column.

maskingColumnGroup String

maskingFormats List<Property Map>

objectType String

(Updatable) The type of the object that contains the database column.

sensitiveTypeId String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the MaskingPoliciesMaskingColumn resource produces the following output properties:

ChildColumns List<string>: An array of child columns that are in referential relationship with the masking column.
DataType string: The data type of the masking column.
Id string: The provider-assigned unique ID for this managed resource.
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.
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.
DataType string: The data type of the masking column.
Id string: The provider-assigned unique ID for this managed resource.
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.
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.
dataType String: The data type of the masking column.
id String: The provider-assigned unique ID for this managed resource.
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.
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.
dataType string: The data type of the masking column.
id string: The provider-assigned unique ID for this managed resource.
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.
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.
data_type str: The data type of the masking column.
id str: The provider-assigned unique ID for this managed resource.
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.
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.
dataType String: The data type of the masking column.
id String: The provider-assigned unique ID for this managed resource.
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.
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.

Look up Existing MaskingPoliciesMaskingColumn Resource

Get an existing MaskingPoliciesMaskingColumn resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MaskingPoliciesMaskingColumnState, opts?: CustomResourceOptions): MaskingPoliciesMaskingColumn

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        child_columns: Optional[Sequence[str]] = None,
        column_name: Optional[str] = None,
        data_type: Optional[str] = None,
        is_masking_enabled: Optional[bool] = None,
        key: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        masking_column_group: Optional[str] = None,
        masking_formats: Optional[Sequence[_datasafe.MaskingPoliciesMaskingColumnMaskingFormatArgs]] = None,
        masking_policy_id: Optional[str] = None,
        object: Optional[str] = None,
        object_type: Optional[str] = None,
        schema_name: Optional[str] = None,
        sensitive_type_id: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> MaskingPoliciesMaskingColumn

func GetMaskingPoliciesMaskingColumn(ctx *Context, name string, id IDInput, state *MaskingPoliciesMaskingColumnState, opts ...ResourceOption) (*MaskingPoliciesMaskingColumn, error)

public static MaskingPoliciesMaskingColumn Get(string name, Input<string> id, MaskingPoliciesMaskingColumnState? state, CustomResourceOptions? opts = null)

public static MaskingPoliciesMaskingColumn get(String name, Output<String> id, MaskingPoliciesMaskingColumnState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ChildColumns List<string>

An array of child columns that are in referential relationship with the masking column.

ColumnName string

DataType string

The data type of the masking column.

IsMaskingEnabled bool

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the 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

MaskingFormats List<MaskingPoliciesMaskingColumnMaskingFormat>

MaskingPolicyId string

The OCID of the masking policy.

Object string

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

ObjectType string

(Updatable) The type of the object that contains the database column.

SchemaName string

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

SensitiveTypeId string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

DataType string

The data type of the masking column.

IsMaskingEnabled bool

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the 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

MaskingFormats []MaskingPoliciesMaskingColumnMaskingFormatArgs

MaskingPolicyId string

The OCID of the masking policy.

Object string

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

ObjectType string

(Updatable) The type of the object that contains the database column.

SchemaName string

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

SensitiveTypeId string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

dataType String

The data type of the masking column.

isMaskingEnabled Boolean

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the 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

maskingFormats List<MaskingPoliciesMaskingColumnMaskingFormat>

maskingPolicyId String

The OCID of the masking policy.

object String

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

objectType String

(Updatable) The type of the object that contains the database column.

schemaName String

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

sensitiveTypeId String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

dataType string

The data type of the masking column.

isMaskingEnabled boolean

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the 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

maskingFormats MaskingPoliciesMaskingColumnMaskingFormat[]

maskingPolicyId string

The OCID of the masking policy.

object string

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

objectType string

(Updatable) The type of the object that contains the database column.

schemaName string

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

sensitiveTypeId string

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

data_type str

The data type of the masking column.

is_masking_enabled bool

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the 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

masking_formats Sequence[datasafe.MaskingPoliciesMaskingColumnMaskingFormatArgs]

masking_policy_id str

The OCID of the masking policy.

object str

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

object_type str

(Updatable) The type of the object that contains the database column.

schema_name str

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

sensitive_type_id str

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

dataType String

The data type of the masking column.

isMaskingEnabled Boolean

(Updatable) Indicates whether data masking is enabled for the masking column. Set it to false if you don't want to mask the 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

maskingFormats List<Property Map>

maskingPolicyId String

The OCID of the masking policy.

object String

The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

objectType String

(Updatable) The type of the object that contains the database column.

schemaName String

The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

sensitiveTypeId String

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

MaskingPoliciesMaskingColumnMaskingFormat, MaskingPoliciesMaskingColumnMaskingFormatArgs

FormatEntries List<MaskingPoliciesMaskingColumnMaskingFormatFormatEntry>: (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values.
Condition string: (Updatable) 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: (Updatable) The description of the masking format.

FormatEntries []MaskingPoliciesMaskingColumnMaskingFormatFormatEntry: (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values.
Condition string: (Updatable) 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: (Updatable) The description of the masking format.

formatEntries List<MaskingPoliciesMaskingColumnMaskingFormatFormatEntry>: (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values.
condition String: (Updatable) 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: (Updatable) The description of the masking format.

formatEntries MaskingPoliciesMaskingColumnMaskingFormatFormatEntry[]: (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values.
condition string: (Updatable) 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: (Updatable) The description of the masking format.

format_entries Sequence[datasafe.MaskingPoliciesMaskingColumnMaskingFormatFormatEntry]: (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values.
condition str: (Updatable) 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: (Updatable) The description of the masking format.

formatEntries List<Property Map>: (Updatable) An array of format entries. The combined output of all the format entries is used for masking the column data values.
condition String: (Updatable) 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: (Updatable) The description of the masking format.

MaskingPoliciesMaskingColumnMaskingFormatFormatEntry, MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs

Type string

(Updatable) The type of the format entry.

ColumnName string

(Updatable) The name of the substitution column.

Description string

(Updatable) The description of the format entry.

EndDate string

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The constant number to be used for masking.

FixedString string

(Updatable) The constant string to be used for masking.

GroupingColumns List<string>

(Updatable) 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

(Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.

LibraryMaskingFormatId string

(Updatable) The OCID of the library masking format.

Pattern string

(Updatable) The pattern that should be used to mask data.

PostProcessingFunction string

(Updatable) 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>

(Updatable) 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

(Updatable) 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.

In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format.

If a regular expression is provided, the column values in all the rows must match the regular expression. Deterministic Encryption supports a subset of the regular expression language. It supports encryption of fixed-length strings, and does not support * or + syntax of regular expressions. The encrypted values also match the regular expression, which helps to ensure that the original format is preserved. If an original value does not match the regular expression, Deterministic Encryption might not produce a one-to-one mapping. All non-confirming values are mapped to a single encrypted value, thereby producing a many-to-one mapping.

ReplaceWith string

(Updatable) 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

(Updatable) The name of the schema that contains the substitution column.

SqlExpression string

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The name of the table that contains the substitution column.

UserDefinedFunction string

(Updatable) 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.

Type string

(Updatable) The type of the format entry.

ColumnName string

(Updatable) The name of the substitution column.

Description string

(Updatable) The description of the format entry.

EndDate string

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The constant number to be used for masking.

FixedString string

(Updatable) The constant string to be used for masking.

GroupingColumns []string

Length int

(Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.

LibraryMaskingFormatId string

(Updatable) The OCID of the library masking format.

Pattern string

(Updatable) The pattern that should be used to mask data.

PostProcessingFunction string

(Updatable) 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

RegularExpression string

In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format.

ReplaceWith string

(Updatable) 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

(Updatable) The name of the schema that contains the substitution column.

SqlExpression string

StartDate string

(Updatable) 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

(Updatable) 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

StartValue float64

(Updatable) 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

(Updatable) The name of the table that contains the substitution column.

UserDefinedFunction string

(Updatable) 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.

type String

(Updatable) The type of the format entry.

columnName String

(Updatable) The name of the substitution column.

description String

(Updatable) The description of the format entry.

endDate String

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The constant number to be used for masking.

fixedString String

(Updatable) The constant string to be used for masking.

groupingColumns List<String>

length Integer

(Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.

libraryMaskingFormatId String

(Updatable) The OCID of the library masking format.

pattern String

(Updatable) The pattern that should be used to mask data.

postProcessingFunction String

(Updatable) 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>

regularExpression String

In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format.

replaceWith String

(Updatable) 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

(Updatable) The name of the schema that contains the substitution column.

sqlExpression String

startDate String

(Updatable) 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

(Updatable) 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

startValue Double

(Updatable) 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

(Updatable) The name of the table that contains the substitution column.

userDefinedFunction String

(Updatable) 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.

type string

(Updatable) The type of the format entry.

columnName string

(Updatable) The name of the substitution column.

description string

(Updatable) The description of the format entry.

endDate string

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The constant number to be used for masking.

fixedString string

(Updatable) The constant string to be used for masking.

groupingColumns string[]

length number

(Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.

libraryMaskingFormatId string

(Updatable) The OCID of the library masking format.

pattern string

(Updatable) The pattern that should be used to mask data.

postProcessingFunction string

(Updatable) 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[]

regularExpression string

In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format.

replaceWith string

(Updatable) 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

(Updatable) The name of the schema that contains the substitution column.

sqlExpression string

startDate string

(Updatable) 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

(Updatable) 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

startValue number

(Updatable) 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

(Updatable) The name of the table that contains the substitution column.

userDefinedFunction string

(Updatable) 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.

type str

(Updatable) The type of the format entry.

column_name str

(Updatable) The name of the substitution column.

description str

(Updatable) The description of the format entry.

end_date str

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The constant number to be used for masking.

fixed_string str

(Updatable) The constant string to be used for masking.

grouping_columns Sequence[str]

length int

(Updatable) 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

(Updatable) The OCID of the library masking format.

pattern str

(Updatable) The pattern that should be used to mask data.

post_processing_function str

(Updatable) 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]

regular_expression str

In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format.

replace_with str

(Updatable) 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

(Updatable) The name of the schema that contains the substitution column.

sql_expression str

start_date str

(Updatable) 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

(Updatable) 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

start_value float

(Updatable) 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

(Updatable) The name of the table that contains the substitution column.

user_defined_function str

(Updatable) 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.

type String

(Updatable) The type of the format entry.

columnName String

(Updatable) The name of the substitution column.

description String

(Updatable) The description of the format entry.

endDate String

(Updatable) 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

(Updatable) 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

(Updatable) 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

(Updatable) The constant number to be used for masking.

fixedString String

(Updatable) The constant string to be used for masking.

groupingColumns List<String>

length Number

(Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.

libraryMaskingFormatId String

(Updatable) The OCID of the library masking format.

pattern String

(Updatable) The pattern that should be used to mask data.

postProcessingFunction String

(Updatable) 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>

regularExpression String

In the case of ASCII characters, if a regular expression is not provided, Deterministic Encryption can encrypt variable-length column values while preserving their original format.

replaceWith String

(Updatable) 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

(Updatable) The name of the schema that contains the substitution column.

sqlExpression String

startDate String

(Updatable) 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

(Updatable) 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

startValue Number

(Updatable) 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

(Updatable) The name of the table that contains the substitution column.

userDefinedFunction String

(Updatable) 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.

Import

MaskingPoliciesMaskingColumns can be imported using the id, e.g.

$ pulumi import oci:DataSafe/maskingPoliciesMaskingColumn:MaskingPoliciesMaskingColumn test_masking_policies_masking_column "maskingPolicies/{maskingPolicyId}/maskingColumns/{maskingColumnKey}"

To learn more about importing existing cloud resources, see Importing resources.

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

pulumi/pulumi-oci

oci.DataSafe.MaskingPoliciesMaskingColumn

On this page

On this page

Example Usage

Create MaskingPoliciesMaskingColumn Resource

Constructor syntax

Parameters

Constructor example

MaskingPoliciesMaskingColumn Resource Properties

Inputs

Outputs

Look up Existing MaskingPoliciesMaskingColumn Resource

Supporting Types

MaskingPoliciesMaskingColumnMaskingFormat, MaskingPoliciesMaskingColumnMaskingFormatArgs

MaskingPoliciesMaskingColumnMaskingFormatFormatEntry, MaskingPoliciesMaskingColumnMaskingFormatFormatEntryArgs

Import

Package Details

On this page

On this page