Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getLibraryMaskingFormats

This data source provides the list of Library Masking Formats in Oracle Cloud Infrastructure Data Safe service.

Gets a list of library masking formats based on the specified query parameters.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testLibraryMaskingFormats = Oci.DataSafe.GetLibraryMaskingFormats.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        AccessLevel = @var.Library_masking_format_access_level,
        CompartmentIdInSubtree = @var.Library_masking_format_compartment_id_in_subtree,
        DisplayName = @var.Library_masking_format_display_name,
        LibraryMaskingFormatId = oci_data_safe_library_masking_format.Test_library_masking_format.Id,
        LibraryMaskingFormatSource = @var.Library_masking_format_library_masking_format_source,
        State = @var.Library_masking_format_state,
        TimeCreatedGreaterThanOrEqualTo = @var.Library_masking_format_time_created_greater_than_or_equal_to,
        TimeCreatedLessThan = @var.Library_masking_format_time_created_less_than,
    });

});
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.GetLibraryMaskingFormats(ctx, &datasafe.GetLibraryMaskingFormatsArgs{
			CompartmentId:                   _var.Compartment_id,
			AccessLevel:                     pulumi.StringRef(_var.Library_masking_format_access_level),
			CompartmentIdInSubtree:          pulumi.BoolRef(_var.Library_masking_format_compartment_id_in_subtree),
			DisplayName:                     pulumi.StringRef(_var.Library_masking_format_display_name),
			LibraryMaskingFormatId:          pulumi.StringRef(oci_data_safe_library_masking_format.Test_library_masking_format.Id),
			LibraryMaskingFormatSource:      pulumi.StringRef(_var.Library_masking_format_library_masking_format_source),
			State:                           pulumi.StringRef(_var.Library_masking_format_state),
			TimeCreatedGreaterThanOrEqualTo: pulumi.StringRef(_var.Library_masking_format_time_created_greater_than_or_equal_to),
			TimeCreatedLessThan:             pulumi.StringRef(_var.Library_masking_format_time_created_less_than),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeFunctions;
import com.pulumi.oci.DataSafe.inputs.GetLibraryMaskingFormatsArgs;
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 testLibraryMaskingFormats = DataSafeFunctions.getLibraryMaskingFormats(GetLibraryMaskingFormatsArgs.builder()
            .compartmentId(var_.compartment_id())
            .accessLevel(var_.library_masking_format_access_level())
            .compartmentIdInSubtree(var_.library_masking_format_compartment_id_in_subtree())
            .displayName(var_.library_masking_format_display_name())
            .libraryMaskingFormatId(oci_data_safe_library_masking_format.test_library_masking_format().id())
            .libraryMaskingFormatSource(var_.library_masking_format_library_masking_format_source())
            .state(var_.library_masking_format_state())
            .timeCreatedGreaterThanOrEqualTo(var_.library_masking_format_time_created_greater_than_or_equal_to())
            .timeCreatedLessThan(var_.library_masking_format_time_created_less_than())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_library_masking_formats = oci.DataSafe.get_library_masking_formats(compartment_id=var["compartment_id"],
    access_level=var["library_masking_format_access_level"],
    compartment_id_in_subtree=var["library_masking_format_compartment_id_in_subtree"],
    display_name=var["library_masking_format_display_name"],
    library_masking_format_id=oci_data_safe_library_masking_format["test_library_masking_format"]["id"],
    library_masking_format_source=var["library_masking_format_library_masking_format_source"],
    state=var["library_masking_format_state"],
    time_created_greater_than_or_equal_to=var["library_masking_format_time_created_greater_than_or_equal_to"],
    time_created_less_than=var["library_masking_format_time_created_less_than"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLibraryMaskingFormats = oci.DataSafe.getLibraryMaskingFormats({
    compartmentId: _var.compartment_id,
    accessLevel: _var.library_masking_format_access_level,
    compartmentIdInSubtree: _var.library_masking_format_compartment_id_in_subtree,
    displayName: _var.library_masking_format_display_name,
    libraryMaskingFormatId: oci_data_safe_library_masking_format.test_library_masking_format.id,
    libraryMaskingFormatSource: _var.library_masking_format_library_masking_format_source,
    state: _var.library_masking_format_state,
    timeCreatedGreaterThanOrEqualTo: _var.library_masking_format_time_created_greater_than_or_equal_to,
    timeCreatedLessThan: _var.library_masking_format_time_created_less_than,
});
variables:
  testLibraryMaskingFormats:
    Fn::Invoke:
      Function: oci:DataSafe:getLibraryMaskingFormats
      Arguments:
        compartmentId: ${var.compartment_id}
        accessLevel: ${var.library_masking_format_access_level}
        compartmentIdInSubtree: ${var.library_masking_format_compartment_id_in_subtree}
        displayName: ${var.library_masking_format_display_name}
        libraryMaskingFormatId: ${oci_data_safe_library_masking_format.test_library_masking_format.id}
        libraryMaskingFormatSource: ${var.library_masking_format_library_masking_format_source}
        state: ${var.library_masking_format_state}
        timeCreatedGreaterThanOrEqualTo: ${var.library_masking_format_time_created_greater_than_or_equal_to}
        timeCreatedLessThan: ${var.library_masking_format_time_created_less_than}

Using getLibraryMaskingFormats

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 getLibraryMaskingFormats(args: GetLibraryMaskingFormatsArgs, opts?: InvokeOptions): Promise<GetLibraryMaskingFormatsResult>
function getLibraryMaskingFormatsOutput(args: GetLibraryMaskingFormatsOutputArgs, opts?: InvokeOptions): Output<GetLibraryMaskingFormatsResult>
def get_library_masking_formats(access_level: Optional[str] = None,
                                compartment_id: Optional[str] = None,
                                compartment_id_in_subtree: Optional[bool] = None,
                                display_name: Optional[str] = None,
                                filters: Optional[Sequence[_datasafe.GetLibraryMaskingFormatsFilter]] = None,
                                library_masking_format_id: Optional[str] = None,
                                library_masking_format_source: Optional[str] = None,
                                state: Optional[str] = None,
                                time_created_greater_than_or_equal_to: Optional[str] = None,
                                time_created_less_than: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetLibraryMaskingFormatsResult
def get_library_masking_formats_output(access_level: Optional[pulumi.Input[str]] = None,
                                compartment_id: Optional[pulumi.Input[str]] = None,
                                compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                                display_name: Optional[pulumi.Input[str]] = None,
                                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_datasafe.GetLibraryMaskingFormatsFilterArgs]]]] = None,
                                library_masking_format_id: Optional[pulumi.Input[str]] = None,
                                library_masking_format_source: Optional[pulumi.Input[str]] = None,
                                state: Optional[pulumi.Input[str]] = None,
                                time_created_greater_than_or_equal_to: Optional[pulumi.Input[str]] = None,
                                time_created_less_than: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetLibraryMaskingFormatsResult]
func GetLibraryMaskingFormats(ctx *Context, args *GetLibraryMaskingFormatsArgs, opts ...InvokeOption) (*GetLibraryMaskingFormatsResult, error)
func GetLibraryMaskingFormatsOutput(ctx *Context, args *GetLibraryMaskingFormatsOutputArgs, opts ...InvokeOption) GetLibraryMaskingFormatsResultOutput

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

public static class GetLibraryMaskingFormats 
{
    public static Task<GetLibraryMaskingFormatsResult> InvokeAsync(GetLibraryMaskingFormatsArgs args, InvokeOptions? opts = null)
    public static Output<GetLibraryMaskingFormatsResult> Invoke(GetLibraryMaskingFormatsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLibraryMaskingFormatsResult> getLibraryMaskingFormats(GetLibraryMaskingFormatsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:DataSafe/getLibraryMaskingFormats:getLibraryMaskingFormats
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

AccessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentIdInSubtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName string

A filter to return only resources that match the specified display name.

Filters List<GetLibraryMaskingFormatsFilter>
LibraryMaskingFormatId string

A filter to return only the resources that match the specified library masking format OCID.

LibraryMaskingFormatSource string

A filter to return the library masking format resources based on the value of their source attribute.

State string

A filter to return only the resources that match the specified lifecycle states.

TimeCreatedGreaterThanOrEqualTo string

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

TimeCreatedLessThan string

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

AccessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentIdInSubtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

DisplayName string

A filter to return only resources that match the specified display name.

Filters []GetLibraryMaskingFormatsFilter
LibraryMaskingFormatId string

A filter to return only the resources that match the specified library masking format OCID.

LibraryMaskingFormatSource string

A filter to return the library masking format resources based on the value of their source attribute.

State string

A filter to return only the resources that match the specified lifecycle states.

TimeCreatedGreaterThanOrEqualTo string

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

TimeCreatedLessThan string

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

accessLevel String

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree Boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName String

A filter to return only resources that match the specified display name.

filters List<GetLibraryMaskingFormatsFilter>
libraryMaskingFormatId String

A filter to return only the resources that match the specified library masking format OCID.

libraryMaskingFormatSource String

A filter to return the library masking format resources based on the value of their source attribute.

state String

A filter to return only the resources that match the specified lifecycle states.

timeCreatedGreaterThanOrEqualTo String

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

timeCreatedLessThan String

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

compartmentId string

A filter to return only resources that match the specified compartment OCID.

accessLevel string

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName string

A filter to return only resources that match the specified display name.

filters GetLibraryMaskingFormatsFilter[]
libraryMaskingFormatId string

A filter to return only the resources that match the specified library masking format OCID.

libraryMaskingFormatSource string

A filter to return the library masking format resources based on the value of their source attribute.

state string

A filter to return only the resources that match the specified lifecycle states.

timeCreatedGreaterThanOrEqualTo string

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

timeCreatedLessThan string

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

compartment_id str

A filter to return only resources that match the specified compartment OCID.

access_level str

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartment_id_in_subtree bool

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

display_name str

A filter to return only resources that match the specified display name.

filters GetLibraryMaskingFormatsFilter]
library_masking_format_id str

A filter to return only the resources that match the specified library masking format OCID.

library_masking_format_source str

A filter to return the library masking format resources based on the value of their source attribute.

state str

A filter to return only the resources that match the specified lifecycle states.

time_created_greater_than_or_equal_to str

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

time_created_less_than str

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

compartmentId String

A filter to return only resources that match the specified compartment OCID.

accessLevel String

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

compartmentIdInSubtree Boolean

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

displayName String

A filter to return only resources that match the specified display name.

filters List<Property Map>
libraryMaskingFormatId String

A filter to return only the resources that match the specified library masking format OCID.

libraryMaskingFormatSource String

A filter to return the library masking format resources based on the value of their source attribute.

state String

A filter to return only the resources that match the specified lifecycle states.

timeCreatedGreaterThanOrEqualTo String

A filter to return only the resources that were created after the specified date and time, as defined by RFC3339. Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.

timeCreatedLessThan String

Search for resources that were created before a specific date. Specifying this parameter corresponding timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

getLibraryMaskingFormats Result

The following output properties are available:

CompartmentId string

The OCID of the compartment that contains the library masking format.

Id string

The provider-assigned unique ID for this managed resource.

LibraryMaskingFormatCollections List<GetLibraryMaskingFormatsLibraryMaskingFormatCollection>

The list of library_masking_format_collection.

AccessLevel string
CompartmentIdInSubtree bool
DisplayName string

The display name of the library masking format.

Filters List<GetLibraryMaskingFormatsFilter>
LibraryMaskingFormatId string

The OCID of the library masking format.

LibraryMaskingFormatSource string
State string

The current state of the library masking format.

TimeCreatedGreaterThanOrEqualTo string
TimeCreatedLessThan string
CompartmentId string

The OCID of the compartment that contains the library masking format.

Id string

The provider-assigned unique ID for this managed resource.

LibraryMaskingFormatCollections []GetLibraryMaskingFormatsLibraryMaskingFormatCollection

The list of library_masking_format_collection.

AccessLevel string
CompartmentIdInSubtree bool
DisplayName string

The display name of the library masking format.

Filters []GetLibraryMaskingFormatsFilter
LibraryMaskingFormatId string

The OCID of the library masking format.

LibraryMaskingFormatSource string
State string

The current state of the library masking format.

TimeCreatedGreaterThanOrEqualTo string
TimeCreatedLessThan string
compartmentId String

The OCID of the compartment that contains the library masking format.

id String

The provider-assigned unique ID for this managed resource.

libraryMaskingFormatCollections List<GetLibraryMaskingFormatsLibraryMaskingFormatCollection>

The list of library_masking_format_collection.

accessLevel String
compartmentIdInSubtree Boolean
displayName String

The display name of the library masking format.

filters List<GetLibraryMaskingFormatsFilter>
libraryMaskingFormatId String

The OCID of the library masking format.

libraryMaskingFormatSource String
state String

The current state of the library masking format.

timeCreatedGreaterThanOrEqualTo String
timeCreatedLessThan String
compartmentId string

The OCID of the compartment that contains the library masking format.

id string

The provider-assigned unique ID for this managed resource.

libraryMaskingFormatCollections GetLibraryMaskingFormatsLibraryMaskingFormatCollection[]

The list of library_masking_format_collection.

accessLevel string
compartmentIdInSubtree boolean
displayName string

The display name of the library masking format.

filters GetLibraryMaskingFormatsFilter[]
libraryMaskingFormatId string

The OCID of the library masking format.

libraryMaskingFormatSource string
state string

The current state of the library masking format.

timeCreatedGreaterThanOrEqualTo string
timeCreatedLessThan string
compartment_id str

The OCID of the compartment that contains the library masking format.

id str

The provider-assigned unique ID for this managed resource.

library_masking_format_collections GetLibraryMaskingFormatsLibraryMaskingFormatCollection]

The list of library_masking_format_collection.

access_level str
compartment_id_in_subtree bool
display_name str

The display name of the library masking format.

filters GetLibraryMaskingFormatsFilter]
library_masking_format_id str

The OCID of the library masking format.

library_masking_format_source str
state str

The current state of the library masking format.

time_created_greater_than_or_equal_to str
time_created_less_than str
compartmentId String

The OCID of the compartment that contains the library masking format.

id String

The provider-assigned unique ID for this managed resource.

libraryMaskingFormatCollections List<Property Map>

The list of library_masking_format_collection.

accessLevel String
compartmentIdInSubtree Boolean
displayName String

The display name of the library masking format.

filters List<Property Map>
libraryMaskingFormatId String

The OCID of the library masking format.

libraryMaskingFormatSource String
state String

The current state of the library masking format.

timeCreatedGreaterThanOrEqualTo String
timeCreatedLessThan String

Supporting Types

GetLibraryMaskingFormatsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

GetLibraryMaskingFormatsLibraryMaskingFormatCollection

GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItem

CompartmentId string

A filter to return only resources that match the specified compartment OCID.

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

A filter to return only resources that match the specified display name.

FormatEntries List<GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry>

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.

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

A filter to return only the resources that match the specified lifecycle states.

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

A filter to return only resources that match the specified compartment OCID.

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

A filter to return only resources that match the specified display name.

FormatEntries []GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry

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.

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

A filter to return only the resources that match the specified lifecycle states.

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

A filter to return only resources that match the specified compartment OCID.

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

A filter to return only resources that match the specified display name.

formatEntries List<GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry>

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.

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

A filter to return only the resources that match the specified lifecycle states.

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

A filter to return only resources that match the specified compartment OCID.

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

A filter to return only resources that match the specified display name.

formatEntries GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry[]

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.

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

A filter to return only the resources that match the specified lifecycle states.

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

A filter to return only resources that match the specified compartment OCID.

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

A filter to return only resources that match the specified display name.

format_entries GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry]

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.

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

A filter to return only the resources that match the specified lifecycle states.

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

A filter to return only resources that match the specified compartment OCID.

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

A filter to return only resources that match the specified display name.

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.

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

A filter to return only the resources that match the specified lifecycle states.

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

GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry

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

A filter to return only the resources that match the specified library masking format OCID.

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

A filter to return only the resources that match the specified library masking format OCID.

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

A filter to return only the resources that match the specified library masking format OCID.

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

A filter to return only the resources that match the specified library masking format OCID.

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

A filter to return only the resources that match the specified library masking format OCID.

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

A filter to return only the resources that match the specified library masking format OCID.

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
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.