1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. LibraryMasingFormat
Oracle Cloud Infrastructure v1.27.0 published on Friday, Mar 15, 2024 by Pulumi

oci.DataSafe.LibraryMasingFormat

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.27.0 published on Friday, Mar 15, 2024 by Pulumi

    This resource provides the Library Masking Format resource in Oracle Cloud Infrastructure Data Safe service.

    Creates a new library masking format. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking. Note that you cannot define masking condition in a library masking format.

    Create LibraryMasingFormat Resource

    new LibraryMasingFormat(name: string, args: LibraryMasingFormatArgs, opts?: CustomResourceOptions);
    @overload
    def LibraryMasingFormat(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            compartment_id: Optional[str] = None,
                            defined_tags: Optional[Mapping[str, Any]] = None,
                            description: Optional[str] = None,
                            display_name: Optional[str] = None,
                            format_entries: Optional[Sequence[_datasafe.LibraryMasingFormatFormatEntryArgs]] = None,
                            freeform_tags: Optional[Mapping[str, Any]] = None,
                            sensitive_type_ids: Optional[Sequence[str]] = None)
    @overload
    def LibraryMasingFormat(resource_name: str,
                            args: LibraryMasingFormatArgs,
                            opts: Optional[ResourceOptions] = None)
    func NewLibraryMasingFormat(ctx *Context, name string, args LibraryMasingFormatArgs, opts ...ResourceOption) (*LibraryMasingFormat, error)
    public LibraryMasingFormat(string name, LibraryMasingFormatArgs args, CustomResourceOptions? opts = null)
    public LibraryMasingFormat(String name, LibraryMasingFormatArgs args)
    public LibraryMasingFormat(String name, LibraryMasingFormatArgs args, CustomResourceOptions options)
    
    type: oci:DataSafe:LibraryMasingFormat
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args LibraryMasingFormatArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LibraryMasingFormatArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LibraryMasingFormatArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LibraryMasingFormatArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LibraryMasingFormatArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LibraryMasingFormat Resource Properties

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

    Inputs

    The LibraryMasingFormat resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment where the library masking format should be created.
    FormatEntries List<LibraryMasingFormatFormatEntry>
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    DefinedTags Dictionary<string, object>
    (Updatable) 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
    (Updatable) The description of the format entry.
    DisplayName string
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    SensitiveTypeIds List<string>

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    CompartmentId string
    (Updatable) The OCID of the compartment where the library masking format should be created.
    FormatEntries []LibraryMasingFormatFormatEntryArgs
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    DefinedTags map[string]interface{}
    (Updatable) 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
    (Updatable) The description of the format entry.
    DisplayName string
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    FreeformTags map[string]interface{}
    (Updatable) 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"}
    SensitiveTypeIds []string

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    compartmentId String
    (Updatable) The OCID of the compartment where the library masking format should be created.
    formatEntries List<LibraryMasingFormatFormatEntry>
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    definedTags Map<String,Object>
    (Updatable) 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
    (Updatable) The description of the format entry.
    displayName String
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    freeformTags Map<String,Object>
    (Updatable) 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"}
    sensitiveTypeIds List<String>

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    compartmentId string
    (Updatable) The OCID of the compartment where the library masking format should be created.
    formatEntries LibraryMasingFormatFormatEntry[]
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    definedTags {[key: string]: any}
    (Updatable) 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
    (Updatable) The description of the format entry.
    displayName string
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    freeformTags {[key: string]: any}
    (Updatable) 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"}
    sensitiveTypeIds string[]

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    compartment_id str
    (Updatable) The OCID of the compartment where the library masking format should be created.
    format_entries LibraryMasingFormatFormatEntryArgs]
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    defined_tags Mapping[str, Any]
    (Updatable) 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
    (Updatable) The description of the format entry.
    display_name str
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    sensitive_type_ids Sequence[str]

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    compartmentId String
    (Updatable) The OCID of the compartment where the library masking format should be created.
    formatEntries List<Property Map>
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    definedTags Map<Any>
    (Updatable) 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
    (Updatable) The description of the format entry.
    displayName String
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    freeformTags Map<Any>
    (Updatable) 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"}
    sensitiveTypeIds List<String>

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Source string
    Specifies whether the library masking format is user-defined or predefined.
    State string
    The current state of the library masking format.
    TimeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    TimeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    Id string
    The provider-assigned unique ID for this managed resource.
    Source string
    Specifies whether the library masking format is user-defined or predefined.
    State string
    The current state of the library masking format.
    TimeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    TimeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    id String
    The provider-assigned unique ID for this managed resource.
    source String
    Specifies whether the library masking format is user-defined or predefined.
    state String
    The current state of the library masking format.
    timeCreated String
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated String
    The date and time the library masking format was updated, in the format defined by RFC3339
    id string
    The provider-assigned unique ID for this managed resource.
    source string
    Specifies whether the library masking format is user-defined or predefined.
    state string
    The current state of the library masking format.
    timeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    id str
    The provider-assigned unique ID for this managed resource.
    source str
    Specifies whether the library masking format is user-defined or predefined.
    state str
    The current state of the library masking format.
    time_created str
    The date and time the library masking format was created, in the format defined by RFC3339
    time_updated str
    The date and time the library masking format was updated, in the format defined by RFC3339
    id String
    The provider-assigned unique ID for this managed resource.
    source String
    Specifies whether the library masking format is user-defined or predefined.
    state String
    The current state of the library masking format.
    timeCreated String
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated String
    The date and time the library masking format was updated, in the format defined by RFC3339

    Look up Existing LibraryMasingFormat Resource

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

    public static get(name: string, id: Input<ID>, state?: LibraryMasingFormatState, opts?: CustomResourceOptions): LibraryMasingFormat
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            format_entries: Optional[Sequence[_datasafe.LibraryMasingFormatFormatEntryArgs]] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            sensitive_type_ids: Optional[Sequence[str]] = None,
            source: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> LibraryMasingFormat
    func GetLibraryMasingFormat(ctx *Context, name string, id IDInput, state *LibraryMasingFormatState, opts ...ResourceOption) (*LibraryMasingFormat, error)
    public static LibraryMasingFormat Get(string name, Input<string> id, LibraryMasingFormatState? state, CustomResourceOptions? opts = null)
    public static LibraryMasingFormat get(String name, Output<String> id, LibraryMasingFormatState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment where the library masking format should be created.
    DefinedTags Dictionary<string, object>
    (Updatable) 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
    (Updatable) The description of the format entry.
    DisplayName string
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    FormatEntries List<LibraryMasingFormatFormatEntry>
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    SensitiveTypeIds List<string>

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    Source string
    Specifies whether the library masking format is user-defined or predefined.
    State string
    The current state of the library masking format.
    TimeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    TimeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    CompartmentId string
    (Updatable) The OCID of the compartment where the library masking format should be created.
    DefinedTags map[string]interface{}
    (Updatable) 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
    (Updatable) The description of the format entry.
    DisplayName string
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    FormatEntries []LibraryMasingFormatFormatEntryArgs
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    FreeformTags map[string]interface{}
    (Updatable) 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"}
    SensitiveTypeIds []string

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    Source string
    Specifies whether the library masking format is user-defined or predefined.
    State string
    The current state of the library masking format.
    TimeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    TimeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartmentId String
    (Updatable) The OCID of the compartment where the library masking format should be created.
    definedTags Map<String,Object>
    (Updatable) 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
    (Updatable) The description of the format entry.
    displayName String
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    formatEntries List<LibraryMasingFormatFormatEntry>
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    freeformTags Map<String,Object>
    (Updatable) 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"}
    sensitiveTypeIds List<String>

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    source String
    Specifies whether the library masking format is user-defined or predefined.
    state String
    The current state of the library masking format.
    timeCreated String
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated String
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartmentId string
    (Updatable) The OCID of the compartment where the library masking format should be created.
    definedTags {[key: string]: any}
    (Updatable) 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
    (Updatable) The description of the format entry.
    displayName string
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    formatEntries LibraryMasingFormatFormatEntry[]
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    freeformTags {[key: string]: any}
    (Updatable) 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"}
    sensitiveTypeIds string[]

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    source string
    Specifies whether the library masking format is user-defined or predefined.
    state string
    The current state of the library masking format.
    timeCreated string
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated string
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartment_id str
    (Updatable) The OCID of the compartment where the library masking format should be created.
    defined_tags Mapping[str, Any]
    (Updatable) 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
    (Updatable) The description of the format entry.
    display_name str
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    format_entries LibraryMasingFormatFormatEntryArgs]
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    sensitive_type_ids Sequence[str]

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    source str
    Specifies whether the library masking format is user-defined or predefined.
    state str
    The current state of the library masking format.
    time_created str
    The date and time the library masking format was created, in the format defined by RFC3339
    time_updated str
    The date and time the library masking format was updated, in the format defined by RFC3339
    compartmentId String
    (Updatable) The OCID of the compartment where the library masking format should be created.
    definedTags Map<Any>
    (Updatable) 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
    (Updatable) The description of the format entry.
    displayName String
    (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
    formatEntries List<Property Map>
    (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
    freeformTags Map<Any>
    (Updatable) 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"}
    sensitiveTypeIds List<String>

    (Updatable) An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

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

    source String
    Specifies whether the library masking format is user-defined or predefined.
    state String
    The current state of the library masking format.
    timeCreated String
    The date and time the library masking format was created, in the format defined by RFC3339
    timeUpdated String
    The date and time the library masking format was updated, in the format defined by RFC3339

    Supporting Types

    LibraryMasingFormatFormatEntry, LibraryMasingFormatFormatEntryArgs

    Type string
    (Updatable) The type of the format entry.
    ColumnName string
    (Updatable) The name of the substitution column.
    Description string
    (Updatable) The description of the format entry.
    EndDate string
    (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
    EndLength int
    (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
    EndValue double
    (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
    FixedNumber double
    (Updatable) The constant number to be used for masking.
    FixedString string
    (Updatable) The constant string to be used for masking.
    GroupingColumns List<string>
    (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
    Length int
    (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.
    LibraryMaskingFormatId string
    (Updatable) The OCID of the library masking format.
    Pattern string
    (Updatable) The pattern that should be used to mask data.
    PostProcessingFunction string
    (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    RandomLists List<string>
    (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
    RegularExpression string

    (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

    ReplaceWith string
    (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.
    SchemaName string
    (Updatable) The name of the schema that contains the substitution column.
    SqlExpression string
    (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%!)(MISSING) symbols.
    StartDate string
    (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
    StartLength int
    (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
    StartPosition int
    (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
    StartValue double
    (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
    TableName string
    (Updatable) The name of the table that contains the substitution column.
    UserDefinedFunction string
    (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    Type string
    (Updatable) The type of the format entry.
    ColumnName string
    (Updatable) The name of the substitution column.
    Description string
    (Updatable) The description of the format entry.
    EndDate string
    (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
    EndLength int
    (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
    EndValue float64
    (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
    FixedNumber float64
    (Updatable) The constant number to be used for masking.
    FixedString string
    (Updatable) The constant string to be used for masking.
    GroupingColumns []string
    (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
    Length int
    (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.
    LibraryMaskingFormatId string
    (Updatable) The OCID of the library masking format.
    Pattern string
    (Updatable) The pattern that should be used to mask data.
    PostProcessingFunction string
    (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    RandomLists []string
    (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
    RegularExpression string

    (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

    ReplaceWith string
    (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.
    SchemaName string
    (Updatable) The name of the schema that contains the substitution column.
    SqlExpression string
    (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%!)(MISSING) symbols.
    StartDate string
    (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
    StartLength int
    (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
    StartPosition int
    (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
    StartValue float64
    (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
    TableName string
    (Updatable) The name of the table that contains the substitution column.
    UserDefinedFunction string
    (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    type String
    (Updatable) The type of the format entry.
    columnName String
    (Updatable) The name of the substitution column.
    description String
    (Updatable) The description of the format entry.
    endDate String
    (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
    endLength Integer
    (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
    endValue Double
    (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
    fixedNumber Double
    (Updatable) The constant number to be used for masking.
    fixedString String
    (Updatable) The constant string to be used for masking.
    groupingColumns List<String>
    (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
    length Integer
    (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.
    libraryMaskingFormatId String
    (Updatable) The OCID of the library masking format.
    pattern String
    (Updatable) The pattern that should be used to mask data.
    postProcessingFunction String
    (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    randomLists List<String>
    (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
    regularExpression String

    (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

    replaceWith String
    (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.
    schemaName String
    (Updatable) The name of the schema that contains the substitution column.
    sqlExpression String
    (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%!)(MISSING) symbols.
    startDate String
    (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
    startLength Integer
    (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
    startPosition Integer
    (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
    startValue Double
    (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
    tableName String
    (Updatable) The name of the table that contains the substitution column.
    userDefinedFunction String
    (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    type string
    (Updatable) The type of the format entry.
    columnName string
    (Updatable) The name of the substitution column.
    description string
    (Updatable) The description of the format entry.
    endDate string
    (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
    endLength number
    (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
    endValue number
    (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
    fixedNumber number
    (Updatable) The constant number to be used for masking.
    fixedString string
    (Updatable) The constant string to be used for masking.
    groupingColumns string[]
    (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
    length number
    (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.
    libraryMaskingFormatId string
    (Updatable) The OCID of the library masking format.
    pattern string
    (Updatable) The pattern that should be used to mask data.
    postProcessingFunction string
    (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    randomLists string[]
    (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
    regularExpression string

    (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

    replaceWith string
    (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.
    schemaName string
    (Updatable) The name of the schema that contains the substitution column.
    sqlExpression string
    (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%!)(MISSING) symbols.
    startDate string
    (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
    startLength number
    (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
    startPosition number
    (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
    startValue number
    (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
    tableName string
    (Updatable) The name of the table that contains the substitution column.
    userDefinedFunction string
    (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    type str
    (Updatable) The type of the format entry.
    column_name str
    (Updatable) The name of the substitution column.
    description str
    (Updatable) The description of the format entry.
    end_date str
    (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
    end_length int
    (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
    end_value float
    (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
    fixed_number float
    (Updatable) The constant number to be used for masking.
    fixed_string str
    (Updatable) The constant string to be used for masking.
    grouping_columns Sequence[str]
    (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
    length int
    (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.
    library_masking_format_id str
    (Updatable) The OCID of the library masking format.
    pattern str
    (Updatable) The pattern that should be used to mask data.
    post_processing_function str
    (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    random_lists Sequence[str]
    (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
    regular_expression str

    (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

    replace_with str
    (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.
    schema_name str
    (Updatable) The name of the schema that contains the substitution column.
    sql_expression str
    (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%!)(MISSING) symbols.
    start_date str
    (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
    start_length int
    (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
    start_position int
    (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
    start_value float
    (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
    table_name str
    (Updatable) The name of the table that contains the substitution column.
    user_defined_function str
    (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    type String
    (Updatable) The type of the format entry.
    columnName String
    (Updatable) The name of the substitution column.
    description String
    (Updatable) The description of the format entry.
    endDate String
    (Updatable) The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.
    endLength Number
    (Updatable) The maximum number of characters the generated strings should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.
    endValue Number
    (Updatable) The upper bound of the range within which random decimal numbers should be generated. It must be greater than or equal to the start value. It supports input of double type.
    fixedNumber Number
    (Updatable) The constant number to be used for masking.
    fixedString String
    (Updatable) The constant string to be used for masking.
    groupingColumns List<String>
    (Updatable) One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.
    length Number
    (Updatable) The number of characters that should be there in the substring. It should be an integer and greater than zero.
    libraryMaskingFormatId String
    (Updatable) The OCID of the library masking format.
    pattern String
    (Updatable) The pattern that should be used to mask data.
    postProcessingFunction String
    (Updatable) The post processing function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.
    randomLists List<String>
    (Updatable) A comma-separated list of values to be used to replace column values. The list can be of strings, numbers, or dates. The data type of each value in the list must be compatible with the data type of the column. The number of entries in the list cannot be more than 999.
    regularExpression String

    (Updatable) The regular expression to be used for masking. For data with characters in the ASCII character set, providing a regular expression is optional. However, it is required if the data contains multi-byte characters. If not provided, an error is returned when a multi-byte character is found.

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

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

    replaceWith String
    (Updatable) The value that should be used to replace the data matching the regular expression. It can be a fixed string, fixed number, null value, or SQL expression.
    schemaName String
    (Updatable) The name of the schema that contains the substitution column.
    sqlExpression String
    (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%!)(MISSING) symbols.
    startDate String
    (Updatable) The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.
    startLength Number
    (Updatable) The minimum number of characters the generated strings should have. It can be any integer greater than zero, but it must be less than or equal to the end length.
    startPosition Number
    (Updatable) The starting position in the original string from where the substring should be extracted. It can be either a positive or a negative integer. If It's negative, the counting starts from the end of the string.
    startValue Number
    (Updatable) The lower bound of the range within which random decimal numbers should be generated. It must be less than or equal to the end value. It supports input of double type.
    tableName String
    (Updatable) The name of the table that contains the substitution column.
    userDefinedFunction String
    (Updatable) The user-defined function in SCHEMA_NAME.PACKAGE_NAME.FUNCTION_NAME format. It can be a standalone or packaged function, so PACKAGE_NAME is optional.

    Import

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

    $ pulumi import oci:DataSafe/libraryMasingFormat:LibraryMasingFormat test_library_masking_format "id"
    

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.27.0 published on Friday, Mar 15, 2024 by Pulumi