@bdzscaler/pulumi-zia
Version:
A Pulumi package for creating and managing zia cloud resources.
196 lines (195 loc) • 8.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* * [Official documentation](https://help.zscaler.com/zia/configuring-data-rest-scanning-malware-detection-policy)
* * [API documentation](https://help.zscaler.com/zia/saas-security-api#/casbMalwareRules-post)
*
* The **zia_casb_malware_rules** resource Adds a new SaaS Security Data at Rest Scanning Malware Detection rule.
*
* ## 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_casb_malware_rules** can be imported by using `<RULE_TYPE:RULE_ID>` or `<RULE_TYPE:RULE_NAME>` as the import ID.
*
* For example:
*
* ```sh
* $ pulumi import zia:index/casbMalwareRule:CasbMalwareRule this <rule_type:rule_id>
* ```
*
* ```sh
* $ pulumi import zia:index/casbMalwareRule:CasbMalwareRule this <"rule_type:rule_name">
* ```
*/
export declare class CasbMalwareRule extends pulumi.CustomResource {
/**
* Get an existing CasbMalwareRule 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?: CasbMalwareRuleState, opts?: pulumi.CustomResourceOptions): CasbMalwareRule;
/**
* Returns true if the given object is an instance of CasbMalwareRule. 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 CasbMalwareRule;
readonly action: pulumi.Output<string | undefined>;
/**
* Name-ID pairs of locations for which rule must be applied
*/
readonly buckets: pulumi.Output<outputs.CasbMalwareRuleBuckets | undefined>;
/**
* The ZPA Server Group for which this rule is applicable. Only the Server Groups that are associated with the selected
* Application Segments are allowed. This field is applicable only for the ZPA forwarding method.
*/
readonly casbEmailLabels: pulumi.Output<outputs.CasbMalwareRuleCasbEmailLabel[] | undefined>;
/**
* The ZPA Server Group for which this rule is applicable. Only the Server Groups that are associated with the selected
* Application Segments are allowed. This field is applicable only for the ZPA forwarding method.
*/
readonly casbTombstoneTemplates: pulumi.Output<outputs.CasbMalwareRuleCasbTombstoneTemplate[] | undefined>;
/**
* This field is applicable for devices that are managed using Zscaler Client Connector.
*/
readonly cloudAppTenantIds: pulumi.Output<outputs.CasbMalwareRuleCloudAppTenantIds | undefined>;
/**
* Name-ID pairs of the cloud application tenants for which the rule is applied. If the name-ID pairs of the cloud
* application tenants are not specified, the rule is applied to all tenants.
*/
readonly cloudAppTenants: pulumi.Output<outputs.CasbMalwareRuleCloudAppTenants | undefined>;
/**
* list of Labels that are applicable to the rule.
*/
readonly labels: pulumi.Output<outputs.CasbMalwareRuleLabels | undefined>;
readonly name: pulumi.Output<string>;
readonly order: pulumi.Output<number | undefined>;
/**
* Location where all the quarantined files are moved and necessary actions are taken by either deleting or restoring the
* data
*/
readonly quarantineLocation: pulumi.Output<string | undefined>;
/**
* A unique identifier assigned to the forwarding rule
*/
readonly ruleId: pulumi.Output<number>;
/**
* Enables or disables the scan inbound email link
*/
readonly scanInboundEmailLink: pulumi.Output<string | undefined>;
readonly state: pulumi.Output<string | undefined>;
readonly type: pulumi.Output<string | undefined>;
/**
* Create a CasbMalwareRule 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?: CasbMalwareRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CasbMalwareRule resources.
*/
export interface CasbMalwareRuleState {
action?: pulumi.Input<string>;
/**
* Name-ID pairs of locations for which rule must be applied
*/
buckets?: pulumi.Input<inputs.CasbMalwareRuleBuckets>;
/**
* The ZPA Server Group for which this rule is applicable. Only the Server Groups that are associated with the selected
* Application Segments are allowed. This field is applicable only for the ZPA forwarding method.
*/
casbEmailLabels?: pulumi.Input<pulumi.Input<inputs.CasbMalwareRuleCasbEmailLabel>[]>;
/**
* The ZPA Server Group for which this rule is applicable. Only the Server Groups that are associated with the selected
* Application Segments are allowed. This field is applicable only for the ZPA forwarding method.
*/
casbTombstoneTemplates?: pulumi.Input<pulumi.Input<inputs.CasbMalwareRuleCasbTombstoneTemplate>[]>;
/**
* This field is applicable for devices that are managed using Zscaler Client Connector.
*/
cloudAppTenantIds?: pulumi.Input<inputs.CasbMalwareRuleCloudAppTenantIds>;
/**
* Name-ID pairs of the cloud application tenants for which the rule is applied. If the name-ID pairs of the cloud
* application tenants are not specified, the rule is applied to all tenants.
*/
cloudAppTenants?: pulumi.Input<inputs.CasbMalwareRuleCloudAppTenants>;
/**
* list of Labels that are applicable to the rule.
*/
labels?: pulumi.Input<inputs.CasbMalwareRuleLabels>;
name?: pulumi.Input<string>;
order?: pulumi.Input<number>;
/**
* Location where all the quarantined files are moved and necessary actions are taken by either deleting or restoring the
* data
*/
quarantineLocation?: pulumi.Input<string>;
/**
* A unique identifier assigned to the forwarding rule
*/
ruleId?: pulumi.Input<number>;
/**
* Enables or disables the scan inbound email link
*/
scanInboundEmailLink?: pulumi.Input<string>;
state?: pulumi.Input<string>;
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CasbMalwareRule resource.
*/
export interface CasbMalwareRuleArgs {
action?: pulumi.Input<string>;
/**
* Name-ID pairs of locations for which rule must be applied
*/
buckets?: pulumi.Input<inputs.CasbMalwareRuleBuckets>;
/**
* The ZPA Server Group for which this rule is applicable. Only the Server Groups that are associated with the selected
* Application Segments are allowed. This field is applicable only for the ZPA forwarding method.
*/
casbEmailLabels?: pulumi.Input<pulumi.Input<inputs.CasbMalwareRuleCasbEmailLabel>[]>;
/**
* The ZPA Server Group for which this rule is applicable. Only the Server Groups that are associated with the selected
* Application Segments are allowed. This field is applicable only for the ZPA forwarding method.
*/
casbTombstoneTemplates?: pulumi.Input<pulumi.Input<inputs.CasbMalwareRuleCasbTombstoneTemplate>[]>;
/**
* This field is applicable for devices that are managed using Zscaler Client Connector.
*/
cloudAppTenantIds?: pulumi.Input<inputs.CasbMalwareRuleCloudAppTenantIds>;
/**
* Name-ID pairs of the cloud application tenants for which the rule is applied. If the name-ID pairs of the cloud
* application tenants are not specified, the rule is applied to all tenants.
*/
cloudAppTenants?: pulumi.Input<inputs.CasbMalwareRuleCloudAppTenants>;
/**
* list of Labels that are applicable to the rule.
*/
labels?: pulumi.Input<inputs.CasbMalwareRuleLabels>;
name?: pulumi.Input<string>;
order?: pulumi.Input<number>;
/**
* Location where all the quarantined files are moved and necessary actions are taken by either deleting or restoring the
* data
*/
quarantineLocation?: pulumi.Input<string>;
/**
* Enables or disables the scan inbound email link
*/
scanInboundEmailLink?: pulumi.Input<string>;
state?: pulumi.Input<string>;
type?: pulumi.Input<string>;
}