Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
oci.DataSafe.getSensitiveDataModel
Explore with Pulumi AI
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/v2/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:
- Sensitive
Data stringModel Id - The OCID of the sensitive data model.
- Sensitive
Data stringModel Id - The OCID of the sensitive data model.
- sensitive
Data StringModel Id - The OCID of the sensitive data model.
- sensitive
Data stringModel Id - The OCID of the sensitive data model.
- sensitive_
data_ strmodel_ id - The OCID of the sensitive data model.
- sensitive
Data StringModel Id - The OCID of the sensitive data model.
getSensitiveDataModel Result
The following output properties are available:
- App
Suite stringName - 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 string - The OCID of the compartment that contains the sensitive data model.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- The description of the sensitive data model.
- Display
Name string - The display name of the sensitive data model.
- Dictionary<string, string>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Id string
- The OCID of the sensitive data model.
- Is
App boolDefined Relation Discovery Enabled - 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 boolAll Schemas - 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 boolAll Sensitive Types - 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 boolData Collection Enabled - 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 List<string>Discoveries - The schemas to be scanned by data discovery jobs.
- Sensitive
Data stringModel Id - Sensitive
Type List<string>Ids For Discoveries - The OCIDs of the sensitive types to be used by data discovery jobs.
- State string
- The current state of the sensitive data model.
- 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"}
- Tables
For List<GetDiscoveries Sensitive Data Model Tables For Discovery> - 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 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.
- Time
Created string - The date and time the sensitive data model was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the sensitive data model was last updated, in the format defined by RFC3339.
- App
Suite stringName - 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 string - The OCID of the compartment that contains the sensitive data model.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- The description of the sensitive data model.
- Display
Name string - The display name of the sensitive data model.
- map[string]string
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Id string
- The OCID of the sensitive data model.
- Is
App boolDefined Relation Discovery Enabled - 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 boolAll Schemas - 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 boolAll Sensitive Types - 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 boolData Collection Enabled - 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 []stringDiscoveries - The schemas to be scanned by data discovery jobs.
- Sensitive
Data stringModel Id - Sensitive
Type []stringIds For Discoveries - The OCIDs of the sensitive types to be used by data discovery jobs.
- State string
- The current state of the sensitive data model.
- 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"}
- Tables
For []GetDiscoveries Sensitive Data Model Tables For Discovery - 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 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.
- Time
Created string - The date and time the sensitive data model was created, in the format defined by RFC3339.
- Time
Updated string - The date and time the sensitive data model was last updated, in the format defined by RFC3339.
- app
Suite StringName - 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 String - The OCID of the compartment that contains the sensitive data model.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- The description of the sensitive data model.
- display
Name String - The display name of the sensitive data model.
- Map<String,String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- id String
- The OCID of the sensitive data model.
- is
App BooleanDefined Relation Discovery Enabled - 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 BooleanAll Schemas - 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 BooleanAll Sensitive Types - 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 BooleanData Collection Enabled - 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 List<String>Discoveries - The schemas to be scanned by data discovery jobs.
- sensitive
Data StringModel Id - sensitive
Type List<String>Ids For Discoveries - The OCIDs of the sensitive types to be used by data discovery jobs.
- state String
- The current state of the sensitive data model.
- 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"}
- tables
For List<GetDiscoveries Sensitive Data Model Tables For Discovery> - 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 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.
- time
Created String - The date and time the sensitive data model was created, in the format defined by RFC3339.
- time
Updated String - The date and time the sensitive data model was last updated, in the format defined by RFC3339.
- app
Suite stringName - 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 string - The OCID of the compartment that contains the sensitive data model.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
- The description of the sensitive data model.
- display
Name string - The display name of the sensitive data model.
- {[key: string]: string}
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- id string
- The OCID of the sensitive data model.
- is
App booleanDefined Relation Discovery Enabled - 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 booleanAll Schemas - 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 booleanAll Sensitive Types - 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 booleanData Collection Enabled - 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 string[]Discoveries - The schemas to be scanned by data discovery jobs.
- sensitive
Data stringModel Id - sensitive
Type string[]Ids For Discoveries - The OCIDs of the sensitive types to be used by data discovery jobs.
- state string
- The current state of the sensitive data model.
- {[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"}
- tables
For GetDiscoveries Sensitive Data Model Tables For Discovery[] - 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 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.
- time
Created string - The date and time the sensitive data model was created, in the format defined by RFC3339.
- time
Updated string - The date and time the sensitive data model was last updated, in the format defined by RFC3339.
- app_
suite_ strname - 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.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
- The description of the sensitive data model.
- display_
name str - The display name of the sensitive data model.
- Mapping[str, str]
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- id str
- The OCID of the sensitive data model.
- is_
app_ booldefined_ relation_ discovery_ enabled - 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_ boolall_ schemas - 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_ boolall_ sensitive_ types - 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_ booldata_ collection_ enabled - 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_ Sequence[str]discoveries - The schemas to be scanned by data discovery jobs.
- sensitive_
data_ strmodel_ id - sensitive_
type_ Sequence[str]ids_ for_ discoveries - The OCIDs of the sensitive types to be used by data discovery jobs.
- state str
- The current state of the sensitive data model.
- 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_ Sequence[datasafe.discoveries Get Sensitive Data Model Tables For Discovery] - 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 - 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.
- app
Suite StringName - 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 String - The OCID of the compartment that contains the sensitive data model.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- The description of the sensitive data model.
- display
Name String - The display name of the sensitive data model.
- Map<String>
- Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- id String
- The OCID of the sensitive data model.
- is
App BooleanDefined Relation Discovery Enabled - 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 BooleanAll Schemas - 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 BooleanAll Sensitive Types - 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 BooleanData Collection Enabled - 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 List<String>Discoveries - The schemas to be scanned by data discovery jobs.
- sensitive
Data StringModel Id - sensitive
Type List<String>Ids For Discoveries - The OCIDs of the sensitive types to be used by data discovery jobs.
- state String
- The current state of the sensitive data model.
- 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"}
- tables
For List<Property Map>Discoveries - 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 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.
- time
Created String - The date and time the sensitive data model was created, in the format defined by RFC3339.
- time
Updated String - The date and time the sensitive data model was last updated, in the format defined by RFC3339.
Supporting Types
GetSensitiveDataModelTablesForDiscovery
- Schema
Name string - This contains the name of the schema.
- Table
Names List<string> - This contains an optional list of the table names.
- Schema
Name string - This contains the name of the schema.
- Table
Names []string - This contains an optional list of the table names.
- schema
Name String - This contains the name of the schema.
- table
Names List<String> - This contains an optional list of the table names.
- schema
Name string - This contains the name of the schema.
- table
Names string[] - This contains an optional list of the table names.
- schema_
name str - This contains the name of the schema.
- table_
names Sequence[str] - This contains an optional list of the table names.
- schema
Name String - This contains the name of the schema.
- table
Names List<String> - This contains an optional list of the table names.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.