Docs Packages
  1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. DiscoveryMod
oci logo
Oracle Cloud Infrastructure v0.20.0, May 31 23

oci.DataSafe.DiscoveryMod

Explore with Pulumi AI

This resource provides the Discovery Job resource in Oracle Cloud Infrastructure Data Safe service.

Performs incremental data discovery for the specified sensitive data model. It uses the target database associated with the sensitive data model. After performing data discovery, you can use ListDiscoveryJobResults to view the discovery results, PatchDiscoveryJobResults to specify the action you want perform on these results, and then ApplyDiscoveryJobResults to process the results and apply them to the sensitive data model.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDiscoveryJob = new Oci.DataSafe.DiscoveryMod("testDiscoveryJob", new()
    {
        CompartmentId = @var.Compartment_id,
        SensitiveDataModelId = oci_data_safe_sensitive_data_model.Test_sensitive_data_model.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DiscoveryType = @var.Discovery_job_discovery_type,
        DisplayName = @var.Discovery_job_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsAppDefinedRelationDiscoveryEnabled = @var.Discovery_job_is_app_defined_relation_discovery_enabled,
        IsIncludeAllSchemas = @var.Discovery_job_is_include_all_schemas,
        IsIncludeAllSensitiveTypes = @var.Discovery_job_is_include_all_sensitive_types,
        IsSampleDataCollectionEnabled = @var.Discovery_job_is_sample_data_collection_enabled,
        SchemasForDiscoveries = @var.Discovery_job_schemas_for_discovery,
        SensitiveTypeIdsForDiscoveries = @var.Discovery_job_sensitive_type_ids_for_discovery,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.NewDiscoveryMod(ctx, "testDiscoveryJob", &DataSafe.DiscoveryModArgs{
			CompartmentId:        pulumi.Any(_var.Compartment_id),
			SensitiveDataModelId: pulumi.Any(oci_data_safe_sensitive_data_model.Test_sensitive_data_model.Id),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DiscoveryType: pulumi.Any(_var.Discovery_job_discovery_type),
			DisplayName:   pulumi.Any(_var.Discovery_job_display_name),
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			IsAppDefinedRelationDiscoveryEnabled: pulumi.Any(_var.Discovery_job_is_app_defined_relation_discovery_enabled),
			IsIncludeAllSchemas:                  pulumi.Any(_var.Discovery_job_is_include_all_schemas),
			IsIncludeAllSensitiveTypes:           pulumi.Any(_var.Discovery_job_is_include_all_sensitive_types),
			IsSampleDataCollectionEnabled:        pulumi.Any(_var.Discovery_job_is_sample_data_collection_enabled),
			SchemasForDiscoveries:                pulumi.Any(_var.Discovery_job_schemas_for_discovery),
			SensitiveTypeIdsForDiscoveries:       pulumi.Any(_var.Discovery_job_sensitive_type_ids_for_discovery),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DiscoveryMod;
import com.pulumi.oci.DataSafe.DiscoveryModArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testDiscoveryJob = new DiscoveryMod("testDiscoveryJob", DiscoveryModArgs.builder()        
            .compartmentId(var_.compartment_id())
            .sensitiveDataModelId(oci_data_safe_sensitive_data_model.test_sensitive_data_model().id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .discoveryType(var_.discovery_job_discovery_type())
            .displayName(var_.discovery_job_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .isAppDefinedRelationDiscoveryEnabled(var_.discovery_job_is_app_defined_relation_discovery_enabled())
            .isIncludeAllSchemas(var_.discovery_job_is_include_all_schemas())
            .isIncludeAllSensitiveTypes(var_.discovery_job_is_include_all_sensitive_types())
            .isSampleDataCollectionEnabled(var_.discovery_job_is_sample_data_collection_enabled())
            .schemasForDiscoveries(var_.discovery_job_schemas_for_discovery())
            .sensitiveTypeIdsForDiscoveries(var_.discovery_job_sensitive_type_ids_for_discovery())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_discovery_job = oci.data_safe.DiscoveryMod("testDiscoveryJob",
    compartment_id=var["compartment_id"],
    sensitive_data_model_id=oci_data_safe_sensitive_data_model["test_sensitive_data_model"]["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    discovery_type=var["discovery_job_discovery_type"],
    display_name=var["discovery_job_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    is_app_defined_relation_discovery_enabled=var["discovery_job_is_app_defined_relation_discovery_enabled"],
    is_include_all_schemas=var["discovery_job_is_include_all_schemas"],
    is_include_all_sensitive_types=var["discovery_job_is_include_all_sensitive_types"],
    is_sample_data_collection_enabled=var["discovery_job_is_sample_data_collection_enabled"],
    schemas_for_discoveries=var["discovery_job_schemas_for_discovery"],
    sensitive_type_ids_for_discoveries=var["discovery_job_sensitive_type_ids_for_discovery"])

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDiscoveryJob = new oci.datasafe.DiscoveryMod("testDiscoveryJob", {
    compartmentId: _var.compartment_id,
    sensitiveDataModelId: oci_data_safe_sensitive_data_model.test_sensitive_data_model.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    discoveryType: _var.discovery_job_discovery_type,
    displayName: _var.discovery_job_display_name,
    freeformTags: {
        Department: "Finance",
    },
    isAppDefinedRelationDiscoveryEnabled: _var.discovery_job_is_app_defined_relation_discovery_enabled,
    isIncludeAllSchemas: _var.discovery_job_is_include_all_schemas,
    isIncludeAllSensitiveTypes: _var.discovery_job_is_include_all_sensitive_types,
    isSampleDataCollectionEnabled: _var.discovery_job_is_sample_data_collection_enabled,
    schemasForDiscoveries: _var.discovery_job_schemas_for_discovery,
    sensitiveTypeIdsForDiscoveries: _var.discovery_job_sensitive_type_ids_for_discovery,
});

resources:
  testDiscoveryJob:
    type: oci:DataSafe:DiscoveryMod
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      sensitiveDataModelId: ${oci_data_safe_sensitive_data_model.test_sensitive_data_model.id}
      #Optional
      definedTags:
        Operations.CostCenter: '42'
      discoveryType: ${var.discovery_job_discovery_type}
      displayName: ${var.discovery_job_display_name}
      freeformTags:
        Department: Finance
      isAppDefinedRelationDiscoveryEnabled: ${var.discovery_job_is_app_defined_relation_discovery_enabled}
      isIncludeAllSchemas: ${var.discovery_job_is_include_all_schemas}
      isIncludeAllSensitiveTypes: ${var.discovery_job_is_include_all_sensitive_types}
      isSampleDataCollectionEnabled: ${var.discovery_job_is_sample_data_collection_enabled}
      schemasForDiscoveries: ${var.discovery_job_schemas_for_discovery}
      sensitiveTypeIdsForDiscoveries: ${var.discovery_job_sensitive_type_ids_for_discovery}

Create DiscoveryMod Resource

new DiscoveryMod(name: string, args: DiscoveryModArgs, opts?: CustomResourceOptions);
@overload
def DiscoveryMod(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, Any]] = None,
                 discovery_type: Optional[str] = None,
                 display_name: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, Any]] = None,
                 is_app_defined_relation_discovery_enabled: Optional[bool] = None,
                 is_include_all_schemas: Optional[bool] = None,
                 is_include_all_sensitive_types: Optional[bool] = None,
                 is_sample_data_collection_enabled: Optional[bool] = None,
                 schemas_for_discoveries: Optional[Sequence[str]] = None,
                 sensitive_data_model_id: Optional[str] = None,
                 sensitive_type_ids_for_discoveries: Optional[Sequence[str]] = None)
@overload
def DiscoveryMod(resource_name: str,
                 args: DiscoveryModArgs,
                 opts: Optional[ResourceOptions] = None)
func NewDiscoveryMod(ctx *Context, name string, args DiscoveryModArgs, opts ...ResourceOption) (*DiscoveryMod, error)
public DiscoveryMod(string name, DiscoveryModArgs args, CustomResourceOptions? opts = null)
public DiscoveryMod(String name, DiscoveryModArgs args)
public DiscoveryMod(String name, DiscoveryModArgs args, CustomResourceOptions options)

type: oci:DataSafe:DiscoveryMod
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DiscoveryModArgs
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 DiscoveryModArgs
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 DiscoveryModArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DiscoveryModArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DiscoveryModArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DiscoveryMod 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 DiscoveryMod resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment where the discovery job resource should be created.

SensitiveDataModelId string

The OCID of the sensitive data model.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

DiscoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

DisplayName string

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

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

IsAppDefinedRelationDiscoveryEnabled bool

Indicates if the discovery job 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.

IsIncludeAllSchemas bool

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsIncludeAllSensitiveTypes bool

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsSampleDataCollectionEnabled bool

Indicates if the discovery job 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.

SchemasForDiscoveries List<string>

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

SensitiveTypeIdsForDiscoveries List<string>

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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 discovery job resource should be created.

SensitiveDataModelId string

The OCID of the sensitive data model.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

DiscoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

DisplayName string

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

FreeformTags map[string]interface{}

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

IsAppDefinedRelationDiscoveryEnabled bool

Indicates if the discovery job 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.

IsIncludeAllSchemas bool

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsIncludeAllSensitiveTypes bool

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsSampleDataCollectionEnabled bool

Indicates if the discovery job 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.

SchemasForDiscoveries []string

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

SensitiveTypeIdsForDiscoveries []string

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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 discovery job resource should be created.

sensitiveDataModelId String

The OCID of the sensitive data model.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryType String

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName String

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags Map<String,Object>

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

isAppDefinedRelationDiscoveryEnabled Boolean

Indicates if the discovery job 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.

isIncludeAllSchemas Boolean

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isIncludeAllSensitiveTypes Boolean

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isSampleDataCollectionEnabled Boolean

Indicates if the discovery job 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.

schemasForDiscoveries List<String>

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitiveTypeIdsForDiscoveries List<String>

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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 discovery job resource should be created.

sensitiveDataModelId string

The OCID of the sensitive data model.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName string

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags {[key: string]: any}

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

isAppDefinedRelationDiscoveryEnabled boolean

Indicates if the discovery job 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.

isIncludeAllSchemas boolean

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isIncludeAllSensitiveTypes boolean

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isSampleDataCollectionEnabled boolean

Indicates if the discovery job 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.

schemasForDiscoveries string[]

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitiveTypeIdsForDiscoveries string[]

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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 discovery job resource should be created.

sensitive_data_model_id str

The OCID of the sensitive data model.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discovery_type str

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

display_name str

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

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

is_app_defined_relation_discovery_enabled bool

Indicates if the discovery job 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.

is_include_all_schemas bool

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

is_include_all_sensitive_types bool

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

is_sample_data_collection_enabled bool

Indicates if the discovery job 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.

schemas_for_discoveries Sequence[str]

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitive_type_ids_for_discoveries Sequence[str]

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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 discovery job resource should be created.

sensitiveDataModelId String

The OCID of the sensitive data model.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryType String

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName String

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags Map<Any>

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

isAppDefinedRelationDiscoveryEnabled Boolean

Indicates if the discovery job 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.

isIncludeAllSchemas Boolean

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isIncludeAllSensitiveTypes Boolean

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isSampleDataCollectionEnabled Boolean

Indicates if the discovery job 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.

schemasForDiscoveries List<String>

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitiveTypeIdsForDiscoveries List<String>

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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 DiscoveryMod resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the discovery job.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetId string

The OCID of the target database associated with the discovery job.

TimeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

TimeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

TotalColumnsScanned string

The total number of columns scanned by the discovery job.

TotalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

TotalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

TotalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

TotalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

TotalSchemasScanned string

The total number of schemas scanned by the discovery job.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current state of the discovery job.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetId string

The OCID of the target database associated with the discovery job.

TimeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

TimeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

TotalColumnsScanned string

The total number of columns scanned by the discovery job.

TotalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

TotalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

TotalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

TotalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

TotalSchemasScanned string

The total number of schemas scanned by the discovery job.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the discovery job.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId String

The OCID of the target database associated with the discovery job.

timeFinished String

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted String

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned String

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns String

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns String

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns String

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned String

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned String

The total number of schemas scanned by the discovery job.

id string

The provider-assigned unique ID for this managed resource.

state string

The current state of the discovery job.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId string

The OCID of the target database associated with the discovery job.

timeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned string

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned string

The total number of schemas scanned by the discovery job.

id str

The provider-assigned unique ID for this managed resource.

state str

The current state of the discovery job.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

target_id str

The OCID of the target database associated with the discovery job.

time_finished str

The date and time the discovery job finished, in the format defined by RFC3339..

time_started str

The date and time the discovery job started, in the format defined by RFC3339.

total_columns_scanned str

The total number of columns scanned by the discovery job.

total_deleted_sensitive_columns str

The total number of deleted sensitive columns identified by the discovery job.

total_modified_sensitive_columns str

The total number of modified sensitive columns identified by the discovery job.

total_new_sensitive_columns str

The total number of new sensitive columns identified by the discovery job.

total_objects_scanned str

The total number of objects (tables and editioning views) scanned by the discovery job.

total_schemas_scanned str

The total number of schemas scanned by the discovery job.

id String

The provider-assigned unique ID for this managed resource.

state String

The current state of the discovery job.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId String

The OCID of the target database associated with the discovery job.

timeFinished String

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted String

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned String

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns String

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns String

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns String

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned String

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned String

The total number of schemas scanned by the discovery job.

Look up Existing DiscoveryMod Resource

Get an existing DiscoveryMod 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?: DiscoveryModState, opts?: CustomResourceOptions): DiscoveryMod
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        discovery_type: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_app_defined_relation_discovery_enabled: Optional[bool] = None,
        is_include_all_schemas: Optional[bool] = None,
        is_include_all_sensitive_types: Optional[bool] = None,
        is_sample_data_collection_enabled: Optional[bool] = None,
        schemas_for_discoveries: Optional[Sequence[str]] = None,
        sensitive_data_model_id: Optional[str] = None,
        sensitive_type_ids_for_discoveries: Optional[Sequence[str]] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        target_id: Optional[str] = None,
        time_finished: Optional[str] = None,
        time_started: Optional[str] = None,
        total_columns_scanned: Optional[str] = None,
        total_deleted_sensitive_columns: Optional[str] = None,
        total_modified_sensitive_columns: Optional[str] = None,
        total_new_sensitive_columns: Optional[str] = None,
        total_objects_scanned: Optional[str] = None,
        total_schemas_scanned: Optional[str] = None) -> DiscoveryMod
func GetDiscoveryMod(ctx *Context, name string, id IDInput, state *DiscoveryModState, opts ...ResourceOption) (*DiscoveryMod, error)
public static DiscoveryMod Get(string name, Input<string> id, DiscoveryModState? state, CustomResourceOptions? opts = null)
public static DiscoveryMod get(String name, Output<String> id, DiscoveryModState 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 discovery job resource should be created.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

DiscoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

DisplayName string

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

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

IsAppDefinedRelationDiscoveryEnabled bool

Indicates if the discovery job 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.

IsIncludeAllSchemas bool

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsIncludeAllSensitiveTypes bool

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsSampleDataCollectionEnabled bool

Indicates if the discovery job 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.

SchemasForDiscoveries List<string>

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

SensitiveDataModelId string

The OCID of the sensitive data model.

SensitiveTypeIdsForDiscoveries List<string>

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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

State string

The current state of the discovery job.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetId string

The OCID of the target database associated with the discovery job.

TimeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

TimeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

TotalColumnsScanned string

The total number of columns scanned by the discovery job.

TotalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

TotalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

TotalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

TotalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

TotalSchemasScanned string

The total number of schemas scanned by the discovery job.

CompartmentId string

(Updatable) The OCID of the compartment where the discovery job resource should be created.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

DiscoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

DisplayName string

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

FreeformTags map[string]interface{}

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

IsAppDefinedRelationDiscoveryEnabled bool

Indicates if the discovery job 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.

IsIncludeAllSchemas bool

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsIncludeAllSensitiveTypes bool

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

IsSampleDataCollectionEnabled bool

Indicates if the discovery job 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.

SchemasForDiscoveries []string

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

SensitiveDataModelId string

The OCID of the sensitive data model.

SensitiveTypeIdsForDiscoveries []string

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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

State string

The current state of the discovery job.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

TargetId string

The OCID of the target database associated with the discovery job.

TimeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

TimeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

TotalColumnsScanned string

The total number of columns scanned by the discovery job.

TotalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

TotalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

TotalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

TotalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

TotalSchemasScanned string

The total number of schemas scanned by the discovery job.

compartmentId String

(Updatable) The OCID of the compartment where the discovery job resource should be created.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryType String

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName String

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags Map<String,Object>

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

isAppDefinedRelationDiscoveryEnabled Boolean

Indicates if the discovery job 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.

isIncludeAllSchemas Boolean

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isIncludeAllSensitiveTypes Boolean

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isSampleDataCollectionEnabled Boolean

Indicates if the discovery job 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.

schemasForDiscoveries List<String>

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitiveDataModelId String

The OCID of the sensitive data model.

sensitiveTypeIdsForDiscoveries List<String>

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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

state String

The current state of the discovery job.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId String

The OCID of the target database associated with the discovery job.

timeFinished String

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted String

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned String

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns String

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns String

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns String

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned String

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned String

The total number of schemas scanned by the discovery job.

compartmentId string

(Updatable) The OCID of the compartment where the discovery job resource should be created.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryType string

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName string

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags {[key: string]: any}

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

isAppDefinedRelationDiscoveryEnabled boolean

Indicates if the discovery job 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.

isIncludeAllSchemas boolean

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isIncludeAllSensitiveTypes boolean

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isSampleDataCollectionEnabled boolean

Indicates if the discovery job 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.

schemasForDiscoveries string[]

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitiveDataModelId string

The OCID of the sensitive data model.

sensitiveTypeIdsForDiscoveries string[]

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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

state string

The current state of the discovery job.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId string

The OCID of the target database associated with the discovery job.

timeFinished string

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted string

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned string

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns string

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns string

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns string

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned string

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned string

The total number of schemas scanned by the discovery job.

compartment_id str

(Updatable) The OCID of the compartment where the discovery job resource should be created.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discovery_type str

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

display_name str

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

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

is_app_defined_relation_discovery_enabled bool

Indicates if the discovery job 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.

is_include_all_schemas bool

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

is_include_all_sensitive_types bool

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

is_sample_data_collection_enabled bool

Indicates if the discovery job 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.

schemas_for_discoveries Sequence[str]

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitive_data_model_id str

The OCID of the sensitive data model.

sensitive_type_ids_for_discoveries Sequence[str]

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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

state str

The current state of the discovery job.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

target_id str

The OCID of the target database associated with the discovery job.

time_finished str

The date and time the discovery job finished, in the format defined by RFC3339..

time_started str

The date and time the discovery job started, in the format defined by RFC3339.

total_columns_scanned str

The total number of columns scanned by the discovery job.

total_deleted_sensitive_columns str

The total number of deleted sensitive columns identified by the discovery job.

total_modified_sensitive_columns str

The total number of modified sensitive columns identified by the discovery job.

total_new_sensitive_columns str

The total number of new sensitive columns identified by the discovery job.

total_objects_scanned str

The total number of objects (tables and editioning views) scanned by the discovery job.

total_schemas_scanned str

The total number of schemas scanned by the discovery job.

compartmentId String

(Updatable) The OCID of the compartment where the discovery job resource should be created.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}

discoveryType String

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName String

A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

freeformTags Map<Any>

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

isAppDefinedRelationDiscoveryEnabled Boolean

Indicates if the discovery job 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.

isIncludeAllSchemas Boolean

Indicates if all the schemas should be scanned by the discovery job. If it's set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isIncludeAllSensitiveTypes Boolean

Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

isSampleDataCollectionEnabled Boolean

Indicates if the discovery job 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.

schemasForDiscoveries List<String>

The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

sensitiveDataModelId String

The OCID of the sensitive data model.

sensitiveTypeIdsForDiscoveries List<String>

The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

** 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

state String

The current state of the discovery job.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}

targetId String

The OCID of the target database associated with the discovery job.

timeFinished String

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted String

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned String

The total number of columns scanned by the discovery job.

totalDeletedSensitiveColumns String

The total number of deleted sensitive columns identified by the discovery job.

totalModifiedSensitiveColumns String

The total number of modified sensitive columns identified by the discovery job.

totalNewSensitiveColumns String

The total number of new sensitive columns identified by the discovery job.

totalObjectsScanned String

The total number of objects (tables and editioning views) scanned by the discovery job.

totalSchemasScanned String

The total number of schemas scanned by the discovery job.

Import

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

 $ pulumi import oci:DataSafe/discoveryMod:DiscoveryMod test_discovery_job "id"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.