Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. DiscoveryMod
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.DiscoveryMod

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    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

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

const testDiscoveryJob = new oci.datasafe.DiscoveryMod("test_discovery_job", {
    compartmentId: compartmentId,
    sensitiveDataModelId: testSensitiveDataModel.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    discoveryType: discoveryJobDiscoveryType,
    displayName: discoveryJobDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    isAppDefinedRelationDiscoveryEnabled: discoveryJobIsAppDefinedRelationDiscoveryEnabled,
    isIncludeAllSchemas: discoveryJobIsIncludeAllSchemas,
    isIncludeAllSensitiveTypes: discoveryJobIsIncludeAllSensitiveTypes,
    isSampleDataCollectionEnabled: discoveryJobIsSampleDataCollectionEnabled,
    schemasForDiscoveries: discoveryJobSchemasForDiscovery,
    sensitiveTypeIdsForDiscoveries: discoveryJobSensitiveTypeIdsForDiscovery,
    tablesForDiscoveries: [{
        schemaName: discoveryJobTablesForDiscoverySchemaName,
        tableNames: discoveryJobTablesForDiscoveryTableNames,
    }],
});

    import pulumi
import pulumi_oci as oci

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

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.NewDiscoveryMod(ctx, "test_discovery_job", &DataSafe.DiscoveryModArgs{
			CompartmentId:        pulumi.Any(compartmentId),
			SensitiveDataModelId: pulumi.Any(testSensitiveDataModel.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DiscoveryType: pulumi.Any(discoveryJobDiscoveryType),
			DisplayName:   pulumi.Any(discoveryJobDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsAppDefinedRelationDiscoveryEnabled: pulumi.Any(discoveryJobIsAppDefinedRelationDiscoveryEnabled),
			IsIncludeAllSchemas:                  pulumi.Any(discoveryJobIsIncludeAllSchemas),
			IsIncludeAllSensitiveTypes:           pulumi.Any(discoveryJobIsIncludeAllSensitiveTypes),
			IsSampleDataCollectionEnabled:        pulumi.Any(discoveryJobIsSampleDataCollectionEnabled),
			SchemasForDiscoveries:                pulumi.Any(discoveryJobSchemasForDiscovery),
			SensitiveTypeIdsForDiscoveries:       pulumi.Any(discoveryJobSensitiveTypeIdsForDiscovery),
			TablesForDiscoveries: datasafe.DiscoveryModTablesForDiscoveryArray{
				&datasafe.DiscoveryModTablesForDiscoveryArgs{
					SchemaName: pulumi.Any(discoveryJobTablesForDiscoverySchemaName),
					TableNames: pulumi.Any(discoveryJobTablesForDiscoveryTableNames),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testDiscoveryJob = new Oci.DataSafe.DiscoveryMod("test_discovery_job", new()
    {
        CompartmentId = compartmentId,
        SensitiveDataModelId = testSensitiveDataModel.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DiscoveryType = discoveryJobDiscoveryType,
        DisplayName = discoveryJobDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsAppDefinedRelationDiscoveryEnabled = discoveryJobIsAppDefinedRelationDiscoveryEnabled,
        IsIncludeAllSchemas = discoveryJobIsIncludeAllSchemas,
        IsIncludeAllSensitiveTypes = discoveryJobIsIncludeAllSensitiveTypes,
        IsSampleDataCollectionEnabled = discoveryJobIsSampleDataCollectionEnabled,
        SchemasForDiscoveries = discoveryJobSchemasForDiscovery,
        SensitiveTypeIdsForDiscoveries = discoveryJobSensitiveTypeIdsForDiscovery,
        TablesForDiscoveries = new[]
        {
            new Oci.DataSafe.Inputs.DiscoveryModTablesForDiscoveryArgs
            {
                SchemaName = discoveryJobTablesForDiscoverySchemaName,
                TableNames = discoveryJobTablesForDiscoveryTableNames,
            },
        },
    });

});

    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 com.pulumi.oci.DataSafe.inputs.DiscoveryModTablesForDiscoveryArgs;
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(compartmentId)
            .sensitiveDataModelId(testSensitiveDataModel.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .discoveryType(discoveryJobDiscoveryType)
            .displayName(discoveryJobDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .isAppDefinedRelationDiscoveryEnabled(discoveryJobIsAppDefinedRelationDiscoveryEnabled)
            .isIncludeAllSchemas(discoveryJobIsIncludeAllSchemas)
            .isIncludeAllSensitiveTypes(discoveryJobIsIncludeAllSensitiveTypes)
            .isSampleDataCollectionEnabled(discoveryJobIsSampleDataCollectionEnabled)
            .schemasForDiscoveries(discoveryJobSchemasForDiscovery)
            .sensitiveTypeIdsForDiscoveries(discoveryJobSensitiveTypeIdsForDiscovery)
            .tablesForDiscoveries(DiscoveryModTablesForDiscoveryArgs.builder()
                .schemaName(discoveryJobTablesForDiscoverySchemaName)
                .tableNames(discoveryJobTablesForDiscoveryTableNames)
                .build())
            .build());

    }
}

    resources:
  testDiscoveryJob:
    type: oci:DataSafe:DiscoveryMod
    name: test_discovery_job
    properties:
      compartmentId: ${compartmentId}
      sensitiveDataModelId: ${testSensitiveDataModel.id}
      definedTags:
        Operations.CostCenter: '42'
      discoveryType: ${discoveryJobDiscoveryType}
      displayName: ${discoveryJobDisplayName}
      freeformTags:
        Department: Finance
      isAppDefinedRelationDiscoveryEnabled: ${discoveryJobIsAppDefinedRelationDiscoveryEnabled}
      isIncludeAllSchemas: ${discoveryJobIsIncludeAllSchemas}
      isIncludeAllSensitiveTypes: ${discoveryJobIsIncludeAllSensitiveTypes}
      isSampleDataCollectionEnabled: ${discoveryJobIsSampleDataCollectionEnabled}
      schemasForDiscoveries: ${discoveryJobSchemasForDiscovery}
      sensitiveTypeIdsForDiscoveries: ${discoveryJobSensitiveTypeIdsForDiscovery}
      tablesForDiscoveries:
        - schemaName: ${discoveryJobTablesForDiscoverySchemaName}
          tableNames: ${discoveryJobTablesForDiscoveryTableNames}

    Create DiscoveryMod Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DiscoveryMod(name: string, args: DiscoveryModArgs, opts?: CustomResourceOptions);
    @overload
def DiscoveryMod(resource_name: str,
                 args: DiscoveryModArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DiscoveryMod(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 sensitive_data_model_id: Optional[str] = None,
                 is_include_all_schemas: Optional[bool] = None,
                 display_name: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, str]] = None,
                 is_app_defined_relation_discovery_enabled: Optional[bool] = None,
                 discovery_type: Optional[str] = None,
                 is_include_all_sensitive_types: Optional[bool] = None,
                 is_sample_data_collection_enabled: Optional[bool] = None,
                 schemas_for_discoveries: Optional[Sequence[str]] = None,
                 defined_tags: Optional[Mapping[str, str]] = None,
                 sensitive_type_ids_for_discoveries: Optional[Sequence[str]] = None,
                 tables_for_discoveries: Optional[Sequence[_datasafe.DiscoveryModTablesForDiscoveryArgs]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var discoveryModResource = new Oci.DataSafe.DiscoveryMod("discoveryModResource", new()
{
    CompartmentId = "string",
    SensitiveDataModelId = "string",
    IsIncludeAllSchemas = false,
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsAppDefinedRelationDiscoveryEnabled = false,
    DiscoveryType = "string",
    IsIncludeAllSensitiveTypes = false,
    IsSampleDataCollectionEnabled = false,
    SchemasForDiscoveries = new[]
    {
        "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    SensitiveTypeIdsForDiscoveries = new[]
    {
        "string",
    },
    TablesForDiscoveries = new[]
    {
        new Oci.DataSafe.Inputs.DiscoveryModTablesForDiscoveryArgs
        {
            SchemaName = "string",
            TableNames = new[]
            {
                "string",
            },
        },
    },
});

    example, err := DataSafe.NewDiscoveryMod(ctx, "discoveryModResource", &DataSafe.DiscoveryModArgs{
	CompartmentId:        pulumi.String("string"),
	SensitiveDataModelId: pulumi.String("string"),
	IsIncludeAllSchemas:  pulumi.Bool(false),
	DisplayName:          pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsAppDefinedRelationDiscoveryEnabled: pulumi.Bool(false),
	DiscoveryType:                        pulumi.String("string"),
	IsIncludeAllSensitiveTypes:           pulumi.Bool(false),
	IsSampleDataCollectionEnabled:        pulumi.Bool(false),
	SchemasForDiscoveries: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SensitiveTypeIdsForDiscoveries: pulumi.StringArray{
		pulumi.String("string"),
	},
	TablesForDiscoveries: datasafe.DiscoveryModTablesForDiscoveryArray{
		&datasafe.DiscoveryModTablesForDiscoveryArgs{
			SchemaName: pulumi.String("string"),
			TableNames: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

    var discoveryModResource = new DiscoveryMod("discoveryModResource", DiscoveryModArgs.builder()
    .compartmentId("string")
    .sensitiveDataModelId("string")
    .isIncludeAllSchemas(false)
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .isAppDefinedRelationDiscoveryEnabled(false)
    .discoveryType("string")
    .isIncludeAllSensitiveTypes(false)
    .isSampleDataCollectionEnabled(false)
    .schemasForDiscoveries("string")
    .definedTags(Map.of("string", "string"))
    .sensitiveTypeIdsForDiscoveries("string")
    .tablesForDiscoveries(DiscoveryModTablesForDiscoveryArgs.builder()
        .schemaName("string")
        .tableNames("string")
        .build())
    .build());

    discovery_mod_resource = oci.data_safe.DiscoveryMod("discoveryModResource",
    compartment_id="string",
    sensitive_data_model_id="string",
    is_include_all_schemas=False,
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    is_app_defined_relation_discovery_enabled=False,
    discovery_type="string",
    is_include_all_sensitive_types=False,
    is_sample_data_collection_enabled=False,
    schemas_for_discoveries=["string"],
    defined_tags={
        "string": "string",
    },
    sensitive_type_ids_for_discoveries=["string"],
    tables_for_discoveries=[oci.data_safe.DiscoveryModTablesForDiscoveryArgs(
        schema_name="string",
        table_names=["string"],
    )])

    const discoveryModResource = new oci.datasafe.DiscoveryMod("discoveryModResource", {
    compartmentId: "string",
    sensitiveDataModelId: "string",
    isIncludeAllSchemas: false,
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    isAppDefinedRelationDiscoveryEnabled: false,
    discoveryType: "string",
    isIncludeAllSensitiveTypes: false,
    isSampleDataCollectionEnabled: false,
    schemasForDiscoveries: ["string"],
    definedTags: {
        string: "string",
    },
    sensitiveTypeIdsForDiscoveries: ["string"],
    tablesForDiscoveries: [{
        schemaName: "string",
        tableNames: ["string"],
    }],
});

    type: oci:DataSafe:DiscoveryMod
properties:
    compartmentId: string
    definedTags:
        string: string
    discoveryType: string
    displayName: string
    freeformTags:
        string: string
    isAppDefinedRelationDiscoveryEnabled: false
    isIncludeAllSchemas: false
    isIncludeAllSensitiveTypes: false
    isSampleDataCollectionEnabled: false
    schemasForDiscoveries:
        - string
    sensitiveDataModelId: string
    sensitiveTypeIdsForDiscoveries:
        - string
    tablesForDiscoveries:
        - schemaName: string
          tableNames:
            - string

    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, string>
    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, string>
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    TablesForDiscoveries List<DiscoveryModTablesForDiscovery>
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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]string
    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]string
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    TablesForDiscoveries []DiscoveryModTablesForDiscoveryArgs
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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,String>
    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,String>
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    tablesForDiscoveries List<DiscoveryModTablesForDiscovery>
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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]: string}
    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]: string}
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    tablesForDiscoveries DiscoveryModTablesForDiscovery[]
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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, str]
    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, str]
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    tables_for_discoveries Sequence[datasafe.DiscoveryModTablesForDiscoveryArgs]
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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>
    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>
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    tablesForDiscoveries List<Property Map>
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.

    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, string>
    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]string
    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,String>
    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]: string}
    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, str]
    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<String>
    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, str]] = None,
        discovery_type: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = 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, str]] = None,
        tables_for_discoveries: Optional[Sequence[_datasafe.DiscoveryModTablesForDiscoveryArgs]] = 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, string>
    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, string>
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    State string
    The current state of the discovery job.
    SystemTags Dictionary<string, string>
    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"}
    TablesForDiscoveries List<DiscoveryModTablesForDiscovery>
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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]string
    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]string
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    State string
    The current state of the discovery job.
    SystemTags map[string]string
    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"}
    TablesForDiscoveries []DiscoveryModTablesForDiscoveryArgs
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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,String>
    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,String>
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    state String
    The current state of the discovery job.
    systemTags Map<String,String>
    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"}
    tablesForDiscoveries List<DiscoveryModTablesForDiscovery>
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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]: string}
    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]: string}
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    state string
    The current state of the discovery job.
    systemTags {[key: string]: string}
    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"}
    tablesForDiscoveries DiscoveryModTablesForDiscovery[]
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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, str]
    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, str]
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    state str
    The current state of the discovery job.
    system_tags Mapping[str, str]
    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"}
    tables_for_discoveries Sequence[datasafe.DiscoveryModTablesForDiscoveryArgs]
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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<String>
    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>
    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 is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). 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.
    state String
    The current state of the discovery job.
    systemTags Map<String>
    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"}
    tablesForDiscoveries List<Property Map>
    The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.
    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.

    Supporting Types

    DiscoveryModTablesForDiscovery, DiscoveryModTablesForDiscoveryArgs

    SchemaName string
    This contains the name of the schema.
    TableNames List<string>

    This contains an optional list of the table names.

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

    SchemaName string
    This contains the name of the schema.
    TableNames []string

    This contains an optional list of the table names.

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

    schemaName String
    This contains the name of the schema.
    tableNames List<String>

    This contains an optional list of the table names.

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

    schemaName string
    This contains the name of the schema.
    tableNames string[]

    This contains an optional list of the table names.

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

    schema_name str
    This contains the name of the schema.
    table_names Sequence[str]

    This contains an optional list of the table names.

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

    schemaName String
    This contains the name of the schema.
    tableNames List<String>

    This contains an optional list of the table names.

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

    Import

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

    $ pulumi import oci:DataSafe/discoveryMod:DiscoveryMod test_discovery_job "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 oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci