import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Sensitive Type resource in Oracle Cloud Infrastructure Data Safe service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/data-safe/latest/SensitiveType * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/datasafe * * 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 * * ```typescript * 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 * * SensitiveTypes can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:DataSafe/sensitiveType:SensitiveType test_sensitive_type "id" * ``` */ export declare class SensitiveType extends pulumi.CustomResource { /** * Get an existing SensitiveType resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: SensitiveTypeState, opts?: pulumi.CustomResourceOptions): SensitiveType; /** * Returns true if the given object is an instance of SensitiveType. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is SensitiveType; /** * (Updatable) A regular expression to be used by data discovery for matching column comments. */ readonly commentPattern: pulumi.Output; /** * (Updatable) The OCID of the compartment where the sensitive type should be created. */ readonly compartmentId: pulumi.Output; /** * (Updatable) A regular expression to be used by data discovery for matching column data values. */ readonly dataPattern: pulumi.Output; /** * (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type. */ readonly defaultMaskingFormatId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The description of the sensitive type. */ readonly description: pulumi.Output; /** * (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable. */ readonly displayName: pulumi.Output; /** * (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. */ readonly entityType: pulumi.Output; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery. */ readonly isCommon: pulumi.Output; /** * (Updatable) A regular expression to be used by data discovery for matching column names. */ readonly namePattern: pulumi.Output; /** * (Updatable) The OCID of the parent sensitive category. */ readonly parentCategoryId: pulumi.Output; /** * (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. [Learn more](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/sensitive-types.html#GUID-1D1AD98E-B93F-4FF2-80AE-CB7D8A14F6CC). */ readonly searchType: pulumi.Output; /** * (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 */ readonly shortName: pulumi.Output; /** * Specifies whether the sensitive type is user-defined or predefined. */ readonly source: pulumi.Output; /** * The current state of the sensitive type. */ readonly state: pulumi.Output; /** * 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"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The date and time the sensitive type was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeCreated: pulumi.Output; /** * The date and time the sensitive type was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ readonly timeUpdated: pulumi.Output; /** * Create a SensitiveType resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: SensitiveTypeArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering SensitiveType resources. */ export interface SensitiveTypeState { /** * (Updatable) A regular expression to be used by data discovery for matching column comments. */ commentPattern?: pulumi.Input; /** * (Updatable) The OCID of the compartment where the sensitive type should be created. */ compartmentId?: pulumi.Input; /** * (Updatable) A regular expression to be used by data discovery for matching column data values. */ dataPattern?: pulumi.Input; /** * (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type. */ defaultMaskingFormatId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the sensitive type. */ description?: pulumi.Input; /** * (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable. */ displayName?: pulumi.Input; /** * (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. */ entityType?: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery. */ isCommon?: pulumi.Input; /** * (Updatable) A regular expression to be used by data discovery for matching column names. */ namePattern?: pulumi.Input; /** * (Updatable) The OCID of the parent sensitive category. */ parentCategoryId?: pulumi.Input; /** * (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. [Learn more](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/sensitive-types.html#GUID-1D1AD98E-B93F-4FF2-80AE-CB7D8A14F6CC). */ searchType?: pulumi.Input; /** * (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 */ shortName?: pulumi.Input; /** * Specifies whether the sensitive type is user-defined or predefined. */ source?: pulumi.Input; /** * The current state of the sensitive type. */ state?: pulumi.Input; /** * 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"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The date and time the sensitive type was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeCreated?: pulumi.Input; /** * The date and time the sensitive type was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a SensitiveType resource. */ export interface SensitiveTypeArgs { /** * (Updatable) A regular expression to be used by data discovery for matching column comments. */ commentPattern?: pulumi.Input; /** * (Updatable) The OCID of the compartment where the sensitive type should be created. */ compartmentId: pulumi.Input; /** * (Updatable) A regular expression to be used by data discovery for matching column data values. */ dataPattern?: pulumi.Input; /** * (Updatable) The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type. */ defaultMaskingFormatId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description of the sensitive type. */ description?: pulumi.Input; /** * (Updatable) The display name of the sensitive type. The name does not have to be unique, and it's changeable. */ displayName?: pulumi.Input; /** * (Updatable) The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types. */ entityType: pulumi.Input; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A regular expression to be used by data discovery for matching column names. */ namePattern?: pulumi.Input; /** * (Updatable) The OCID of the parent sensitive category. */ parentCategoryId?: pulumi.Input; /** * (Updatable) The search type indicating how the column name, comment and data patterns should be used by data discovery. [Learn more](https://docs.oracle.com/en/cloud/paas/data-safe/udscs/sensitive-types.html#GUID-1D1AD98E-B93F-4FF2-80AE-CB7D8A14F6CC). */ searchType?: pulumi.Input; /** * (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 */ shortName?: pulumi.Input; } //# sourceMappingURL=sensitiveType.d.ts.map