Data Source: oci_data_safe_library_masking_formats

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

data "oci_data_safe_library_masking_formats" "test_library_masking_formats" {
	#Required
	compartment_id = var.compartment_id

	#Optional
	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
}

Argument Reference

The following arguments are supported:

• access_level - (Optional) 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 - (Required) A filter to return only resources that match the specified compartment OCID.

• compartment_id_in_subtree - (Optional) 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 - (Optional) A filter to return only resources that match the specified display name.

• library_masking_format_id - (Optional) A filter to return only the resources that match the specified library masking format OCID.

• library_masking_format_source - (Optional) A filter to return the library masking format resources based on the value of their source attribute.

• state - (Optional) A filter to return only the resources that match the specified lifecycle states.

• time_created_greater_than_or_equal_to - (Optional) 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_less_than - (Optional) 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

Attributes Reference

The following attributes are exported:

• library_masking_format_collection - The list of library_masking_format_collection.

LibraryMaskingFormat Reference

The following attributes are exported:

• compartment_id - The OCID of the compartment that contains the library masking format.

• defined_tags - 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 - The description of the library masking format.

• display_name - The display name of the library masking format.

• format_entries - An array of format entries. The combined output of all the format entries is used for masking.

  • column_name - The name of the substitution column.

  • description - The description of the format entry.

  • end_date - 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 - 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 - 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 - The constant number to be used for masking.

  • fixed_string - The constant string to be used for masking.

  • grouping_columns - 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 - The number of characters that should be there in the substring. It should be an integer and greater than zero.
    

  • library_masking_format_id - The OCID of the library masking format.

  • pattern - The pattern that should be used to mask data.

  • post_processing_function - 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_list - 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 - The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

  • replace_with - 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 - The name of the schema that contains the substitution column.

  • sql_expression - 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 - 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 - 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 - 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 - 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 - The name of the table that contains the substitution column.

  • type - The type of the format entry.

  • user_defined_function - 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.

• freeform_tags - 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 - The OCID of the library masking format.

• sensitive_type_ids - An array of OCIDs of the sensitive types compatible with the library masking format.

• source - Specifies whether the library masking format is user-defined or predefined.

• state - The current state of the library masking format.

• time_created - The date and time the library masking format was created, in the format defined by RFC3339

• time_updated - The date and time the library masking format was updated, in the format defined by RFC3339