import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * An inspect job template. * * To get more information about InspectTemplate, see: * * * [API documentation](https://cloud.google.com/dlp/docs/reference/rest/v2/projects.inspectTemplates) * * How-to Guides * * [Official Documentation](https://cloud.google.com/dlp/docs/creating-templates-inspect) * * ## Example Usage * * ### Dlp Inspect Template Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const basic = new gcp.dataloss.PreventionInspectTemplate("basic", { * parent: "projects/my-project-name", * description: "My description", * displayName: "display_name", * inspectConfig: { * infoTypes: [ * { * name: "EMAIL_ADDRESS", * }, * { * name: "PERSON_NAME", * }, * { * name: "LAST_NAME", * }, * { * name: "DOMAIN_NAME", * }, * { * name: "PHONE_NUMBER", * }, * { * name: "FIRST_NAME", * }, * ], * minLikelihood: "UNLIKELY", * ruleSets: [ * { * infoTypes: [{ * name: "EMAIL_ADDRESS", * }], * rules: [{ * exclusionRule: { * regex: { * pattern: ".+@example.com", * }, * matchingType: "MATCHING_TYPE_FULL_MATCH", * }, * }], * }, * { * infoTypes: [ * { * name: "EMAIL_ADDRESS", * }, * { * name: "DOMAIN_NAME", * }, * { * name: "PHONE_NUMBER", * }, * { * name: "PERSON_NAME", * }, * { * name: "FIRST_NAME", * }, * ], * rules: [{ * exclusionRule: { * dictionary: { * wordList: { * words: ["TEST"], * }, * }, * matchingType: "MATCHING_TYPE_PARTIAL_MATCH", * }, * }], * }, * { * infoTypes: [{ * name: "PERSON_NAME", * }], * rules: [{ * hotwordRule: { * hotwordRegex: { * pattern: "patient", * }, * proximity: { * windowBefore: 50, * }, * likelihoodAdjustment: { * fixedLikelihood: "VERY_LIKELY", * }, * }, * }], * }, * ], * limits: { * maxFindingsPerItem: 10, * maxFindingsPerRequest: 50, * maxFindingsPerInfoTypes: [ * { * maxFindings: 75, * infoType: { * name: "PERSON_NAME", * }, * }, * { * maxFindings: 80, * infoType: { * name: "LAST_NAME", * }, * }, * ], * }, * }, * }); * ``` * ### Dlp Inspect Template Custom Type * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const custom = new gcp.dataloss.PreventionInspectTemplate("custom", { * parent: "projects/my-project-name", * description: "My description", * displayName: "display_name", * inspectConfig: { * customInfoTypes: [{ * infoType: { * name: "MY_CUSTOM_TYPE", * }, * likelihood: "UNLIKELY", * regex: { * pattern: "test*", * }, * }], * infoTypes: [{ * name: "EMAIL_ADDRESS", * }], * minLikelihood: "UNLIKELY", * ruleSets: [ * { * infoTypes: [{ * name: "EMAIL_ADDRESS", * }], * rules: [{ * exclusionRule: { * regex: { * pattern: ".+@example.com", * }, * matchingType: "MATCHING_TYPE_FULL_MATCH", * }, * }], * }, * { * infoTypes: [{ * name: "MY_CUSTOM_TYPE", * }], * rules: [{ * hotwordRule: { * hotwordRegex: { * pattern: "example*", * }, * proximity: { * windowBefore: 50, * }, * likelihoodAdjustment: { * fixedLikelihood: "VERY_LIKELY", * }, * }, * }], * }, * ], * limits: { * maxFindingsPerItem: 10, * maxFindingsPerRequest: 50, * }, * }, * }); * ``` * ### Dlp Inspect Template Custom Type Surrogate * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const customTypeSurrogate = new gcp.dataloss.PreventionInspectTemplate("custom_type_surrogate", { * parent: "projects/my-project-name", * description: "My description", * displayName: "display_name", * inspectConfig: { * customInfoTypes: [{ * infoType: { * name: "MY_CUSTOM_TYPE", * }, * likelihood: "UNLIKELY", * surrogateType: {}, * }], * infoTypes: [{ * name: "EMAIL_ADDRESS", * }], * minLikelihood: "UNLIKELY", * ruleSets: [ * { * infoTypes: [{ * name: "EMAIL_ADDRESS", * }], * rules: [{ * exclusionRule: { * regex: { * pattern: ".+@example.com", * }, * matchingType: "MATCHING_TYPE_FULL_MATCH", * }, * }], * }, * { * infoTypes: [{ * name: "MY_CUSTOM_TYPE", * }], * rules: [{ * hotwordRule: { * hotwordRegex: { * pattern: "example*", * }, * proximity: { * windowBefore: 50, * }, * likelihoodAdjustment: { * fixedLikelihood: "VERY_LIKELY", * }, * }, * }], * }, * ], * limits: { * maxFindingsPerItem: 10, * maxFindingsPerRequest: 50, * }, * }, * }); * ``` * ### Dlp Inspect Template Max Infotype Per Finding Default * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const maxInfotypePerFindingDefault = new gcp.dataloss.PreventionInspectTemplate("max_infotype_per_finding_default", { * parent: "projects/my-project-name", * inspectConfig: { * infoTypes: [ * { * name: "EMAIL_ADDRESS", * }, * { * name: "PERSON_NAME", * }, * ], * minLikelihood: "UNLIKELY", * limits: { * maxFindingsPerRequest: 333, * maxFindingsPerItem: 222, * maxFindingsPerInfoTypes: [{ * maxFindings: 111, * }], * }, * }, * }); * ``` * * ## Import * * InspectTemplate can be imported using any of these accepted formats: * * * `{{parent}}/inspectTemplates/{{name}}` * * * `{{parent}}/{{name}}` * * When using the `pulumi import` command, InspectTemplate can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:dataloss/preventionInspectTemplate:PreventionInspectTemplate default {{parent}}/inspectTemplates/{{name}} * ``` * * ```sh * $ pulumi import gcp:dataloss/preventionInspectTemplate:PreventionInspectTemplate default {{parent}}/{{name}} * ``` */ export declare class PreventionInspectTemplate extends pulumi.CustomResource { /** * Get an existing PreventionInspectTemplate 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?: PreventionInspectTemplateState, opts?: pulumi.CustomResourceOptions): PreventionInspectTemplate; /** * Returns true if the given object is an instance of PreventionInspectTemplate. 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 PreventionInspectTemplate; /** * A description of the inspect template. */ readonly description: pulumi.Output; /** * User set display name of the inspect template. */ readonly displayName: pulumi.Output; /** * The core content of the template. * Structure is documented below. */ readonly inspectConfig: pulumi.Output; /** * The resource name of the inspect template. Set by the server. */ readonly name: pulumi.Output; /** * The parent of the inspect template in any of the following formats: * * `projects/{{project}}` * * `projects/{{project}}/locations/{{location}}` * * `organizations/{{organization_id}}` * * `organizations/{{organization_id}}/locations/{{location}}` * * * - - - */ readonly parent: pulumi.Output; /** * The template id can contain uppercase and lowercase letters, numbers, and hyphens; * that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is * 100 characters. Can be empty to allow the system to generate one. */ readonly templateId: pulumi.Output; /** * Create a PreventionInspectTemplate 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: PreventionInspectTemplateArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PreventionInspectTemplate resources. */ export interface PreventionInspectTemplateState { /** * A description of the inspect template. */ description?: pulumi.Input; /** * User set display name of the inspect template. */ displayName?: pulumi.Input; /** * The core content of the template. * Structure is documented below. */ inspectConfig?: pulumi.Input; /** * The resource name of the inspect template. Set by the server. */ name?: pulumi.Input; /** * The parent of the inspect template in any of the following formats: * * `projects/{{project}}` * * `projects/{{project}}/locations/{{location}}` * * `organizations/{{organization_id}}` * * `organizations/{{organization_id}}/locations/{{location}}` * * * - - - */ parent?: pulumi.Input; /** * The template id can contain uppercase and lowercase letters, numbers, and hyphens; * that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is * 100 characters. Can be empty to allow the system to generate one. */ templateId?: pulumi.Input; } /** * The set of arguments for constructing a PreventionInspectTemplate resource. */ export interface PreventionInspectTemplateArgs { /** * A description of the inspect template. */ description?: pulumi.Input; /** * User set display name of the inspect template. */ displayName?: pulumi.Input; /** * The core content of the template. * Structure is documented below. */ inspectConfig?: pulumi.Input; /** * The parent of the inspect template in any of the following formats: * * `projects/{{project}}` * * `projects/{{project}}/locations/{{location}}` * * `organizations/{{organization_id}}` * * `organizations/{{organization_id}}/locations/{{location}}` * * * - - - */ parent: pulumi.Input; /** * The template id can contain uppercase and lowercase letters, numbers, and hyphens; * that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is * 100 characters. Can be empty to allow the system to generate one. */ templateId?: pulumi.Input; }