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

oci.DataSafe.SensitiveType

Explore with Pulumi AI

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

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

    Creates a new sensitive type, which can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types.

    Example Usage

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

const testSensitiveType = new oci.datasafe.SensitiveType("test_sensitive_type", {
    compartmentId: compartmentId,
    entityType: sensitiveTypeEntityType,
    commentPattern: sensitiveTypeCommentPattern,
    dataPattern: sensitiveTypeDataPattern,
    defaultMaskingFormatId: testDefaultMaskingFormat.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: sensitiveTypeDescription,
    displayName: sensitiveTypeDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    namePattern: sensitiveTypeNamePattern,
    parentCategoryId: testCategory.id,
    searchType: sensitiveTypeSearchType,
    shortName: sensitiveTypeShortName,
});

    import pulumi
import pulumi_oci as oci

test_sensitive_type = oci.data_safe.SensitiveType("test_sensitive_type",
    compartment_id=compartment_id,
    entity_type=sensitive_type_entity_type,
    comment_pattern=sensitive_type_comment_pattern,
    data_pattern=sensitive_type_data_pattern,
    default_masking_format_id=test_default_masking_format["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=sensitive_type_description,
    display_name=sensitive_type_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    name_pattern=sensitive_type_name_pattern,
    parent_category_id=test_category["id"],
    search_type=sensitive_type_search_type,
    short_name=sensitive_type_short_name)

    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.NewSensitiveType(ctx, "test_sensitive_type", &datasafe.SensitiveTypeArgs{
			CompartmentId:          pulumi.Any(compartmentId),
			EntityType:             pulumi.Any(sensitiveTypeEntityType),
			CommentPattern:         pulumi.Any(sensitiveTypeCommentPattern),
			DataPattern:            pulumi.Any(sensitiveTypeDataPattern),
			DefaultMaskingFormatId: pulumi.Any(testDefaultMaskingFormat.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(sensitiveTypeDescription),
			DisplayName: pulumi.Any(sensitiveTypeDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			NamePattern:      pulumi.Any(sensitiveTypeNamePattern),
			ParentCategoryId: pulumi.Any(testCategory.Id),
			SearchType:       pulumi.Any(sensitiveTypeSearchType),
			ShortName:        pulumi.Any(sensitiveTypeShortName),
		})
		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 = new Oci.DataSafe.SensitiveType("test_sensitive_type", new()
    {
        CompartmentId = compartmentId,
        EntityType = sensitiveTypeEntityType,
        CommentPattern = sensitiveTypeCommentPattern,
        DataPattern = sensitiveTypeDataPattern,
        DefaultMaskingFormatId = testDefaultMaskingFormat.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = sensitiveTypeDescription,
        DisplayName = sensitiveTypeDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        NamePattern = sensitiveTypeNamePattern,
        ParentCategoryId = testCategory.Id,
        SearchType = sensitiveTypeSearchType,
        ShortName = sensitiveTypeShortName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.SensitiveType;
import com.pulumi.oci.DataSafe.SensitiveTypeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testSensitiveType = new SensitiveType("testSensitiveType", SensitiveTypeArgs.builder()
            .compartmentId(compartmentId)
            .entityType(sensitiveTypeEntityType)
            .commentPattern(sensitiveTypeCommentPattern)
            .dataPattern(sensitiveTypeDataPattern)
            .defaultMaskingFormatId(testDefaultMaskingFormat.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(sensitiveTypeDescription)
            .displayName(sensitiveTypeDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .namePattern(sensitiveTypeNamePattern)
            .parentCategoryId(testCategory.id())
            .searchType(sensitiveTypeSearchType)
            .shortName(sensitiveTypeShortName)
            .build());

    }
}

    resources:
  testSensitiveType:
    type: oci:DataSafe:SensitiveType
    name: test_sensitive_type
    properties:
      compartmentId: ${compartmentId}
      entityType: ${sensitiveTypeEntityType}
      commentPattern: ${sensitiveTypeCommentPattern}
      dataPattern: ${sensitiveTypeDataPattern}
      defaultMaskingFormatId: ${testDefaultMaskingFormat.id}
      definedTags:
        Operations.CostCenter: '42'
      description: ${sensitiveTypeDescription}
      displayName: ${sensitiveTypeDisplayName}
      freeformTags:
        Department: Finance
      namePattern: ${sensitiveTypeNamePattern}
      parentCategoryId: ${testCategory.id}
      searchType: ${sensitiveTypeSearchType}
      shortName: ${sensitiveTypeShortName}

    Create SensitiveType Resource

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

    Constructor syntax

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

@overload
def SensitiveType(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  entity_type: Optional[str] = None,
                  compartment_id: Optional[str] = None,
                  display_name: Optional[str] = None,
                  default_masking_format_id: Optional[str] = None,
                  defined_tags: Optional[Mapping[str, str]] = None,
                  description: Optional[str] = None,
                  comment_pattern: Optional[str] = None,
                  data_pattern: Optional[str] = None,
                  freeform_tags: Optional[Mapping[str, str]] = None,
                  name_pattern: Optional[str] = None,
                  parent_category_id: Optional[str] = None,
                  search_type: Optional[str] = None,
                  short_name: Optional[str] = None)
    func NewSensitiveType(ctx *Context, name string, args SensitiveTypeArgs, opts ...ResourceOption) (*SensitiveType, error)
    public SensitiveType(string name, SensitiveTypeArgs args, CustomResourceOptions? opts = null)
    public SensitiveType(String name, SensitiveTypeArgs args)
public SensitiveType(String name, SensitiveTypeArgs args, CustomResourceOptions options)

    type: oci:DataSafe:SensitiveType
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SensitiveTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SensitiveTypeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SensitiveTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SensitiveTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SensitiveTypeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sensitiveTypeResource = new Oci.DataSafe.SensitiveType("sensitiveTypeResource", new()
{
    EntityType = "string",
    CompartmentId = "string",
    DisplayName = "string",
    DefaultMaskingFormatId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    CommentPattern = "string",
    DataPattern = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    NamePattern = "string",
    ParentCategoryId = "string",
    SearchType = "string",
    ShortName = "string",
});

    example, err := datasafe.NewSensitiveType(ctx, "sensitiveTypeResource", &datasafe.SensitiveTypeArgs{
	EntityType:             pulumi.String("string"),
	CompartmentId:          pulumi.String("string"),
	DisplayName:            pulumi.String("string"),
	DefaultMaskingFormatId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description:    pulumi.String("string"),
	CommentPattern: pulumi.String("string"),
	DataPattern:    pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NamePattern:      pulumi.String("string"),
	ParentCategoryId: pulumi.String("string"),
	SearchType:       pulumi.String("string"),
	ShortName:        pulumi.String("string"),
})

    var sensitiveTypeResource = new SensitiveType("sensitiveTypeResource", SensitiveTypeArgs.builder()
    .entityType("string")
    .compartmentId("string")
    .displayName("string")
    .defaultMaskingFormatId("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .commentPattern("string")
    .dataPattern("string")
    .freeformTags(Map.of("string", "string"))
    .namePattern("string")
    .parentCategoryId("string")
    .searchType("string")
    .shortName("string")
    .build());

    sensitive_type_resource = oci.data_safe.SensitiveType("sensitiveTypeResource",
    entity_type="string",
    compartment_id="string",
    display_name="string",
    default_masking_format_id="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    comment_pattern="string",
    data_pattern="string",
    freeform_tags={
        "string": "string",
    },
    name_pattern="string",
    parent_category_id="string",
    search_type="string",
    short_name="string")

    const sensitiveTypeResource = new oci.datasafe.SensitiveType("sensitiveTypeResource", {
    entityType: "string",
    compartmentId: "string",
    displayName: "string",
    defaultMaskingFormatId: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    commentPattern: "string",
    dataPattern: "string",
    freeformTags: {
        string: "string",
    },
    namePattern: "string",
    parentCategoryId: "string",
    searchType: "string",
    shortName: "string",
});

    type: oci:DataSafe:SensitiveType
properties:
    commentPattern: string
    compartmentId: string
    dataPattern: string
    defaultMaskingFormatId: string
    definedTags:
        string: string
    description: string
    displayName: string
    entityType: string
    freeformTags:
        string: string
    namePattern: string
    parentCategoryId: string
    searchType: string
    shortName: string

    SensitiveType Resource Properties

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

    Inputs

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

    The SensitiveType resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    EntityType string
    (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    CommentPattern string
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    DataPattern string
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    DefaultMaskingFormatId string
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive type.
    DisplayName string
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    FreeformTags Dictionary<string, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    NamePattern string
    (Updatable) A regular expression to be used by data discovery for matching column names.
    ParentCategoryId string
    (Updatable) The OCID of the parent sensitive category.
    SearchType string
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    ShortName string

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    EntityType string
    (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    CommentPattern string
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    DataPattern string
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    DefaultMaskingFormatId string
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive type.
    DisplayName string
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    FreeformTags map[string]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    NamePattern string
    (Updatable) A regular expression to be used by data discovery for matching column names.
    ParentCategoryId string
    (Updatable) The OCID of the parent sensitive category.
    SearchType string
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    ShortName string

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    entityType String
    (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    commentPattern String
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    dataPattern String
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId String
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive type.
    displayName String
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    freeformTags Map<String,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    namePattern String
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parentCategoryId String
    (Updatable) The OCID of the parent sensitive category.
    searchType String
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    shortName String

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    entityType string
    (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    commentPattern string
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    dataPattern string
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId string
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the sensitive type.
    displayName string
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    freeformTags {[key: string]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    namePattern string
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parentCategoryId string
    (Updatable) The OCID of the parent sensitive category.
    searchType string
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    shortName string

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    entity_type str
    (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    comment_pattern str
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    data_pattern str
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    default_masking_format_id str
    (Updatable) 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, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the sensitive type.
    display_name str
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    freeform_tags Mapping[str, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    name_pattern str
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parent_category_id str
    (Updatable) The OCID of the parent sensitive category.
    search_type str
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    short_name str

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    entityType String
    (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
    commentPattern String
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    dataPattern String
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId String
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive type.
    displayName String
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    freeformTags Map<String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    namePattern String
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parentCategoryId String
    (Updatable) The OCID of the parent sensitive category.
    searchType String
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    shortName String

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Source string
    Specifies whether the sensitive type is user-defined or predefined.
    State string
    The current state of the sensitive type.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the sensitive 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Source string
    Specifies whether the sensitive type is user-defined or predefined.
    State string
    The current state of the sensitive type.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the sensitive 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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    source String
    Specifies whether the sensitive type is user-defined or predefined.
    state String
    The current state of the sensitive type.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the sensitive 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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    source string
    Specifies whether the sensitive type is user-defined or predefined.
    state string
    The current state of the sensitive type.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the sensitive 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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the sensitive 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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    source String
    Specifies whether the sensitive type is user-defined or predefined.
    state String
    The current state of the sensitive type.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the sensitive 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.

    Look up Existing SensitiveType Resource

    Get an existing SensitiveType resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SensitiveTypeState, opts?: CustomResourceOptions): SensitiveType
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment_pattern: Optional[str] = None,
        compartment_id: Optional[str] = None,
        data_pattern: Optional[str] = None,
        default_masking_format_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        entity_type: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_common: Optional[bool] = None,
        name_pattern: Optional[str] = None,
        parent_category_id: Optional[str] = None,
        search_type: Optional[str] = None,
        short_name: Optional[str] = None,
        source: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> SensitiveType
    func GetSensitiveType(ctx *Context, name string, id IDInput, state *SensitiveTypeState, opts ...ResourceOption) (*SensitiveType, error)
    public static SensitiveType Get(string name, Input<string> id, SensitiveTypeState? state, CustomResourceOptions? opts = null)
    public static SensitiveType get(String name, Output<String> id, SensitiveTypeState state, CustomResourceOptions options)
    resources:  _:    type: oci:DataSafe:SensitiveType    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CommentPattern string
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    DataPattern string
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    DefaultMaskingFormatId string
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive type.
    DisplayName string
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    EntityType string
    (Updatable) 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, string>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    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
    (Updatable) A regular expression to be used by data discovery for matching column names.
    ParentCategoryId string
    (Updatable) The OCID of the parent sensitive category.
    SearchType string
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    ShortName string

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Source string
    Specifies whether the sensitive type is user-defined or predefined.
    State string
    The current state of the sensitive type.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the sensitive 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
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    CompartmentId string
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    DataPattern string
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    DefaultMaskingFormatId string
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description of the sensitive type.
    DisplayName string
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    EntityType string
    (Updatable) 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]string
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    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
    (Updatable) A regular expression to be used by data discovery for matching column names.
    ParentCategoryId string
    (Updatable) The OCID of the parent sensitive category.
    SearchType string
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    ShortName string

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Source string
    Specifies whether the sensitive type is user-defined or predefined.
    State string
    The current state of the sensitive type.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the sensitive 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
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    dataPattern String
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId String
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive type.
    displayName String
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    entityType String
    (Updatable) 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,String>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    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
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parentCategoryId String
    (Updatable) The OCID of the parent sensitive category.
    searchType String
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    shortName String

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    source String
    Specifies whether the sensitive type is user-defined or predefined.
    state String
    The current state of the sensitive type.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the sensitive 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
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    compartmentId string
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    dataPattern string
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId string
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description of the sensitive type.
    displayName string
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    entityType string
    (Updatable) 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]: string}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    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
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parentCategoryId string
    (Updatable) The OCID of the parent sensitive category.
    searchType string
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    shortName string

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    source string
    Specifies whether the sensitive type is user-defined or predefined.
    state string
    The current state of the sensitive type.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the sensitive 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
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    compartment_id str
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    data_pattern str
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    default_masking_format_id str
    (Updatable) 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, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description of the sensitive type.
    display_name str
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    entity_type str
    (Updatable) 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, str]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    is_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
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parent_category_id str
    (Updatable) The OCID of the parent sensitive category.
    search_type str
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    short_name str

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the sensitive 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
    (Updatable) A regular expression to be used by data discovery for matching column comments.
    compartmentId String
    (Updatable) The OCID of the compartment where the sensitive type should be created.
    dataPattern String
    (Updatable) A regular expression to be used by data discovery for matching column data values.
    defaultMaskingFormatId String
    (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description of the sensitive type.
    displayName String
    (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable.
    entityType String
    (Updatable) 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>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example: {"Department": "Finance"}
    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
    (Updatable) A regular expression to be used by data discovery for matching column names.
    parentCategoryId String
    (Updatable) The OCID of the parent sensitive category.
    searchType String
    (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.
    shortName String

    (Updatable) The short name of the sensitive type.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    source String
    Specifies whether the sensitive type is user-defined or predefined.
    state String
    The current state of the sensitive type.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the sensitive 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.

    Import

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

    $ pulumi import oci:DataSafe/sensitiveType:SensitiveType test_sensitive_type "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci