oci.DataSafe.getLibraryMaskingFormats
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testLibraryMaskingFormats = oci.DataSafe.getLibraryMaskingFormats({
compartmentId: compartmentId,
accessLevel: libraryMaskingFormatAccessLevel,
compartmentIdInSubtree: libraryMaskingFormatCompartmentIdInSubtree,
displayName: libraryMaskingFormatDisplayName,
libraryMaskingFormatId: testLibraryMaskingFormat.id,
libraryMaskingFormatSource: libraryMaskingFormatLibraryMaskingFormatSource,
state: libraryMaskingFormatState,
timeCreatedGreaterThanOrEqualTo: libraryMaskingFormatTimeCreatedGreaterThanOrEqualTo,
timeCreatedLessThan: libraryMaskingFormatTimeCreatedLessThan,
});
import pulumi
import pulumi_oci as oci
test_library_masking_formats = oci.DataSafe.get_library_masking_formats(compartment_id=compartment_id,
access_level=library_masking_format_access_level,
compartment_id_in_subtree=library_masking_format_compartment_id_in_subtree,
display_name=library_masking_format_display_name,
library_masking_format_id=test_library_masking_format["id"],
library_masking_format_source=library_masking_format_library_masking_format_source,
state=library_masking_format_state,
time_created_greater_than_or_equal_to=library_masking_format_time_created_greater_than_or_equal_to,
time_created_less_than=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: compartmentId,
AccessLevel: pulumi.StringRef(libraryMaskingFormatAccessLevel),
CompartmentIdInSubtree: pulumi.BoolRef(libraryMaskingFormatCompartmentIdInSubtree),
DisplayName: pulumi.StringRef(libraryMaskingFormatDisplayName),
LibraryMaskingFormatId: pulumi.StringRef(testLibraryMaskingFormat.Id),
LibraryMaskingFormatSource: pulumi.StringRef(libraryMaskingFormatLibraryMaskingFormatSource),
State: pulumi.StringRef(libraryMaskingFormatState),
TimeCreatedGreaterThanOrEqualTo: pulumi.StringRef(libraryMaskingFormatTimeCreatedGreaterThanOrEqualTo),
TimeCreatedLessThan: pulumi.StringRef(libraryMaskingFormatTimeCreatedLessThan),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testLibraryMaskingFormats = Oci.DataSafe.GetLibraryMaskingFormats.Invoke(new()
{
CompartmentId = compartmentId,
AccessLevel = libraryMaskingFormatAccessLevel,
CompartmentIdInSubtree = libraryMaskingFormatCompartmentIdInSubtree,
DisplayName = libraryMaskingFormatDisplayName,
LibraryMaskingFormatId = testLibraryMaskingFormat.Id,
LibraryMaskingFormatSource = libraryMaskingFormatLibraryMaskingFormatSource,
State = libraryMaskingFormatState,
TimeCreatedGreaterThanOrEqualTo = libraryMaskingFormatTimeCreatedGreaterThanOrEqualTo,
TimeCreatedLessThan = libraryMaskingFormatTimeCreatedLessThan,
});
});
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(compartmentId)
.accessLevel(libraryMaskingFormatAccessLevel)
.compartmentIdInSubtree(libraryMaskingFormatCompartmentIdInSubtree)
.displayName(libraryMaskingFormatDisplayName)
.libraryMaskingFormatId(testLibraryMaskingFormat.id())
.libraryMaskingFormatSource(libraryMaskingFormatLibraryMaskingFormatSource)
.state(libraryMaskingFormatState)
.timeCreatedGreaterThanOrEqualTo(libraryMaskingFormatTimeCreatedGreaterThanOrEqualTo)
.timeCreatedLessThan(libraryMaskingFormatTimeCreatedLessThan)
.build());
}
}
variables:
testLibraryMaskingFormats:
fn::invoke:
Function: oci:DataSafe:getLibraryMaskingFormats
Arguments:
compartmentId: ${compartmentId}
accessLevel: ${libraryMaskingFormatAccessLevel}
compartmentIdInSubtree: ${libraryMaskingFormatCompartmentIdInSubtree}
displayName: ${libraryMaskingFormatDisplayName}
libraryMaskingFormatId: ${testLibraryMaskingFormat.id}
libraryMaskingFormatSource: ${libraryMaskingFormatLibraryMaskingFormatSource}
state: ${libraryMaskingFormatState}
timeCreatedGreaterThanOrEqualTo: ${libraryMaskingFormatTimeCreatedGreaterThanOrEqualTo}
timeCreatedLessThan: ${libraryMaskingFormatTimeCreatedLessThan}
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:
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- Access
Level 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.
- Compartment
Id boolIn Subtree - 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 string - A filter to return only resources that match the specified display name.
- Filters
List<Get
Library Masking Formats Filter> - Library
Masking stringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- Library
Masking stringFormat Source - 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.
- Time
Created stringGreater Than Or Equal To 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.
Example: 2016-12-19T16:39:57.600Z
- Time
Created stringLess Than 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.Example: 2016-12-19T16:39:57.600Z
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- Access
Level 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.
- Compartment
Id boolIn Subtree - 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 string - A filter to return only resources that match the specified display name.
- Filters
[]Get
Library Masking Formats Filter - Library
Masking stringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- Library
Masking stringFormat Source - 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.
- Time
Created stringGreater Than Or Equal To 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.
Example: 2016-12-19T16:39:57.600Z
- Time
Created stringLess Than 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.Example: 2016-12-19T16:39:57.600Z
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- access
Level 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.
- compartment
Id BooleanIn Subtree - 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 String - A filter to return only resources that match the specified display name.
- filters
List<Get
Library Masking Formats Filter> - library
Masking StringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- library
Masking StringFormat Source - 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.
- time
Created StringGreater Than Or Equal To 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.
Example: 2016-12-19T16:39:57.600Z
- time
Created StringLess Than 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.Example: 2016-12-19T16:39:57.600Z
- compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- access
Level 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.
- compartment
Id booleanIn Subtree - 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 string - A filter to return only resources that match the specified display name.
- filters
Get
Library Masking Formats Filter[] - library
Masking stringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- library
Masking stringFormat Source - 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.
- time
Created stringGreater Than Or Equal To 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.
Example: 2016-12-19T16:39:57.600Z
- time
Created stringLess Than 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.Example: 2016-12-19T16:39:57.600Z
- 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_ boolin_ subtree - 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
Sequence[datasafe.
Get Library Masking Formats Filter] - library_
masking_ strformat_ id - A filter to return only the resources that match the specified library masking format OCID.
- library_
masking_ strformat_ source - 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_ strgreater_ than_ or_ equal_ to 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.
Example: 2016-12-19T16:39:57.600Z
- time_
created_ strless_ than 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.Example: 2016-12-19T16:39:57.600Z
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- access
Level 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.
- compartment
Id BooleanIn Subtree - 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 String - A filter to return only resources that match the specified display name.
- filters List<Property Map>
- library
Masking StringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- library
Masking StringFormat Source - 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.
- time
Created StringGreater Than Or Equal To 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.
Example: 2016-12-19T16:39:57.600Z
- time
Created StringLess Than 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.Example: 2016-12-19T16:39:57.600Z
getLibraryMaskingFormats Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment that contains the library masking format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Library
Masking List<GetFormat Collections Library Masking Formats Library Masking Format Collection> - The list of library_masking_format_collection.
- Access
Level string - Compartment
Id boolIn Subtree - Display
Name string - The display name of the library masking format.
- Filters
List<Get
Library Masking Formats Filter> - Library
Masking stringFormat Id - The OCID of the library masking format.
- Library
Masking stringFormat Source - State string
- The current state of the library masking format.
- Time
Created stringGreater Than Or Equal To - Time
Created stringLess Than
- Compartment
Id string - The OCID of the compartment that contains the library masking format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Library
Masking []GetFormat Collections Library Masking Formats Library Masking Format Collection - The list of library_masking_format_collection.
- Access
Level string - Compartment
Id boolIn Subtree - Display
Name string - The display name of the library masking format.
- Filters
[]Get
Library Masking Formats Filter - Library
Masking stringFormat Id - The OCID of the library masking format.
- Library
Masking stringFormat Source - State string
- The current state of the library masking format.
- Time
Created stringGreater Than Or Equal To - Time
Created stringLess Than
- compartment
Id String - The OCID of the compartment that contains the library masking format.
- id String
- The provider-assigned unique ID for this managed resource.
- library
Masking List<GetFormat Collections Library Masking Formats Library Masking Format Collection> - The list of library_masking_format_collection.
- access
Level String - compartment
Id BooleanIn Subtree - display
Name String - The display name of the library masking format.
- filters
List<Get
Library Masking Formats Filter> - library
Masking StringFormat Id - The OCID of the library masking format.
- library
Masking StringFormat Source - state String
- The current state of the library masking format.
- time
Created StringGreater Than Or Equal To - time
Created StringLess Than
- compartment
Id string - The OCID of the compartment that contains the library masking format.
- id string
- The provider-assigned unique ID for this managed resource.
- library
Masking GetFormat Collections Library Masking Formats Library Masking Format Collection[] - The list of library_masking_format_collection.
- access
Level string - compartment
Id booleanIn Subtree - display
Name string - The display name of the library masking format.
- filters
Get
Library Masking Formats Filter[] - library
Masking stringFormat Id - The OCID of the library masking format.
- library
Masking stringFormat Source - state string
- The current state of the library masking format.
- time
Created stringGreater Than Or Equal To - time
Created stringLess Than
- 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_ Sequence[datasafe.format_ collections Get Library Masking Formats Library Masking Format Collection] - The list of library_masking_format_collection.
- access_
level str - compartment_
id_ boolin_ subtree - display_
name str - The display name of the library masking format.
- filters
Sequence[datasafe.
Get Library Masking Formats Filter] - library_
masking_ strformat_ id - The OCID of the library masking format.
- library_
masking_ strformat_ source - state str
- The current state of the library masking format.
- time_
created_ strgreater_ than_ or_ equal_ to - time_
created_ strless_ than
- compartment
Id String - The OCID of the compartment that contains the library masking format.
- id String
- The provider-assigned unique ID for this managed resource.
- library
Masking List<Property Map>Format Collections - The list of library_masking_format_collection.
- access
Level String - compartment
Id BooleanIn Subtree - display
Name String - The display name of the library masking format.
- filters List<Property Map>
- library
Masking StringFormat Id - The OCID of the library masking format.
- library
Masking StringFormat Source - state String
- The current state of the library masking format.
- time
Created StringGreater Than Or Equal To - time
Created StringLess Than
Supporting Types
GetLibraryMaskingFormatsFilter
GetLibraryMaskingFormatsLibraryMaskingFormatCollection
GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItem
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- 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.
- Display
Name string - A filter to return only resources that match the specified display name.
- Format
Entries List<GetLibrary Masking Formats Library Masking Format Collection Item Format Entry> - An array of format entries. The combined output of all the format entries is used for masking.
- 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.
- Sensitive
Type List<string>Ids - 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.
- Time
Created string - The date and time the library masking format was created, in the format defined by RFC3339
- Time
Updated string - The date and time the library masking format was updated, in the format defined by RFC3339
- Compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- 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.
- Display
Name string - A filter to return only resources that match the specified display name.
- Format
Entries []GetLibrary Masking Formats Library Masking Format Collection Item Format Entry - An array of format entries. The combined output of all the format entries is used for masking.
- 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.
- Sensitive
Type []stringIds - 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.
- Time
Created string - The date and time the library masking format was created, in the format defined by RFC3339
- Time
Updated string - The date and time the library masking format was updated, in the format defined by RFC3339
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- 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.
- display
Name String - A filter to return only resources that match the specified display name.
- format
Entries List<GetLibrary Masking Formats Library Masking Format Collection Item Format Entry> - An array of format entries. The combined output of all the format entries is used for masking.
- 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.
- sensitive
Type List<String>Ids - 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.
- time
Created String - The date and time the library masking format was created, in the format defined by RFC3339
- time
Updated String - The date and time the library masking format was updated, in the format defined by RFC3339
- compartment
Id string - A filter to return only resources that match the specified compartment OCID.
- {[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.
- display
Name string - A filter to return only resources that match the specified display name.
- format
Entries GetLibrary Masking Formats Library Masking Format Collection Item Format Entry[] - An array of format entries. The combined output of all the format entries is used for masking.
- {[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.
- sensitive
Type string[]Ids - 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.
- time
Created string - The date and time the library masking format was created, in the format defined by RFC3339
- time
Updated 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.
- 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 Sequence[datasafe.Get Library Masking Formats Library Masking Format Collection Item Format Entry] - An array of format entries. The combined output of all the format entries is used for masking.
- 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_ Sequence[str]ids - 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
- compartment
Id String - A filter to return only resources that match the specified compartment OCID.
- 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.
- display
Name String - A filter to return only resources that match the specified display name.
- format
Entries List<Property Map> - An array of format entries. The combined output of all the format entries is used for masking.
- 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.
- sensitive
Type List<String>Ids - 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.
- time
Created String - The date and time the library masking format was created, in the format defined by RFC3339
- time
Updated String - The date and time the library masking format was updated, in the format defined by RFC3339
GetLibraryMaskingFormatsLibraryMaskingFormatCollectionItemFormatEntry
- Column
Name string - The name of the substitution column.
- Description string
- The description of the format entry.
- End
Date 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.
- 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 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.
- Fixed
Number double - The constant number to be used for masking.
- Fixed
String string - The constant string to be used for masking.
- Grouping
Columns 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.
- Library
Masking stringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- Pattern string
- The pattern that should be used to mask data.
- Post
Processing stringFunction - 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 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.
- Regular
Expression 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.
- Replace
With 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.
- Schema
Name string - The name of the schema that contains the substitution column.
- Sql
Expression 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.
- Start
Date 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.
- 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 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.
- Table
Name string - The name of the table that contains the substitution column.
- Type string
- The type of the format entry.
- User
Defined stringFunction - 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 string - The name of the substitution column.
- Description string
- The description of the format entry.
- End
Date 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.
- 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 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.
- Fixed
Number float64 - The constant number to be used for masking.
- Fixed
String string - The constant string to be used for masking.
- Grouping
Columns []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.
- Library
Masking stringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- Pattern string
- The pattern that should be used to mask data.
- Post
Processing stringFunction - 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 []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.
- Regular
Expression 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.
- Replace
With 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.
- Schema
Name string - The name of the schema that contains the substitution column.
- Sql
Expression 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.
- Start
Date 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.
- 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 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.
- Table
Name string - The name of the table that contains the substitution column.
- Type string
- The type of the format entry.
- User
Defined stringFunction - 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 String - The name of the substitution column.
- description String
- The description of the format entry.
- end
Date 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.
- end
Length 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.
- end
Value 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.
- fixed
Number Double - The constant number to be used for masking.
- fixed
String String - The constant string to be used for masking.
- grouping
Columns 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.
- library
Masking StringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- pattern String
- The pattern that should be used to mask data.
- post
Processing StringFunction - 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 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.
- regular
Expression 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.
- replace
With 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.
- schema
Name String - The name of the schema that contains the substitution column.
- sql
Expression 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.
- start
Date 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.
- start
Length 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.
- start
Position 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.
- start
Value 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.
- table
Name String - The name of the table that contains the substitution column.
- type String
- The type of the format entry.
- user
Defined StringFunction - 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 string - The name of the substitution column.
- description string
- The description of the format entry.
- end
Date 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.
- end
Length 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.
- end
Value 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.
- fixed
Number number - The constant number to be used for masking.
- fixed
String string - The constant string to be used for masking.
- grouping
Columns 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.
- library
Masking stringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- pattern string
- The pattern that should be used to mask data.
- post
Processing stringFunction - 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 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.
- regular
Expression 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.
- replace
With 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.
- schema
Name string - The name of the schema that contains the substitution column.
- sql
Expression 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.
- start
Date 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.
- start
Length 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.
- start
Position 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.
- start
Value 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.
- table
Name string - The name of the table that contains the substitution column.
- type string
- The type of the format entry.
- user
Defined stringFunction - 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_ strformat_ id - A filter to return only the resources that match the specified library masking format OCID.
- pattern str
- The pattern that should be used to mask data.
- post_
processing_ strfunction - 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_ strfunction - 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 String - The name of the substitution column.
- description String
- The description of the format entry.
- end
Date 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.
- end
Length 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.
- end
Value 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.
- fixed
Number Number - The constant number to be used for masking.
- fixed
String String - The constant string to be used for masking.
- grouping
Columns 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.
- library
Masking StringFormat Id - A filter to return only the resources that match the specified library masking format OCID.
- pattern String
- The pattern that should be used to mask data.
- post
Processing StringFunction - 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 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.
- regular
Expression 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.
- replace
With 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.
- schema
Name String - The name of the schema that contains the substitution column.
- sql
Expression 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.
- start
Date 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.
- start
Length 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.
- start
Position 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.
- start
Value 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.
- table
Name String - The name of the table that contains the substitution column.
- type String
- The type of the format entry.
- user
Defined StringFunction - The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.