1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. DLPEngines
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

zia.DLPEngines

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

    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.” and request the following API methods POST, PUT, and DELETE to be enabled for your organization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zia from "@bdzscaler/pulumi-zia";
    
    // Retrieve a DLP Engine by name
    const _this = new zia.DLPEngines("this", {
        customDlpEngine: true,
        description: "Example",
        engineExpression: "((D63.S > 1))",
    });
    
    import pulumi
    import zscaler_pulumi_zia as zia
    
    # Retrieve a DLP Engine by name
    this = zia.DLPEngines("this",
        custom_dlp_engine=True,
        description="Example",
        engine_expression="((D63.S > 1))")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/zscaler/pulumi-zia/sdk/go/zia"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Retrieve a DLP Engine by name
    		_, err := zia.NewDLPEngines(ctx, "this", &zia.DLPEnginesArgs{
    			CustomDlpEngine:  pulumi.Bool(true),
    			Description:      pulumi.String("Example"),
    			EngineExpression: pulumi.String("((D63.S > 1))"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zia = zscaler.PulumiPackage.Zia;
    
    return await Deployment.RunAsync(() => 
    {
        // Retrieve a DLP Engine by name
        var @this = new Zia.DLPEngines("this", new()
        {
            CustomDlpEngine = true,
            Description = "Example",
            EngineExpression = "((D63.S > 1))",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zia.DLPEngines;
    import com.pulumi.zia.DLPEnginesArgs;
    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) {
            // Retrieve a DLP Engine by name
            var this_ = new DLPEngines("this", DLPEnginesArgs.builder()        
                .customDlpEngine(true)
                .description("Example")
                .engineExpression("((D63.S > 1))")
                .build());
    
        }
    }
    
    resources:
      # Retrieve a DLP Engine by name
      this:
        type: zia:DLPEngines
        properties:
          customDlpEngine: true
          description: Example
          engineExpression: ((D63.S > 1))
    

    Create DLPEngines Resource

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

    Constructor syntax

    new DLPEngines(name: string, args?: DLPEnginesArgs, opts?: CustomResourceOptions);
    @overload
    def DLPEngines(resource_name: str,
                   args: Optional[DLPEnginesArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DLPEngines(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   custom_dlp_engine: Optional[bool] = None,
                   description: Optional[str] = None,
                   engine_expression: Optional[str] = None,
                   name: Optional[str] = None)
    func NewDLPEngines(ctx *Context, name string, args *DLPEnginesArgs, opts ...ResourceOption) (*DLPEngines, error)
    public DLPEngines(string name, DLPEnginesArgs? args = null, CustomResourceOptions? opts = null)
    public DLPEngines(String name, DLPEnginesArgs args)
    public DLPEngines(String name, DLPEnginesArgs args, CustomResourceOptions options)
    
    type: zia:DLPEngines
    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 DLPEnginesArgs
    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 DLPEnginesArgs
    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 DLPEnginesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DLPEnginesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DLPEnginesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var dlpenginesResource = new Zia.DLPEngines("dlpenginesResource", new()
    {
        CustomDlpEngine = false,
        Description = "string",
        EngineExpression = "string",
        Name = "string",
    });
    
    example, err := zia.NewDLPEngines(ctx, "dlpenginesResource", &zia.DLPEnginesArgs{
    	CustomDlpEngine:  pulumi.Bool(false),
    	Description:      pulumi.String("string"),
    	EngineExpression: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var dlpenginesResource = new DLPEngines("dlpenginesResource", DLPEnginesArgs.builder()        
        .customDlpEngine(false)
        .description("string")
        .engineExpression("string")
        .name("string")
        .build());
    
    dlpengines_resource = zia.DLPEngines("dlpenginesResource",
        custom_dlp_engine=False,
        description="string",
        engine_expression="string",
        name="string")
    
    const dlpenginesResource = new zia.DLPEngines("dlpenginesResource", {
        customDlpEngine: false,
        description: "string",
        engineExpression: "string",
        name: "string",
    });
    
    type: zia:DLPEngines
    properties:
        customDlpEngine: false
        description: string
        engineExpression: string
        name: string
    

    DLPEngines Resource Properties

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

    Inputs

    The DLPEngines resource accepts the following input properties:

    CustomDlpEngine bool
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    Description string
    The DLP engine's description.
    EngineExpression string
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    Name string
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    CustomDlpEngine bool
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    Description string
    The DLP engine's description.
    EngineExpression string
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    Name string
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    customDlpEngine Boolean
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description String
    The DLP engine's description.
    engineExpression String
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    name String
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    customDlpEngine boolean
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description string
    The DLP engine's description.
    engineExpression string
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    name string
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    custom_dlp_engine bool
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description str
    The DLP engine's description.
    engine_expression str
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    name str
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    customDlpEngine Boolean
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description String
    The DLP engine's description.
    engineExpression String
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    name String
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.

    Outputs

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

    EngineId int
    Id string
    The provider-assigned unique ID for this managed resource.
    EngineId int
    Id string
    The provider-assigned unique ID for this managed resource.
    engineId Integer
    id String
    The provider-assigned unique ID for this managed resource.
    engineId number
    id string
    The provider-assigned unique ID for this managed resource.
    engine_id int
    id str
    The provider-assigned unique ID for this managed resource.
    engineId Number
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DLPEngines Resource

    Get an existing DLPEngines 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?: DLPEnginesState, opts?: CustomResourceOptions): DLPEngines
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            custom_dlp_engine: Optional[bool] = None,
            description: Optional[str] = None,
            engine_expression: Optional[str] = None,
            engine_id: Optional[int] = None,
            name: Optional[str] = None) -> DLPEngines
    func GetDLPEngines(ctx *Context, name string, id IDInput, state *DLPEnginesState, opts ...ResourceOption) (*DLPEngines, error)
    public static DLPEngines Get(string name, Input<string> id, DLPEnginesState? state, CustomResourceOptions? opts = null)
    public static DLPEngines get(String name, Output<String> id, DLPEnginesState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CustomDlpEngine bool
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    Description string
    The DLP engine's description.
    EngineExpression string
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    EngineId int
    Name string
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    CustomDlpEngine bool
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    Description string
    The DLP engine's description.
    EngineExpression string
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    EngineId int
    Name string
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    customDlpEngine Boolean
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description String
    The DLP engine's description.
    engineExpression String
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    engineId Integer
    name String
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    customDlpEngine boolean
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description string
    The DLP engine's description.
    engineExpression string
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    engineId number
    name string
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    custom_dlp_engine bool
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description str
    The DLP engine's description.
    engine_expression str
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    engine_id int
    name str
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.
    customDlpEngine Boolean
    Indicates whether this is a custom DLP engine. If this value is set to true, the engine is custom.
    description String
    The DLP engine's description.
    engineExpression String
    The boolean logical operator in which various DLP dictionaries are combined within a DLP engine's expression.
    engineId Number
    name String
    The DLP engine name as configured by the admin. This attribute is required in POST and PUT requests for custom DLP engines.

    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:

    $ pulumi import zia:index/dLPEngines:DLPEngines example <engine_id>
    

    or

    $ pulumi import zia:index/dLPEngines:DLPEngines example <engine_name>
    

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler