Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateSensitiveDataModelDetails

Details to create a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later. To specify some schemas and sensitive types for data discovery, use schemasForDiscovery and sensitiveTypeIdsForDiscovery attributes. But if you want to include all schemas and sensitive types, you can set isIncludeAllSchemas and isIncludeAllSensitiveTypes attributes to true. In the latter case, you do not need to list all schemas and sensitive types.

Properties

Optional appSuiteName

appSuiteName: undefined | string

The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.

compartmentId

compartmentId: string

The OCID of the compartment where the sensitive data model should be created.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the sensitive data model.

Optional displayName

displayName: undefined | string

The display name of the sensitive data model. The name does not have to be unique, and it's changeable.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {@code {\"Department\": \"Finance\"}}

Optional isAppDefinedRelationDiscoveryEnabled

isAppDefinedRelationDiscoveryEnabled: undefined | false | true

Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

Optional isIncludeAllSchemas

isIncludeAllSchemas: undefined | false | true

Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).

Optional isIncludeAllSensitiveTypes

isIncludeAllSensitiveTypes: undefined | false | true

Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.

Optional isSampleDataCollectionEnabled

isSampleDataCollectionEnabled: undefined | false | true

Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

Optional schemasForDiscovery

schemasForDiscovery: Array<string>

The schemas to be scanned by data discovery jobs.

Optional sensitiveTypeIdsForDiscovery

sensitiveTypeIdsForDiscovery: Array<string>

The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.

targetId

targetId: string

The OCID of the reference target database to be associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database.

Functions

getDeserializedJsonObj

getJsonObj