Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. SensitiveDataModel
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.SensitiveDataModel

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Sensitive Data Model resource in Oracle Cloud Infrastructure Data Safe service.

    Creates a new sensitive data model. If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later.

    Example Usage

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

const testSensitiveDataModel = new oci.datasafe.SensitiveDataModel("test_sensitive_data_model", {
    compartmentId: compartmentId,
    targetId: testTarget.id,
    appSuiteName: sensitiveDataModelAppSuiteName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: sensitiveDataModelDescription,
    displayName: sensitiveDataModelDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    isAppDefinedRelationDiscoveryEnabled: sensitiveDataModelIsAppDefinedRelationDiscoveryEnabled,
    isIncludeAllSchemas: sensitiveDataModelIsIncludeAllSchemas,
    isIncludeAllSensitiveTypes: sensitiveDataModelIsIncludeAllSensitiveTypes,
    isSampleDataCollectionEnabled: sensitiveDataModelIsSampleDataCollectionEnabled,
    schemasForDiscoveries: sensitiveDataModelSchemasForDiscovery,
    sensitiveTypeGroupIdsForDiscoveries: sensitiveDataModelSensitiveTypeGroupIdsForDiscovery,
    sensitiveTypeIdsForDiscoveries: sensitiveDataModelSensitiveTypeIdsForDiscovery,
    tablesForDiscoveries: [{
        schemaName: sensitiveDataModelTablesForDiscoverySchemaName,
        tableNames: sensitiveDataModelTablesForDiscoveryTableNames,
    }],
});

    import pulumi
import pulumi_oci as oci

test_sensitive_data_model = oci.data_safe.SensitiveDataModel("test_sensitive_data_model",
    compartment_id=compartment_id,
    target_id=test_target["id"],
    app_suite_name=sensitive_data_model_app_suite_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=sensitive_data_model_description,
    display_name=sensitive_data_model_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    is_app_defined_relation_discovery_enabled=sensitive_data_model_is_app_defined_relation_discovery_enabled,
    is_include_all_schemas=sensitive_data_model_is_include_all_schemas,
    is_include_all_sensitive_types=sensitive_data_model_is_include_all_sensitive_types,
    is_sample_data_collection_enabled=sensitive_data_model_is_sample_data_collection_enabled,
    schemas_for_discoveries=sensitive_data_model_schemas_for_discovery,
    sensitive_type_group_ids_for_discoveries=sensitive_data_model_sensitive_type_group_ids_for_discovery,
    sensitive_type_ids_for_discoveries=sensitive_data_model_sensitive_type_ids_for_discovery,
    tables_for_discoveries=[{
        "schema_name": sensitive_data_model_tables_for_discovery_schema_name,
        "table_names": sensitive_data_model_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.NewSensitiveDataModel(ctx, "test_sensitive_data_model", &datasafe.SensitiveDataModelArgs{
			CompartmentId: pulumi.Any(compartmentId),
			TargetId:      pulumi.Any(testTarget.Id),
			AppSuiteName:  pulumi.Any(sensitiveDataModelAppSuiteName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(sensitiveDataModelDescription),
			DisplayName: pulumi.Any(sensitiveDataModelDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsAppDefinedRelationDiscoveryEnabled: pulumi.Any(sensitiveDataModelIsAppDefinedRelationDiscoveryEnabled),
			IsIncludeAllSchemas:                  pulumi.Any(sensitiveDataModelIsIncludeAllSchemas),
			IsIncludeAllSensitiveTypes:           pulumi.Any(sensitiveDataModelIsIncludeAllSensitiveTypes),
			IsSampleDataCollectionEnabled:        pulumi.Any(sensitiveDataModelIsSampleDataCollectionEnabled),
			SchemasForDiscoveries:                pulumi.Any(sensitiveDataModelSchemasForDiscovery),
			SensitiveTypeGroupIdsForDiscoveries:  pulumi.Any(sensitiveDataModelSensitiveTypeGroupIdsForDiscovery),
			SensitiveTypeIdsForDiscoveries:       pulumi.Any(sensitiveDataModelSensitiveTypeIdsForDiscovery),
			TablesForDiscoveries: datasafe.SensitiveDataModelTablesForDiscoveryArray{
				&datasafe.SensitiveDataModelTablesForDiscoveryArgs{
					SchemaName: pulumi.Any(sensitiveDataModelTablesForDiscoverySchemaName),
					TableNames: pulumi.Any(sensitiveDataModelTablesForDiscoveryTableNames),
				},
			},
		})
		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 testSensitiveDataModel = new Oci.DataSafe.SensitiveDataModel("test_sensitive_data_model", new()
    {
        CompartmentId = compartmentId,
        TargetId = testTarget.Id,
        AppSuiteName = sensitiveDataModelAppSuiteName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = sensitiveDataModelDescription,
        DisplayName = sensitiveDataModelDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsAppDefinedRelationDiscoveryEnabled = sensitiveDataModelIsAppDefinedRelationDiscoveryEnabled,
        IsIncludeAllSchemas = sensitiveDataModelIsIncludeAllSchemas,
        IsIncludeAllSensitiveTypes = sensitiveDataModelIsIncludeAllSensitiveTypes,
        IsSampleDataCollectionEnabled = sensitiveDataModelIsSampleDataCollectionEnabled,
        SchemasForDiscoveries = sensitiveDataModelSchemasForDiscovery,
        SensitiveTypeGroupIdsForDiscoveries = sensitiveDataModelSensitiveTypeGroupIdsForDiscovery,
        SensitiveTypeIdsForDiscoveries = sensitiveDataModelSensitiveTypeIdsForDiscovery,
        TablesForDiscoveries = new[]
        {
            new Oci.DataSafe.Inputs.SensitiveDataModelTablesForDiscoveryArgs
            {
                SchemaName = sensitiveDataModelTablesForDiscoverySchemaName,
                TableNames = sensitiveDataModelTablesForDiscoveryTableNames,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.SensitiveDataModel;
import com.pulumi.oci.DataSafe.SensitiveDataModelArgs;
import com.pulumi.oci.DataSafe.inputs.SensitiveDataModelTablesForDiscoveryArgs;
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 testSensitiveDataModel = new SensitiveDataModel("testSensitiveDataModel", SensitiveDataModelArgs.builder()
            .compartmentId(compartmentId)
            .targetId(testTarget.id())
            .appSuiteName(sensitiveDataModelAppSuiteName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(sensitiveDataModelDescription)
            .displayName(sensitiveDataModelDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .isAppDefinedRelationDiscoveryEnabled(sensitiveDataModelIsAppDefinedRelationDiscoveryEnabled)
            .isIncludeAllSchemas(sensitiveDataModelIsIncludeAllSchemas)
            .isIncludeAllSensitiveTypes(sensitiveDataModelIsIncludeAllSensitiveTypes)
            .isSampleDataCollectionEnabled(sensitiveDataModelIsSampleDataCollectionEnabled)
            .schemasForDiscoveries(sensitiveDataModelSchemasForDiscovery)
            .sensitiveTypeGroupIdsForDiscoveries(sensitiveDataModelSensitiveTypeGroupIdsForDiscovery)
            .sensitiveTypeIdsForDiscoveries(sensitiveDataModelSensitiveTypeIdsForDiscovery)
            .tablesForDiscoveries(SensitiveDataModelTablesForDiscoveryArgs.builder()
                .schemaName(sensitiveDataModelTablesForDiscoverySchemaName)
                .tableNames(sensitiveDataModelTablesForDiscoveryTableNames)
                .build())
            .build());

    }
}

    resources:
  testSensitiveDataModel:
    type: oci:DataSafe:SensitiveDataModel
    name: test_sensitive_data_model
    properties:
      compartmentId: ${compartmentId}
      targetId: ${testTarget.id}
      appSuiteName: ${sensitiveDataModelAppSuiteName}
      definedTags:
        Operations.CostCenter: '42'
      description: ${sensitiveDataModelDescription}
      displayName: ${sensitiveDataModelDisplayName}
      freeformTags:
        Department: Finance
      isAppDefinedRelationDiscoveryEnabled: ${sensitiveDataModelIsAppDefinedRelationDiscoveryEnabled}
      isIncludeAllSchemas: ${sensitiveDataModelIsIncludeAllSchemas}
      isIncludeAllSensitiveTypes: ${sensitiveDataModelIsIncludeAllSensitiveTypes}
      isSampleDataCollectionEnabled: ${sensitiveDataModelIsSampleDataCollectionEnabled}
      schemasForDiscoveries: ${sensitiveDataModelSchemasForDiscovery}
      sensitiveTypeGroupIdsForDiscoveries: ${sensitiveDataModelSensitiveTypeGroupIdsForDiscovery}
      sensitiveTypeIdsForDiscoveries: ${sensitiveDataModelSensitiveTypeIdsForDiscovery}
      tablesForDiscoveries:
        - schemaName: ${sensitiveDataModelTablesForDiscoverySchemaName}
          tableNames: ${sensitiveDataModelTablesForDiscoveryTableNames}

    Create SensitiveDataModel Resource

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

    Constructor syntax

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

@overload
def SensitiveDataModel(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       target_id: Optional[str] = None,
                       compartment_id: Optional[str] = None,
                       is_app_defined_relation_discovery_enabled: Optional[bool] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       freeform_tags: Optional[Mapping[str, str]] = None,
                       app_suite_name: Optional[str] = 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_type_group_ids_for_discoveries: Optional[Sequence[str]] = None,
                       sensitive_type_ids_for_discoveries: Optional[Sequence[str]] = None,
                       tables_for_discoveries: Optional[Sequence[SensitiveDataModelTablesForDiscoveryArgs]] = None,
                       defined_tags: Optional[Mapping[str, str]] = None)
    func NewSensitiveDataModel(ctx *Context, name string, args SensitiveDataModelArgs, opts ...ResourceOption) (*SensitiveDataModel, error)
    public SensitiveDataModel(string name, SensitiveDataModelArgs args, CustomResourceOptions? opts = null)
    public SensitiveDataModel(String name, SensitiveDataModelArgs args)
public SensitiveDataModel(String name, SensitiveDataModelArgs args, CustomResourceOptions options)

    type: oci:DataSafe:SensitiveDataModel
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 SensitiveDataModelArgs
    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 SensitiveDataModelArgs
    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 SensitiveDataModelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SensitiveDataModelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SensitiveDataModelArgs
    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 sensitiveDataModelResource = new Oci.DataSafe.SensitiveDataModel("sensitiveDataModelResource", new()
{
    TargetId = "string",
    CompartmentId = "string",
    IsAppDefinedRelationDiscoveryEnabled = false,
    Description = "string",
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    AppSuiteName = "string",
    IsIncludeAllSchemas = false,
    IsIncludeAllSensitiveTypes = false,
    IsSampleDataCollectionEnabled = false,
    SchemasForDiscoveries = new[]
    {
        "string",
    },
    SensitiveTypeGroupIdsForDiscoveries = new[]
    {
        "string",
    },
    SensitiveTypeIdsForDiscoveries = new[]
    {
        "string",
    },
    TablesForDiscoveries = new[]
    {
        new Oci.DataSafe.Inputs.SensitiveDataModelTablesForDiscoveryArgs
        {
            SchemaName = "string",
            TableNames = new[]
            {
                "string",
            },
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
});

    example, err := datasafe.NewSensitiveDataModel(ctx, "sensitiveDataModelResource", &datasafe.SensitiveDataModelArgs{
	TargetId:                             pulumi.String("string"),
	CompartmentId:                        pulumi.String("string"),
	IsAppDefinedRelationDiscoveryEnabled: pulumi.Bool(false),
	Description:                          pulumi.String("string"),
	DisplayName:                          pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AppSuiteName:                  pulumi.String("string"),
	IsIncludeAllSchemas:           pulumi.Bool(false),
	IsIncludeAllSensitiveTypes:    pulumi.Bool(false),
	IsSampleDataCollectionEnabled: pulumi.Bool(false),
	SchemasForDiscoveries: pulumi.StringArray{
		pulumi.String("string"),
	},
	SensitiveTypeGroupIdsForDiscoveries: pulumi.StringArray{
		pulumi.String("string"),
	},
	SensitiveTypeIdsForDiscoveries: pulumi.StringArray{
		pulumi.String("string"),
	},
	TablesForDiscoveries: datasafe.SensitiveDataModelTablesForDiscoveryArray{
		&datasafe.SensitiveDataModelTablesForDiscoveryArgs{
			SchemaName: pulumi.String("string"),
			TableNames: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var sensitiveDataModelResource = new SensitiveDataModel("sensitiveDataModelResource", SensitiveDataModelArgs.builder()
    .targetId("string")
    .compartmentId("string")
    .isAppDefinedRelationDiscoveryEnabled(false)
    .description("string")
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .appSuiteName("string")
    .isIncludeAllSchemas(false)
    .isIncludeAllSensitiveTypes(false)
    .isSampleDataCollectionEnabled(false)
    .schemasForDiscoveries("string")
    .sensitiveTypeGroupIdsForDiscoveries("string")
    .sensitiveTypeIdsForDiscoveries("string")
    .tablesForDiscoveries(SensitiveDataModelTablesForDiscoveryArgs.builder()
        .schemaName("string")
        .tableNames("string")
        .build())
    .definedTags(Map.of("string", "string"))
    .build());

    sensitive_data_model_resource = oci.data_safe.SensitiveDataModel("sensitiveDataModelResource",
    target_id="string",
    compartment_id="string",
    is_app_defined_relation_discovery_enabled=False,
    description="string",
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    app_suite_name="string",
    is_include_all_schemas=False,
    is_include_all_sensitive_types=False,
    is_sample_data_collection_enabled=False,
    schemas_for_discoveries=["string"],
    sensitive_type_group_ids_for_discoveries=["string"],
    sensitive_type_ids_for_discoveries=["string"],
    tables_for_discoveries=[{
        "schema_name": "string",
        "table_names": ["string"],
    }],
    defined_tags={
        "string": "string",
    })

    const sensitiveDataModelResource = new oci.datasafe.SensitiveDataModel("sensitiveDataModelResource", {
    targetId: "string",
    compartmentId: "string",
    isAppDefinedRelationDiscoveryEnabled: false,
    description: "string",
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    appSuiteName: "string",
    isIncludeAllSchemas: false,
    isIncludeAllSensitiveTypes: false,
    isSampleDataCollectionEnabled: false,
    schemasForDiscoveries: ["string"],
    sensitiveTypeGroupIdsForDiscoveries: ["string"],
    sensitiveTypeIdsForDiscoveries: ["string"],
    tablesForDiscoveries: [{
        schemaName: "string",
        tableNames: ["string"],
    }],
    definedTags: {
        string: "string",
    },
});

    type: oci:DataSafe:SensitiveDataModel
properties:
    appSuiteName: string
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    isAppDefinedRelationDiscoveryEnabled: false
    isIncludeAllSchemas: false
    isIncludeAllSensitiveTypes: false
    isSampleDataCollectionEnabled: false
    schemasForDiscoveries:
        - string
    sensitiveTypeGroupIdsForDiscoveries:
        - string
    sensitiveTypeIdsForDiscoveries:
        - string
    tablesForDiscoveries:
        - schemaName: string
          tableNames:
            - string
    targetId: string

    SensitiveDataModel Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SensitiveDataModel resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    TargetId string

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

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

    AppSuiteName string
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive data model.
    DisplayName string
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    IsAppDefinedRelationDiscoveryEnabled bool
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    IsIncludeAllSchemas bool
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    IsIncludeAllSensitiveTypes bool
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    IsSampleDataCollectionEnabled bool
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    SchemasForDiscoveries List<string>
    (Updatable) The schemas to be scanned by data discovery jobs.
    SensitiveTypeGroupIdsForDiscoveries List<string>
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    SensitiveTypeIdsForDiscoveries List<string>
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    TablesForDiscoveries List<SensitiveDataModelTablesForDiscovery>
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    TargetId string

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

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

    AppSuiteName string
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive data model.
    DisplayName string
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    IsAppDefinedRelationDiscoveryEnabled bool
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    IsIncludeAllSchemas bool
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    IsIncludeAllSensitiveTypes bool
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    IsSampleDataCollectionEnabled bool
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    SchemasForDiscoveries []string
    (Updatable) The schemas to be scanned by data discovery jobs.
    SensitiveTypeGroupIdsForDiscoveries []string
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    SensitiveTypeIdsForDiscoveries []string
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    TablesForDiscoveries []SensitiveDataModelTablesForDiscoveryArgs
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    targetId String

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

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

    appSuiteName String
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive data model.
    displayName String
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    isAppDefinedRelationDiscoveryEnabled Boolean
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    isIncludeAllSchemas Boolean
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    isIncludeAllSensitiveTypes Boolean
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    isSampleDataCollectionEnabled Boolean
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemasForDiscoveries List<String>
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitiveTypeGroupIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitiveTypeIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    tablesForDiscoveries List<SensitiveDataModelTablesForDiscovery>
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    compartmentId string
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    targetId string

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

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

    appSuiteName string
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the sensitive data model.
    displayName string
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    isAppDefinedRelationDiscoveryEnabled boolean
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    isIncludeAllSchemas boolean
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    isIncludeAllSensitiveTypes boolean
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    isSampleDataCollectionEnabled boolean
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemasForDiscoveries string[]
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitiveTypeGroupIdsForDiscoveries string[]
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitiveTypeIdsForDiscoveries string[]
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    tablesForDiscoveries SensitiveDataModelTablesForDiscovery[]
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    compartment_id str
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    target_id str

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

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

    app_suite_name str
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the sensitive data model.
    display_name str
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    is_app_defined_relation_discovery_enabled bool
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    is_include_all_schemas bool
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    is_include_all_sensitive_types bool
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    is_sample_data_collection_enabled bool
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemas_for_discoveries Sequence[str]
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitive_type_group_ids_for_discoveries Sequence[str]
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitive_type_ids_for_discoveries Sequence[str]
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    tables_for_discoveries Sequence[SensitiveDataModelTablesForDiscoveryArgs]
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    targetId String

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

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

    appSuiteName String
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive data model.
    displayName String
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    isAppDefinedRelationDiscoveryEnabled Boolean
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    isIncludeAllSchemas Boolean
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    isIncludeAllSensitiveTypes Boolean
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    isSampleDataCollectionEnabled Boolean
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemasForDiscoveries List<String>
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitiveTypeGroupIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitiveTypeIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    tablesForDiscoveries List<Property Map>
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the sensitive data model.
    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"}
    TimeCreated string
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the sensitive data model.
    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"}
    TimeCreated string
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the sensitive data model.
    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"}
    timeCreated String
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the sensitive data model.
    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"}
    timeCreated string
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    timeUpdated string
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the sensitive data model.
    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"}
    time_created str
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    time_updated str
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the sensitive data model.
    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"}
    timeCreated String
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.

    Look up Existing SensitiveDataModel Resource

    Get an existing SensitiveDataModel 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?: SensitiveDataModelState, opts?: CustomResourceOptions): SensitiveDataModel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_suite_name: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: 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_type_group_ids_for_discoveries: Optional[Sequence[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[SensitiveDataModelTablesForDiscoveryArgs]] = None,
        target_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> SensitiveDataModel
    func GetSensitiveDataModel(ctx *Context, name string, id IDInput, state *SensitiveDataModelState, opts ...ResourceOption) (*SensitiveDataModel, error)
    public static SensitiveDataModel Get(string name, Input<string> id, SensitiveDataModelState? state, CustomResourceOptions? opts = null)
    public static SensitiveDataModel get(String name, Output<String> id, SensitiveDataModelState state, CustomResourceOptions options)
    resources:  _:    type: oci:DataSafe:SensitiveDataModel    get:      id: ${id}
    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:
    AppSuiteName string
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive data model.
    DisplayName string
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    IsAppDefinedRelationDiscoveryEnabled bool
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    IsIncludeAllSchemas bool
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    IsIncludeAllSensitiveTypes bool
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    IsSampleDataCollectionEnabled bool
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    SchemasForDiscoveries List<string>
    (Updatable) The schemas to be scanned by data discovery jobs.
    SensitiveTypeGroupIdsForDiscoveries List<string>
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    SensitiveTypeIdsForDiscoveries List<string>
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    State string
    The current state of the sensitive data model.
    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<SensitiveDataModelTablesForDiscovery>
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    TargetId string

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

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

    TimeCreated string
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    AppSuiteName string
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive data model.
    DisplayName string
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    IsAppDefinedRelationDiscoveryEnabled bool
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    IsIncludeAllSchemas bool
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    IsIncludeAllSensitiveTypes bool
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    IsSampleDataCollectionEnabled bool
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    SchemasForDiscoveries []string
    (Updatable) The schemas to be scanned by data discovery jobs.
    SensitiveTypeGroupIdsForDiscoveries []string
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    SensitiveTypeIdsForDiscoveries []string
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    State string
    The current state of the sensitive data model.
    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 []SensitiveDataModelTablesForDiscoveryArgs
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    TargetId string

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

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

    TimeCreated string
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    appSuiteName String
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive data model.
    displayName String
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    isAppDefinedRelationDiscoveryEnabled Boolean
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    isIncludeAllSchemas Boolean
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    isIncludeAllSensitiveTypes Boolean
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    isSampleDataCollectionEnabled Boolean
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemasForDiscoveries List<String>
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitiveTypeGroupIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitiveTypeIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    state String
    The current state of the sensitive data model.
    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<SensitiveDataModelTablesForDiscovery>
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    targetId String

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

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

    timeCreated String
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    appSuiteName string
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartmentId string
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the sensitive data model.
    displayName string
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    isAppDefinedRelationDiscoveryEnabled boolean
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    isIncludeAllSchemas boolean
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    isIncludeAllSensitiveTypes boolean
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    isSampleDataCollectionEnabled boolean
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemasForDiscoveries string[]
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitiveTypeGroupIdsForDiscoveries string[]
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitiveTypeIdsForDiscoveries string[]
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    state string
    The current state of the sensitive data model.
    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 SensitiveDataModelTablesForDiscovery[]
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    targetId string

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

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

    timeCreated string
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    timeUpdated string
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    app_suite_name str
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartment_id str
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the sensitive data model.
    display_name str
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    is_app_defined_relation_discovery_enabled bool
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    is_include_all_schemas bool
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    is_include_all_sensitive_types bool
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    is_sample_data_collection_enabled bool
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemas_for_discoveries Sequence[str]
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitive_type_group_ids_for_discoveries Sequence[str]
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitive_type_ids_for_discoveries Sequence[str]
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    state str
    The current state of the sensitive data model.
    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[SensitiveDataModelTablesForDiscoveryArgs]
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    target_id str

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

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

    time_created str
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    time_updated str
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.
    appSuiteName String
    (Updatable) The application suite name identifying a collection of applications. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive data model should be created.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive data model.
    displayName String
    (Updatable) The display name of the sensitive data model. The name does not have to be unique, and it's changeable.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    isAppDefinedRelationDiscoveryEnabled Boolean
    (Updatable) Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.
    isIncludeAllSchemas Boolean
    Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
    isIncludeAllSensitiveTypes Boolean
    Indicates if all the existing sensitive types should be used by data discovery jobs. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
    isSampleDataCollectionEnabled Boolean
    (Updatable) Indicates if data discovery jobs should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.
    schemasForDiscoveries List<String>
    (Updatable) The schemas to be scanned by data discovery jobs.
    sensitiveTypeGroupIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive type groups to be used by data discovery jobs. All the sensitive types present in sensitive type group will be used for discovery.
    sensitiveTypeIdsForDiscoveries List<String>
    (Updatable) The OCIDs of the sensitive types to be used by data discovery jobs. If OCID of a sensitive category is provided, all its child sensitive types are used for data discovery.
    state String
    The current state of the sensitive data model.
    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>
    (Updatable) The data discovery jobs will scan the tables specified here, including both schemas and tables. For instance, the input could be in the format: [{schemaName: "HR", tableName: ["T1", "T2"]}, {schemaName: "OE", tableName : ["T3", "T4"]}].
    targetId String

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

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

    timeCreated String
    The date and time the sensitive data model was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the sensitive data model was last updated, in the format defined by RFC3339.

    Supporting Types

    SensitiveDataModelTablesForDiscovery, SensitiveDataModelTablesForDiscoveryArgs

    SchemaName string
    (Updatable) This contains the name of the schema.
    TableNames List<string>
    (Updatable) This contains an optional list of the table names.
    SchemaName string
    (Updatable) This contains the name of the schema.
    TableNames []string
    (Updatable) This contains an optional list of the table names.
    schemaName String
    (Updatable) This contains the name of the schema.
    tableNames List<String>
    (Updatable) This contains an optional list of the table names.
    schemaName string
    (Updatable) This contains the name of the schema.
    tableNames string[]
    (Updatable) This contains an optional list of the table names.
    schema_name str
    (Updatable) This contains the name of the schema.
    table_names Sequence[str]
    (Updatable) This contains an optional list of the table names.
    schemaName String
    (Updatable) This contains the name of the schema.
    tableNames List<String>
    (Updatable) This contains an optional list of the table names.

    Import

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

    $ pulumi import oci:DataSafe/sensitiveDataModel:SensitiveDataModel test_sensitive_data_model "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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci