Docs Home
Packages
oci.DataSafe.LibraryMasingFormat
Explore with Pulumi AI
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LibraryMasingFormat(name: string, args: LibraryMasingFormatArgs, opts?: CustomResourceOptions);@overload
def LibraryMasingFormat(resource_name: str,
args: LibraryMasingFormatArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LibraryMasingFormat(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
format_entries: Optional[Sequence[_datasafe.LibraryMasingFormatFormatEntryArgs]] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
sensitive_type_ids: Optional[Sequence[str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var libraryMasingFormatResource = new Oci.DataSafe.LibraryMasingFormat("libraryMasingFormatResource", new()
{
CompartmentId = "string",
FormatEntries = new[]
{
new Oci.DataSafe.Inputs.LibraryMasingFormatFormatEntryArgs
{
Type = "string",
RandomLists = new[]
{
"string",
},
UserDefinedFunction = "string",
PostProcessingFunction = "string",
EndValue = 0,
FixedNumber = 0,
FixedString = "string",
GroupingColumns = new[]
{
"string",
},
Length = 0,
LibraryMaskingFormatId = "string",
RegularExpression = "string",
EndLength = 0,
EndDate = "string",
Pattern = "string",
ReplaceWith = "string",
SchemaName = "string",
SqlExpression = "string",
StartDate = "string",
StartLength = 0,
StartPosition = 0,
StartValue = 0,
TableName = "string",
Description = "string",
ColumnName = "string",
},
},
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
DisplayName = "string",
FreeformTags =
{
{ "string", "string" },
},
SensitiveTypeIds = new[]
{
"string",
},
});
example, err := DataSafe.NewLibraryMasingFormat(ctx, "libraryMasingFormatResource", &DataSafe.LibraryMasingFormatArgs{
CompartmentId: pulumi.String("string"),
FormatEntries: datasafe.LibraryMasingFormatFormatEntryArray{
&datasafe.LibraryMasingFormatFormatEntryArgs{
Type: pulumi.String("string"),
RandomLists: pulumi.StringArray{
pulumi.String("string"),
},
UserDefinedFunction: pulumi.String("string"),
PostProcessingFunction: pulumi.String("string"),
EndValue: pulumi.Float64(0),
FixedNumber: pulumi.Float64(0),
FixedString: pulumi.String("string"),
GroupingColumns: pulumi.StringArray{
pulumi.String("string"),
},
Length: pulumi.Int(0),
LibraryMaskingFormatId: pulumi.String("string"),
RegularExpression: pulumi.String("string"),
EndLength: pulumi.Int(0),
EndDate: pulumi.String("string"),
Pattern: pulumi.String("string"),
ReplaceWith: pulumi.String("string"),
SchemaName: pulumi.String("string"),
SqlExpression: pulumi.String("string"),
StartDate: pulumi.String("string"),
StartLength: pulumi.Int(0),
StartPosition: pulumi.Int(0),
StartValue: pulumi.Float64(0),
TableName: pulumi.String("string"),
Description: pulumi.String("string"),
ColumnName: pulumi.String("string"),
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
SensitiveTypeIds: pulumi.StringArray{
pulumi.String("string"),
},
})
var libraryMasingFormatResource = new LibraryMasingFormat("libraryMasingFormatResource", LibraryMasingFormatArgs.builder()
.compartmentId("string")
.formatEntries(LibraryMasingFormatFormatEntryArgs.builder()
.type("string")
.randomLists("string")
.userDefinedFunction("string")
.postProcessingFunction("string")
.endValue(0)
.fixedNumber(0)
.fixedString("string")
.groupingColumns("string")
.length(0)
.libraryMaskingFormatId("string")
.regularExpression("string")
.endLength(0)
.endDate("string")
.pattern("string")
.replaceWith("string")
.schemaName("string")
.sqlExpression("string")
.startDate("string")
.startLength(0)
.startPosition(0)
.startValue(0)
.tableName("string")
.description("string")
.columnName("string")
.build())
.definedTags(Map.of("string", "string"))
.description("string")
.displayName("string")
.freeformTags(Map.of("string", "string"))
.sensitiveTypeIds("string")
.build());
library_masing_format_resource = oci.data_safe.LibraryMasingFormat("libraryMasingFormatResource",
compartment_id="string",
format_entries=[oci.data_safe.LibraryMasingFormatFormatEntryArgs(
type="string",
random_lists=["string"],
user_defined_function="string",
post_processing_function="string",
end_value=0,
fixed_number=0,
fixed_string="string",
grouping_columns=["string"],
length=0,
library_masking_format_id="string",
regular_expression="string",
end_length=0,
end_date="string",
pattern="string",
replace_with="string",
schema_name="string",
sql_expression="string",
start_date="string",
start_length=0,
start_position=0,
start_value=0,
table_name="string",
description="string",
column_name="string",
)],
defined_tags={
"string": "string",
},
description="string",
display_name="string",
freeform_tags={
"string": "string",
},
sensitive_type_ids=["string"])
const libraryMasingFormatResource = new oci.datasafe.LibraryMasingFormat("libraryMasingFormatResource", {
compartmentId: "string",
formatEntries: [{
type: "string",
randomLists: ["string"],
userDefinedFunction: "string",
postProcessingFunction: "string",
endValue: 0,
fixedNumber: 0,
fixedString: "string",
groupingColumns: ["string"],
length: 0,
libraryMaskingFormatId: "string",
regularExpression: "string",
endLength: 0,
endDate: "string",
pattern: "string",
replaceWith: "string",
schemaName: "string",
sqlExpression: "string",
startDate: "string",
startLength: 0,
startPosition: 0,
startValue: 0,
tableName: "string",
description: "string",
columnName: "string",
}],
definedTags: {
string: "string",
},
description: "string",
displayName: "string",
freeformTags: {
string: "string",
},
sensitiveTypeIds: ["string"],
});
type: oci:DataSafe:LibraryMasingFormat
properties:
compartmentId: string
definedTags:
string: string
description: string
displayName: string
formatEntries:
- columnName: string
description: string
endDate: string
endLength: 0
endValue: 0
fixedNumber: 0
fixedString: string
groupingColumns:
- string
length: 0
libraryMaskingFormatId: string
pattern: string
postProcessingFunction: string
randomLists:
- string
regularExpression: string
replaceWith: string
schemaName: string
sqlExpression: string
startDate: string
startLength: 0
startPosition: 0
startValue: 0
tableName: string
type: string
userDefinedFunction: string
freeformTags:
string: string
sensitiveTypeIds:
- string
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:
- Compartment
Id string - (Updatable) The OCID of the compartment where the library masking format should be created.
- Format
Entries List<LibraryMasing Format Format Entry> - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Dictionary<string, string>
- (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 library masking format.
- Display
Name string - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- Dictionary<string, string>
- (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 List<string>Ids (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 string - (Updatable) The OCID of the compartment where the library masking format should be created.
- Format
Entries []LibraryMasing Format Format Entry Args - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- map[string]string
- (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 library masking format.
- Display
Name string - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- map[string]string
- (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 []stringIds (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 String - (Updatable) The OCID of the compartment where the library masking format should be created.
- format
Entries List<LibraryMasing Format Format Entry> - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Map<String,String>
- (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 library masking format.
- display
Name String - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- Map<String,String>
- (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 List<String>Ids (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 string - (Updatable) The OCID of the compartment where the library masking format should be created.
- format
Entries LibraryMasing Format Format Entry[] - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- {[key: string]: string}
- (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 library masking format.
- display
Name string - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- {[key: string]: string}
- (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 string[]Ids (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 Sequence[datasafe.Library Masing Format Format Entry Args] - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Mapping[str, str]
- (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 library masking format.
- display_
name str - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- Mapping[str, str]
- (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_ Sequence[str]ids (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 String - (Updatable) The OCID of the compartment where the library masking format should be created.
- format
Entries List<Property Map> - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Map<String>
- (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 library masking format.
- display
Name String - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- Map<String>
- (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 List<String>Ids (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.
- 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
- 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.
- 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
- 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.
- 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
- 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.
- 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
- 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.
- 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
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, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
format_entries: Optional[Sequence[_datasafe.LibraryMasingFormatFormatEntryArgs]] = None,
freeform_tags: Optional[Mapping[str, str]] = 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) -> LibraryMasingFormatfunc 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.
- Compartment
Id string - (Updatable) The OCID of the compartment where the library masking format should be created.
- Dictionary<string, string>
- (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 library masking format.
- Display
Name string - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- Format
Entries List<LibraryMasing Format Format Entry> - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Dictionary<string, string>
- (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 List<string>Ids (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.
- 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 - (Updatable) The OCID of the compartment where the library masking format should be created.
- map[string]string
- (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 library masking format.
- Display
Name string - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- Format
Entries []LibraryMasing Format Format Entry Args - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- map[string]string
- (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 []stringIds (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.
- 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 - (Updatable) The OCID of the compartment where the library masking format should be created.
- Map<String,String>
- (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 library masking format.
- display
Name String - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- format
Entries List<LibraryMasing Format Format Entry> - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Map<String,String>
- (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 List<String>Ids (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.
- 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 - (Updatable) The OCID of the compartment where the library masking format should be created.
- {[key: string]: string}
- (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 library masking format.
- display
Name string - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- format
Entries LibraryMasing Format Format Entry[] - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- {[key: string]: string}
- (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 string[]Ids (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.
- 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 - (Updatable) The OCID of the compartment where the library masking format should be created.
- Mapping[str, str]
- (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 library masking format.
- 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 Sequence[datasafe.Library Masing Format Format Entry Args] - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Mapping[str, str]
- (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_ Sequence[str]ids (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
- compartment
Id String - (Updatable) The OCID of the compartment where the library masking format should be created.
- Map<String>
- (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 library masking format.
- display
Name String - (Updatable) The display name of the library masking format. The name does not have to be unique, and it's changeable.
- format
Entries List<Property Map> - (Updatable) An array of format entries. The combined output of all the format entries is used for masking.
- Map<String>
- (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 List<String>Ids (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.
- 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
Supporting Types
LibraryMasingFormatFormatEntry, LibraryMasingFormatFormatEntryArgs
- Type string
- (Updatable) The type of the format entry.
- Column
Name string - (Updatable) The name of the substitution column.
- Description string
- (Updatable) The description of the format entry.
- End
Date 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.
- 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 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.
- Fixed
Number double - (Updatable) The constant number to be used for masking.
- Fixed
String string - (Updatable) The constant string to be used for masking.
- Grouping
Columns 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.
- Library
Masking stringFormat Id - (Updatable) The OCID of the library masking format.
- Pattern string
- (Updatable) The pattern that should be used to mask data.
- Post
Processing stringFunction - (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 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.
- Regular
Expression 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.
- Replace
With 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.
- Schema
Name string - (Updatable) The name of the schema that contains the substitution column.
- Sql
Expression string - (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
- Start
Date 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.
- 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 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.
- Table
Name string - (Updatable) The name of the table that contains the substitution column.
- User
Defined stringFunction - (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.
- Column
Name string - (Updatable) The name of the substitution column.
- Description string
- (Updatable) The description of the format entry.
- End
Date 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.
- 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 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.
- Fixed
Number float64 - (Updatable) The constant number to be used for masking.
- Fixed
String string - (Updatable) The constant string to be used for masking.
- Grouping
Columns []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.
- Library
Masking stringFormat Id - (Updatable) The OCID of the library masking format.
- Pattern string
- (Updatable) The pattern that should be used to mask data.
- Post
Processing stringFunction - (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 []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.
- Regular
Expression 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.
- Replace
With 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.
- Schema
Name string - (Updatable) The name of the schema that contains the substitution column.
- Sql
Expression string - (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
- Start
Date 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.
- 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 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.
- Table
Name string - (Updatable) The name of the table that contains the substitution column.
- User
Defined stringFunction - (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.
- column
Name String - (Updatable) The name of the substitution column.
- description String
- (Updatable) The description of the format entry.
- end
Date 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.
- end
Length 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.
- end
Value 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.
- fixed
Number Double - (Updatable) The constant number to be used for masking.
- fixed
String String - (Updatable) The constant string to be used for masking.
- grouping
Columns 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.
- library
Masking StringFormat Id - (Updatable) The OCID of the library masking format.
- pattern String
- (Updatable) The pattern that should be used to mask data.
- post
Processing StringFunction - (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 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.
- regular
Expression 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.
- replace
With 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.
- schema
Name String - (Updatable) The name of the schema that contains the substitution column.
- sql
Expression String - (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
- start
Date 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.
- start
Length 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.
- start
Position 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.
- start
Value 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.
- table
Name String - (Updatable) The name of the table that contains the substitution column.
- user
Defined StringFunction - (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.
- column
Name string - (Updatable) The name of the substitution column.
- description string
- (Updatable) The description of the format entry.
- end
Date 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.
- end
Length 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.
- end
Value 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.
- fixed
Number number - (Updatable) The constant number to be used for masking.
- fixed
String string - (Updatable) The constant string to be used for masking.
- grouping
Columns 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.
- library
Masking stringFormat Id - (Updatable) The OCID of the library masking format.
- pattern string
- (Updatable) The pattern that should be used to mask data.
- post
Processing stringFunction - (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 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.
- regular
Expression 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.
- replace
With 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.
- schema
Name string - (Updatable) The name of the schema that contains the substitution column.
- sql
Expression string - (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
- start
Date 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.
- start
Length 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.
- start
Position 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.
- start
Value 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.
- table
Name string - (Updatable) The name of the table that contains the substitution column.
- user
Defined stringFunction - (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_ strformat_ id - (Updatable) The OCID of the library masking format.
- pattern str
- (Updatable) The pattern that should be used to mask data.
- post_
processing_ strfunction - (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 (%) 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_ strfunction - (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.
- column
Name String - (Updatable) The name of the substitution column.
- description String
- (Updatable) The description of the format entry.
- end
Date 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.
- end
Length 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.
- end
Value 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.
- fixed
Number Number - (Updatable) The constant number to be used for masking.
- fixed
String String - (Updatable) The constant string to be used for masking.
- grouping
Columns 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.
- library
Masking StringFormat Id - (Updatable) The OCID of the library masking format.
- pattern String
- (Updatable) The pattern that should be used to mask data.
- post
Processing StringFunction - (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 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.
- regular
Expression 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.
- replace
With 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.
- schema
Name String - (Updatable) The name of the schema that contains the substitution column.
- sql
Expression String - (Updatable) The SQL expression to be used to generate the masked values. It can consist of one or more values, operators, and SQL functions that evaluate to a value. It can also contain substitution columns from the same table. Specify the substitution columns within percent (%) symbols.
- start
Date 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.
- start
Length 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.
- start
Position 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.
- start
Value 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.
- table
Name String - (Updatable) The name of the table that contains the substitution column.
- user
Defined StringFunction - (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"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ociTerraform Provider.