Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getSensitiveDataModel
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataSafe.getSensitiveDataModel

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Sensitive Data Model resource in Oracle Cloud Infrastructure Data Safe service.

    Gets the details of the specified sensitive data model.

    Example Usage

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

const testSensitiveDataModel = oci.DataSafe.getSensitiveDataModel({
    sensitiveDataModelId: testSensitiveDataModelOciDataSafeSensitiveDataModel.id,
});

    import pulumi
import pulumi_oci as oci

test_sensitive_data_model = oci.DataSafe.get_sensitive_data_model(sensitive_data_model_id=test_sensitive_data_model_oci_data_safe_sensitive_data_model["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataSafe.GetSensitiveDataModel(ctx, &datasafe.GetSensitiveDataModelArgs{
			SensitiveDataModelId: testSensitiveDataModelOciDataSafeSensitiveDataModel.Id,
		}, nil)
		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 = Oci.DataSafe.GetSensitiveDataModel.Invoke(new()
    {
        SensitiveDataModelId = testSensitiveDataModelOciDataSafeSensitiveDataModel.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.DataSafeFunctions;
import com.pulumi.oci.DataSafe.inputs.GetSensitiveDataModelArgs;
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) {
        final var testSensitiveDataModel = DataSafeFunctions.getSensitiveDataModel(GetSensitiveDataModelArgs.builder()
            .sensitiveDataModelId(testSensitiveDataModelOciDataSafeSensitiveDataModel.id())
            .build());

    }
}

    variables:
  testSensitiveDataModel:
    fn::invoke:
      Function: oci:DataSafe:getSensitiveDataModel
      Arguments:
        sensitiveDataModelId: ${testSensitiveDataModelOciDataSafeSensitiveDataModel.id}

    Using getSensitiveDataModel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSensitiveDataModel(args: GetSensitiveDataModelArgs, opts?: InvokeOptions): Promise<GetSensitiveDataModelResult>
function getSensitiveDataModelOutput(args: GetSensitiveDataModelOutputArgs, opts?: InvokeOptions): Output<GetSensitiveDataModelResult>
    def get_sensitive_data_model(sensitive_data_model_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSensitiveDataModelResult
def get_sensitive_data_model_output(sensitive_data_model_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSensitiveDataModelResult]
    func GetSensitiveDataModel(ctx *Context, args *GetSensitiveDataModelArgs, opts ...InvokeOption) (*GetSensitiveDataModelResult, error)
func GetSensitiveDataModelOutput(ctx *Context, args *GetSensitiveDataModelOutputArgs, opts ...InvokeOption) GetSensitiveDataModelResultOutput

    > Note: This function is named GetSensitiveDataModel in the Go SDK.

    public static class GetSensitiveDataModel 
{
    public static Task<GetSensitiveDataModelResult> InvokeAsync(GetSensitiveDataModelArgs args, InvokeOptions? opts = null)
    public static Output<GetSensitiveDataModelResult> Invoke(GetSensitiveDataModelInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSensitiveDataModelResult> getSensitiveDataModel(GetSensitiveDataModelArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:DataSafe/getSensitiveDataModel:getSensitiveDataModel
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SensitiveDataModelId string
    The OCID of the sensitive data model.
    SensitiveDataModelId string
    The OCID of the sensitive data model.
    sensitiveDataModelId String
    The OCID of the sensitive data model.
    sensitiveDataModelId string
    The OCID of the sensitive data model.
    sensitive_data_model_id str
    The OCID of the sensitive data model.
    sensitiveDataModelId String
    The OCID of the sensitive data model.

    getSensitiveDataModel Result

    The following output properties are available:

    AppSuiteName string
    The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
    CompartmentId string
    The OCID of the compartment that contains the sensitive data model.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    The description of the sensitive data model.
    DisplayName string
    The display name of the sensitive data model.
    FreeformTags Dictionary<string, object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    Id string
    The OCID of the sensitive data model.
    IsAppDefinedRelationDiscoveryEnabled bool
    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
    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>
    The schemas to be scanned by data discovery jobs.
    SensitiveDataModelId string
    SensitiveTypeIdsForDiscoveries List<string>
    The OCIDs of the sensitive types to be used by data discovery jobs.
    State string
    The current state of the sensitive data model.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetId string
    The OCID of the reference target database 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.
    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
    The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
    CompartmentId string
    The OCID of the compartment that contains the sensitive data model.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    The description of the sensitive data model.
    DisplayName string
    The display name of the sensitive data model.
    FreeformTags map[string]interface{}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    Id string
    The OCID of the sensitive data model.
    IsAppDefinedRelationDiscoveryEnabled bool
    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
    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
    The schemas to be scanned by data discovery jobs.
    SensitiveDataModelId string
    SensitiveTypeIdsForDiscoveries []string
    The OCIDs of the sensitive types to be used by data discovery jobs.
    State string
    The current state of the sensitive data model.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TargetId string
    The OCID of the reference target database 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.
    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
    The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartmentId String
    The OCID of the compartment that contains the sensitive data model.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    The description of the sensitive data model.
    displayName String
    The display name of the sensitive data model.
    freeformTags Map<String,Object>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    id String
    The OCID of the sensitive data model.
    isAppDefinedRelationDiscoveryEnabled Boolean
    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
    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>
    The schemas to be scanned by data discovery jobs.
    sensitiveDataModelId String
    sensitiveTypeIdsForDiscoveries List<String>
    The OCIDs of the sensitive types to be used by data discovery jobs.
    state String
    The current state of the sensitive data model.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetId String
    The OCID of the reference target database 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.
    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
    The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartmentId string
    The OCID of the compartment that contains the sensitive data model.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    The description of the sensitive data model.
    displayName string
    The display name of the sensitive data model.
    freeformTags {[key: string]: any}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    id string
    The OCID of the sensitive data model.
    isAppDefinedRelationDiscoveryEnabled boolean
    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
    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[]
    The schemas to be scanned by data discovery jobs.
    sensitiveDataModelId string
    sensitiveTypeIdsForDiscoveries string[]
    The OCIDs of the sensitive types to be used by data discovery jobs.
    state string
    The current state of the sensitive data model.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetId string
    The OCID of the reference target database 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.
    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
    The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartment_id str
    The OCID of the compartment that contains the sensitive data model.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    The description of the sensitive data model.
    display_name str
    The display name of the sensitive data model.
    freeform_tags Mapping[str, Any]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    id str
    The OCID of the sensitive data model.
    is_app_defined_relation_discovery_enabled bool
    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
    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]
    The schemas to be scanned by data discovery jobs.
    sensitive_data_model_id str
    sensitive_type_ids_for_discoveries Sequence[str]
    The OCIDs of the sensitive types to be used by data discovery jobs.
    state str
    The current state of the sensitive data model.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    target_id str
    The OCID of the reference target database 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.
    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
    The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
    compartmentId String
    The OCID of the compartment that contains the sensitive data model.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    The description of the sensitive data model.
    displayName String
    The display name of the sensitive data model.
    freeformTags Map<Any>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    id String
    The OCID of the sensitive data model.
    isAppDefinedRelationDiscoveryEnabled Boolean
    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
    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>
    The schemas to be scanned by data discovery jobs.
    sensitiveDataModelId String
    sensitiveTypeIdsForDiscoveries List<String>
    The OCIDs of the sensitive types to be used by data discovery jobs.
    state String
    The current state of the sensitive data model.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    targetId String
    The OCID of the reference target database 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.
    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.

    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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci