1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataSafe
  5. getSensitiveType
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

oci.DataSafe.getSensitiveType

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

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

    Gets the details of the specified sensitive type.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testSensitiveType = oci.DataSafe.getSensitiveType({
        sensitiveTypeId: oci_data_safe_sensitive_type.test_sensitive_type.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_sensitive_type = oci.DataSafe.get_sensitive_type(sensitive_type_id=oci_data_safe_sensitive_type["test_sensitive_type"]["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.GetSensitiveType(ctx, &datasafe.GetSensitiveTypeArgs{
    			SensitiveTypeId: oci_data_safe_sensitive_type.Test_sensitive_type.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 testSensitiveType = Oci.DataSafe.GetSensitiveType.Invoke(new()
        {
            SensitiveTypeId = oci_data_safe_sensitive_type.Test_sensitive_type.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.GetSensitiveTypeArgs;
    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 testSensitiveType = DataSafeFunctions.getSensitiveType(GetSensitiveTypeArgs.builder()
                .sensitiveTypeId(oci_data_safe_sensitive_type.test_sensitive_type().id())
                .build());
    
        }
    }
    
    variables:
      testSensitiveType:
        fn::invoke:
          Function: oci:DataSafe:getSensitiveType
          Arguments:
            sensitiveTypeId: ${oci_data_safe_sensitive_type.test_sensitive_type.id}
    

    Using getSensitiveType

    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 getSensitiveType(args: GetSensitiveTypeArgs, opts?: InvokeOptions): Promise<GetSensitiveTypeResult>
    function getSensitiveTypeOutput(args: GetSensitiveTypeOutputArgs, opts?: InvokeOptions): Output<GetSensitiveTypeResult>
    def get_sensitive_type(sensitive_type_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSensitiveTypeResult
    def get_sensitive_type_output(sensitive_type_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSensitiveTypeResult]
    func GetSensitiveType(ctx *Context, args *GetSensitiveTypeArgs, opts ...InvokeOption) (*GetSensitiveTypeResult, error)
    func GetSensitiveTypeOutput(ctx *Context, args *GetSensitiveTypeOutputArgs, opts ...InvokeOption) GetSensitiveTypeResultOutput

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

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

    The following arguments are supported:

    SensitiveTypeId string
    The OCID of the sensitive type.
    SensitiveTypeId string
    The OCID of the sensitive type.
    sensitiveTypeId String
    The OCID of the sensitive type.
    sensitiveTypeId string
    The OCID of the sensitive type.
    sensitive_type_id str
    The OCID of the sensitive type.
    sensitiveTypeId String
    The OCID of the sensitive type.

    getSensitiveType Result

    The following output properties are available:

    CommentPattern string
    A regular expression to be used by data discovery for matching column comments.
    CompartmentId string
    The OCID of the compartment that contains the sensitive type.
    DataPattern string
    A regular expression to be used by data discovery for matching column data values.
    DefaultMaskingFormatId string
    The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    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 type.
    DisplayName string
    The display name of the sensitive type.
    EntityType string
    The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    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 type.
    IsCommon bool
    Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
    NamePattern string
    A regular expression to be used by data discovery for matching column names.
    ParentCategoryId string
    The OCID of the parent sensitive category.
    SearchType string
    The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    SensitiveTypeId string
    ShortName string
    The short name of the sensitive type.
    Source string
    Specifies whether the sensitive type is user-defined or predefined.
    State string
    The current state of the sensitive type.
    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"}
    TimeCreated string
    The date and time the sensitive type was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the sensitive type was last updated, in the format defined by RFC3339.
    CommentPattern string
    A regular expression to be used by data discovery for matching column comments.
    CompartmentId string
    The OCID of the compartment that contains the sensitive type.
    DataPattern string
    A regular expression to be used by data discovery for matching column data values.
    DefaultMaskingFormatId string
    The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    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 type.
    DisplayName string
    The display name of the sensitive type.
    EntityType string
    The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    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 type.
    IsCommon bool
    Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
    NamePattern string
    A regular expression to be used by data discovery for matching column names.
    ParentCategoryId string
    The OCID of the parent sensitive category.
    SearchType string
    The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    SensitiveTypeId string
    ShortName string
    The short name of the sensitive type.
    Source string
    Specifies whether the sensitive type is user-defined or predefined.
    State string
    The current state of the sensitive type.
    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"}
    TimeCreated string
    The date and time the sensitive type was created, in the format defined by RFC3339.
    TimeUpdated string
    The date and time the sensitive type was last updated, in the format defined by RFC3339.
    commentPattern String
    A regular expression to be used by data discovery for matching column comments.
    compartmentId String
    The OCID of the compartment that contains the sensitive type.
    dataPattern String
    A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId String
    The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    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 type.
    displayName String
    The display name of the sensitive type.
    entityType String
    The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    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 type.
    isCommon Boolean
    Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
    namePattern String
    A regular expression to be used by data discovery for matching column names.
    parentCategoryId String
    The OCID of the parent sensitive category.
    searchType String
    The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    sensitiveTypeId String
    shortName String
    The short name of the sensitive type.
    source String
    Specifies whether the sensitive type is user-defined or predefined.
    state String
    The current state of the sensitive type.
    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"}
    timeCreated String
    The date and time the sensitive type was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the sensitive type was last updated, in the format defined by RFC3339.
    commentPattern string
    A regular expression to be used by data discovery for matching column comments.
    compartmentId string
    The OCID of the compartment that contains the sensitive type.
    dataPattern string
    A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId string
    The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    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 type.
    displayName string
    The display name of the sensitive type.
    entityType string
    The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    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 type.
    isCommon boolean
    Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
    namePattern string
    A regular expression to be used by data discovery for matching column names.
    parentCategoryId string
    The OCID of the parent sensitive category.
    searchType string
    The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    sensitiveTypeId string
    shortName string
    The short name of the sensitive type.
    source string
    Specifies whether the sensitive type is user-defined or predefined.
    state string
    The current state of the sensitive type.
    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"}
    timeCreated string
    The date and time the sensitive type was created, in the format defined by RFC3339.
    timeUpdated string
    The date and time the sensitive type was last updated, in the format defined by RFC3339.
    comment_pattern str
    A regular expression to be used by data discovery for matching column comments.
    compartment_id str
    The OCID of the compartment that contains the sensitive type.
    data_pattern str
    A regular expression to be used by data discovery for matching column data values.
    default_masking_format_id str
    The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    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 type.
    display_name str
    The display name of the sensitive type.
    entity_type str
    The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    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 type.
    is_common bool
    Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
    name_pattern str
    A regular expression to be used by data discovery for matching column names.
    parent_category_id str
    The OCID of the parent sensitive category.
    search_type str
    The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    sensitive_type_id str
    short_name str
    The short name of the sensitive type.
    source str
    Specifies whether the sensitive type is user-defined or predefined.
    state str
    The current state of the sensitive type.
    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"}
    time_created str
    The date and time the sensitive type was created, in the format defined by RFC3339.
    time_updated str
    The date and time the sensitive type was last updated, in the format defined by RFC3339.
    commentPattern String
    A regular expression to be used by data discovery for matching column comments.
    compartmentId String
    The OCID of the compartment that contains the sensitive type.
    dataPattern String
    A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId String
    The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    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 type.
    displayName String
    The display name of the sensitive type.
    entityType String
    The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    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 type.
    isCommon Boolean
    Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.
    namePattern String
    A regular expression to be used by data discovery for matching column names.
    parentCategoryId String
    The OCID of the parent sensitive category.
    searchType String
    The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    sensitiveTypeId String
    shortName String
    The short name of the sensitive type.
    source String
    Specifies whether the sensitive type is user-defined or predefined.
    state String
    The current state of the sensitive type.
    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"}
    timeCreated String
    The date and time the sensitive type was created, in the format defined by RFC3339.
    timeUpdated String
    The date and time the sensitive type 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.29.0 published on Thursday, Mar 28, 2024 by Pulumi