UNPKG

@bdzscaler/pulumi-zia

Version:

A Pulumi package for creating and managing zia cloud resources.

117 lines (116 loc) 4.48 kB
import * as pulumi from "@pulumi/pulumi"; /** * * [Official documentation](https://help.zscaler.com/zia/about-dlp-engines) * * [API documentation](https://help.zscaler.com/zia/data-loss-prevention#/dlpEngines-get) * * Use the **zia_dlp_engines** resource allows the creation and management of ZIA DLP Engines in the Zscaler Internet Access cloud or via the API. * * ⚠️ **WARNING:** "Before using the new ``zia.DLPEngines`` resource contact [Zscaler Support](https://help.zscaler.com/login-tickets)." and request the following API methods ``POST``, ``PUT``, and ``DELETE`` to be enabled for your organization. * * ## Example Usage * * ## Import * * Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language. * * Visit * * **zia_dlp_engines** can be imported by using `<ENGINE_ID>` or `<ENGINE_NAME>` as the import ID. * * For example: * * ```sh * $ pulumi import zia:index/dLPEngines:DLPEngines example <engine_id> * ``` * * or * * ```sh * $ pulumi import zia:index/dLPEngines:DLPEngines example <engine_name> * ``` */ export declare class DLPEngines extends pulumi.CustomResource { /** * Get an existing DLPEngines 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<pulumi.ID>, state?: DLPEnginesState, opts?: pulumi.CustomResourceOptions): DLPEngines; /** * Returns true if the given object is an instance of DLPEngines. 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 DLPEngines; /** * Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom. */ readonly customDlpEngine: pulumi.Output<boolean | undefined>; /** * The DLP engine's description. */ readonly description: pulumi.Output<string | undefined>; /** * The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression. */ readonly engineExpression: pulumi.Output<string | undefined>; readonly engineId: pulumi.Output<number>; /** * The DLP engine name as configured by the admin. */ readonly name: pulumi.Output<string>; /** * Create a DLPEngines 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?: DLPEnginesArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering DLPEngines resources. */ export interface DLPEnginesState { /** * Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom. */ customDlpEngine?: pulumi.Input<boolean>; /** * The DLP engine's description. */ description?: pulumi.Input<string>; /** * The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression. */ engineExpression?: pulumi.Input<string>; engineId?: pulumi.Input<number>; /** * The DLP engine name as configured by the admin. */ name?: pulumi.Input<string>; } /** * The set of arguments for constructing a DLPEngines resource. */ export interface DLPEnginesArgs { /** * Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom. */ customDlpEngine?: pulumi.Input<boolean>; /** * The DLP engine's description. */ description?: pulumi.Input<string>; /** * The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression. */ engineExpression?: pulumi.Input<string>; /** * The DLP engine name as configured by the admin. */ name?: pulumi.Input<string>; }