1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getSensitiveDataModelsSensitiveColumn
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.DataSafe.getSensitiveDataModelsSensitiveColumn

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

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

    Gets the details of the specified sensitive column.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSensitiveDataModelsSensitiveColumn = oci.DataSafe.getSensitiveDataModelsSensitiveColumn({
        sensitiveColumnKey: sensitiveDataModelsSensitiveColumnSensitiveColumnKey,
        sensitiveDataModelId: testSensitiveDataModel.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_sensitive_data_models_sensitive_column = oci.DataSafe.get_sensitive_data_models_sensitive_column(sensitive_column_key=sensitive_data_models_sensitive_column_sensitive_column_key,
        sensitive_data_model_id=test_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.GetSensitiveDataModelsSensitiveColumn(ctx, &datasafe.GetSensitiveDataModelsSensitiveColumnArgs{
    			SensitiveColumnKey:   sensitiveDataModelsSensitiveColumnSensitiveColumnKey,
    			SensitiveDataModelId: testSensitiveDataModel.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 testSensitiveDataModelsSensitiveColumn = Oci.DataSafe.GetSensitiveDataModelsSensitiveColumn.Invoke(new()
        {
            SensitiveColumnKey = sensitiveDataModelsSensitiveColumnSensitiveColumnKey,
            SensitiveDataModelId = testSensitiveDataModel.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.GetSensitiveDataModelsSensitiveColumnArgs;
    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 testSensitiveDataModelsSensitiveColumn = DataSafeFunctions.getSensitiveDataModelsSensitiveColumn(GetSensitiveDataModelsSensitiveColumnArgs.builder()
                .sensitiveColumnKey(sensitiveDataModelsSensitiveColumnSensitiveColumnKey)
                .sensitiveDataModelId(testSensitiveDataModel.id())
                .build());
    
        }
    }
    
    variables:
      testSensitiveDataModelsSensitiveColumn:
        fn::invoke:
          Function: oci:DataSafe:getSensitiveDataModelsSensitiveColumn
          Arguments:
            sensitiveColumnKey: ${sensitiveDataModelsSensitiveColumnSensitiveColumnKey}
            sensitiveDataModelId: ${testSensitiveDataModel.id}
    

    Using getSensitiveDataModelsSensitiveColumn

    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 getSensitiveDataModelsSensitiveColumn(args: GetSensitiveDataModelsSensitiveColumnArgs, opts?: InvokeOptions): Promise<GetSensitiveDataModelsSensitiveColumnResult>
    function getSensitiveDataModelsSensitiveColumnOutput(args: GetSensitiveDataModelsSensitiveColumnOutputArgs, opts?: InvokeOptions): Output<GetSensitiveDataModelsSensitiveColumnResult>
    def get_sensitive_data_models_sensitive_column(sensitive_column_key: Optional[str] = None,
                                                   sensitive_data_model_id: Optional[str] = None,
                                                   opts: Optional[InvokeOptions] = None) -> GetSensitiveDataModelsSensitiveColumnResult
    def get_sensitive_data_models_sensitive_column_output(sensitive_column_key: Optional[pulumi.Input[str]] = None,
                                                   sensitive_data_model_id: Optional[pulumi.Input[str]] = None,
                                                   opts: Optional[InvokeOptions] = None) -> Output[GetSensitiveDataModelsSensitiveColumnResult]
    func GetSensitiveDataModelsSensitiveColumn(ctx *Context, args *GetSensitiveDataModelsSensitiveColumnArgs, opts ...InvokeOption) (*GetSensitiveDataModelsSensitiveColumnResult, error)
    func GetSensitiveDataModelsSensitiveColumnOutput(ctx *Context, args *GetSensitiveDataModelsSensitiveColumnOutputArgs, opts ...InvokeOption) GetSensitiveDataModelsSensitiveColumnResultOutput

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

    public static class GetSensitiveDataModelsSensitiveColumn 
    {
        public static Task<GetSensitiveDataModelsSensitiveColumnResult> InvokeAsync(GetSensitiveDataModelsSensitiveColumnArgs args, InvokeOptions? opts = null)
        public static Output<GetSensitiveDataModelsSensitiveColumnResult> Invoke(GetSensitiveDataModelsSensitiveColumnInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSensitiveDataModelsSensitiveColumnResult> getSensitiveDataModelsSensitiveColumn(GetSensitiveDataModelsSensitiveColumnArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataSafe/getSensitiveDataModelsSensitiveColumn:getSensitiveDataModelsSensitiveColumn
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SensitiveColumnKey string
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    SensitiveDataModelId string
    The OCID of the sensitive data model.
    SensitiveColumnKey string
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    SensitiveDataModelId string
    The OCID of the sensitive data model.
    sensitiveColumnKey String
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    sensitiveDataModelId String
    The OCID of the sensitive data model.
    sensitiveColumnKey string
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    sensitiveDataModelId string
    The OCID of the sensitive data model.
    sensitive_column_key str
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    sensitive_data_model_id str
    The OCID of the sensitive data model.
    sensitiveColumnKey String
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    sensitiveDataModelId String
    The OCID of the sensitive data model.

    getSensitiveDataModelsSensitiveColumn Result

    The following output properties are available:

    AppDefinedChildColumnKeys List<string>
    Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
    AppName string
    The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.
    ColumnGroups List<string>
    The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.
    ColumnName string
    The name of the sensitive column.
    DataType string
    The data type of the sensitive column.
    DbDefinedChildColumnKeys List<string>
    Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
    EstimatedDataValueCount string
    The estimated number of data values the column has in the associated database.
    Id string
    Key string
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    LifecycleDetails string
    Details about the current state of the sensitive column.
    Object string
    The database object that contains the sensitive column.
    ObjectType string
    The type of the database object that contains the sensitive column.
    ParentColumnKeys List<string>
    Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
    RelationType string
    The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
    SampleDataValues List<string>
    Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.
    SchemaName string
    The database schema that contains the sensitive column.
    SensitiveColumnKey string
    SensitiveDataModelId string
    The OCID of the sensitive data model that contains the sensitive column.
    SensitiveTypeId string
    The OCID of the sensitive type associated with the sensitive column.
    Source string
    The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.
    State string
    The current state of the sensitive column.
    Status string
    The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.
    TimeCreated string
    The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
    TimeUpdated string
    The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.
    AppDefinedChildColumnKeys []string
    Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
    AppName string
    The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.
    ColumnGroups []string
    The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.
    ColumnName string
    The name of the sensitive column.
    DataType string
    The data type of the sensitive column.
    DbDefinedChildColumnKeys []string
    Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
    EstimatedDataValueCount string
    The estimated number of data values the column has in the associated database.
    Id string
    Key string
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    LifecycleDetails string
    Details about the current state of the sensitive column.
    Object string
    The database object that contains the sensitive column.
    ObjectType string
    The type of the database object that contains the sensitive column.
    ParentColumnKeys []string
    Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
    RelationType string
    The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
    SampleDataValues []string
    Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.
    SchemaName string
    The database schema that contains the sensitive column.
    SensitiveColumnKey string
    SensitiveDataModelId string
    The OCID of the sensitive data model that contains the sensitive column.
    SensitiveTypeId string
    The OCID of the sensitive type associated with the sensitive column.
    Source string
    The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.
    State string
    The current state of the sensitive column.
    Status string
    The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.
    TimeCreated string
    The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
    TimeUpdated string
    The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.
    appDefinedChildColumnKeys List<String>
    Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
    appName String
    The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.
    columnGroups List<String>
    The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.
    columnName String
    The name of the sensitive column.
    dataType String
    The data type of the sensitive column.
    dbDefinedChildColumnKeys List<String>
    Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
    estimatedDataValueCount String
    The estimated number of data values the column has in the associated database.
    id String
    key String
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    lifecycleDetails String
    Details about the current state of the sensitive column.
    object String
    The database object that contains the sensitive column.
    objectType String
    The type of the database object that contains the sensitive column.
    parentColumnKeys List<String>
    Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
    relationType String
    The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
    sampleDataValues List<String>
    Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.
    schemaName String
    The database schema that contains the sensitive column.
    sensitiveColumnKey String
    sensitiveDataModelId String
    The OCID of the sensitive data model that contains the sensitive column.
    sensitiveTypeId String
    The OCID of the sensitive type associated with the sensitive column.
    source String
    The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.
    state String
    The current state of the sensitive column.
    status String
    The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.
    timeCreated String
    The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
    timeUpdated String
    The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.
    appDefinedChildColumnKeys string[]
    Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
    appName string
    The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.
    columnGroups string[]
    The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.
    columnName string
    The name of the sensitive column.
    dataType string
    The data type of the sensitive column.
    dbDefinedChildColumnKeys string[]
    Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
    estimatedDataValueCount string
    The estimated number of data values the column has in the associated database.
    id string
    key string
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    lifecycleDetails string
    Details about the current state of the sensitive column.
    object string
    The database object that contains the sensitive column.
    objectType string
    The type of the database object that contains the sensitive column.
    parentColumnKeys string[]
    Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
    relationType string
    The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
    sampleDataValues string[]
    Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.
    schemaName string
    The database schema that contains the sensitive column.
    sensitiveColumnKey string
    sensitiveDataModelId string
    The OCID of the sensitive data model that contains the sensitive column.
    sensitiveTypeId string
    The OCID of the sensitive type associated with the sensitive column.
    source string
    The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.
    state string
    The current state of the sensitive column.
    status string
    The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.
    timeCreated string
    The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
    timeUpdated string
    The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.
    app_defined_child_column_keys Sequence[str]
    Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
    app_name str
    The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.
    column_groups Sequence[str]
    The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.
    column_name str
    The name of the sensitive column.
    data_type str
    The data type of the sensitive column.
    db_defined_child_column_keys Sequence[str]
    Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
    estimated_data_value_count str
    The estimated number of data values the column has in the associated database.
    id str
    key str
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    lifecycle_details str
    Details about the current state of the sensitive column.
    object str
    The database object that contains the sensitive column.
    object_type str
    The type of the database object that contains the sensitive column.
    parent_column_keys Sequence[str]
    Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
    relation_type str
    The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
    sample_data_values Sequence[str]
    Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.
    schema_name str
    The database schema that contains the sensitive column.
    sensitive_column_key str
    sensitive_data_model_id str
    The OCID of the sensitive data model that contains the sensitive column.
    sensitive_type_id str
    The OCID of the sensitive type associated with the sensitive column.
    source str
    The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.
    state str
    The current state of the sensitive column.
    status str
    The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.
    time_created str
    The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
    time_updated str
    The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.
    appDefinedChildColumnKeys List<String>
    Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
    appName String
    The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.
    columnGroups List<String>
    The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.
    columnName String
    The name of the sensitive column.
    dataType String
    The data type of the sensitive column.
    dbDefinedChildColumnKeys List<String>
    Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
    estimatedDataValueCount String
    The estimated number of data values the column has in the associated database.
    id String
    key String
    The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.
    lifecycleDetails String
    Details about the current state of the sensitive column.
    object String
    The database object that contains the sensitive column.
    objectType String
    The type of the database object that contains the sensitive column.
    parentColumnKeys List<String>
    Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.
    relationType String
    The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.
    sampleDataValues List<String>
    Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.
    schemaName String
    The database schema that contains the sensitive column.
    sensitiveColumnKey String
    sensitiveDataModelId String
    The OCID of the sensitive data model that contains the sensitive column.
    sensitiveTypeId String
    The OCID of the sensitive type associated with the sensitive column.
    source String
    The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.
    state String
    The current state of the sensitive column.
    status String
    The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.
    timeCreated String
    The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.
    timeUpdated String
    The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi