@bdzscaler/pulumi-zia

import * as pulumi from "@pulumi/pulumi"; /** * * [Official documentation](https://help.zscaler.com/zia/understanding-browser-based-end-user-notifications) * * [API documentation](https://help.zscaler.com/zia/end-user-notifications#/eun-get) * * The **zia_end_user_notification** resource allows you to update the browser-based end user notification (EUN) configuration details. To learn more see [Understanding Browser-Based End User Notifications](https://help.zscaler.com/unified/understanding-browser-based-end-user-notifications) * * ## Example Usage * * ### NOTIFICATION TYPE - DEFAULT * * ### NOTIFICATION TYPE - CUSTOM * * ## 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_end_user_notification** can be imported by using `enduser_notification` as the import ID. * * For example: * * ```sh * $ pulumi import zia:index/endUserNotification:EndUserNotification this "enduser_notification" * ``` */ export declare class EndUserNotification extends pulumi.CustomResource { /** * Get an existing EndUserNotification 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?: EndUserNotificationState, opts?: pulumi.CustomResourceOptions): EndUserNotification; /** * Returns true if the given object is an instance of EndUserNotification. 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 EndUserNotification; /** * The custom frequency (in days) for showing the AUP to the end users. Valid range is 0 to 180. */ readonly aupCustomFrequency: pulumi.Output<number>; /** * Specifies which day of the week or month the AUP is shown for users when aupFrequency is set. Valid range is 0 to 31. */ readonly aupDayOffset: pulumi.Output<number>; /** * The frequency at which the Acceptable Use Policy (AUP) is shown to the end users */ readonly aupFrequency: pulumi.Output<string>; /** * The acceptable use statement that is shown in the AUP */ readonly aupMessage: pulumi.Output<string>; /** * The time interval at which the caution notification is shown when users continue browsing a restricted site. */ readonly cautionAgainAfter: pulumi.Output<number>; /** * The custom message that appears in the caution notification */ readonly cautionCustomText: pulumi.Output<string>; /** * Specifies whether to display the caution notification at a specific time interval for URLs in the Miscellaneous or * Unknown category. */ readonly cautionPerDomain: pulumi.Output<boolean>; /** * The custom text shown in the EUN */ readonly customText: pulumi.Output<string>; /** * A Boolean value indicating whether your organization's logo appears in the EUN or not */ readonly displayCompLogo: pulumi.Output<boolean>; /** * A Boolean value indicating whether the organization's name appears in the EUN or not */ readonly displayCompName: pulumi.Output<boolean>; /** * A Boolean value indicating whether or not the reason for cautioning or blocking access to a site, file, or application * is shown when the respective notification is triggered */ readonly displayReason: pulumi.Output<boolean>; /** * The message that appears in the IdP Proxy notification */ readonly idpProxyNotificationText: pulumi.Output<string>; /** * The type of EUN as default or custom */ readonly notificationType: pulumi.Output<string>; /** * The URL of the organization's policy page. This field is required for the default notification type. */ readonly orgPolicyLink: pulumi.Output<string>; /** * The message that appears in the quarantine notification */ readonly quarantineCustomNotificationText: pulumi.Output<string | undefined>; /** * The redirect URL for the external site hosting the EUN specified when the custom notification type is selected */ readonly redirectUrl: pulumi.Output<string>; /** * Value indicating whether or not to include the ECS option in all DNS queries, originating from all locations and remote * users. */ readonly securityReviewCustomLocation: pulumi.Output<string>; /** * A Boolean value indicating whether the Security Violation notification is enabled or disabled */ readonly securityReviewEnabled: pulumi.Output<boolean>; /** * A Boolean value indicating whether users' review requests for blocked URLs are submitted to the Zscaler service (i.e., * Security Cloud) or a custom location. */ readonly securityReviewSubmitToSecurityCloud: pulumi.Output<boolean>; /** * The message that appears in the Security Violation notification */ readonly securityReviewText: pulumi.Output<string>; /** * The email address for writing to IT Support */ readonly supportEmail: pulumi.Output<string>; /** * The phone number for contacting IT Support */ readonly supportPhone: pulumi.Output<string>; /** * A custom URL location where users' review requests for blocked URLs are sent */ readonly urlCatReviewCustomLocation: pulumi.Output<string>; /** * A Boolean value indicating whether the URL Categorization notification is enabled or disabled */ readonly urlCatReviewEnabled: pulumi.Output<boolean>; /** * A Boolean value indicating whether users' review requests for possibly misclassified URLs are submitted to the Zscaler * service (i.e., Security Cloud) or a custom location. */ readonly urlCatReviewSubmitToSecurityCloud: pulumi.Output<boolean>; /** * The message that appears in the URL Categorization notification */ readonly urlCatReviewText: pulumi.Output<string>; /** * A custom URL location where users' review requests for the web DLP policy violation are sent */ readonly webDlpReviewCustomLocation: pulumi.Output<string>; /** * A Boolean value indicating whether the Web DLP Violation notification is enabled or disabled */ readonly webDlpReviewEnabled: pulumi.Output<boolean>; /** * A Boolean value indicating whether users' review requests for web DLP policy violation are submitted to the Zscaler * service (i.e., Security Cloud) or a custom location. */ readonly webDlpReviewSubmitToSecurityCloud: pulumi.Output<boolean>; /** * The message that appears in the Web DLP Violation notification */ readonly webDlpReviewText: pulumi.Output<string>; /** * Create a EndUserNotification 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?: EndUserNotificationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering EndUserNotification resources. */ export interface EndUserNotificationState { /** * The custom frequency (in days) for showing the AUP to the end users. Valid range is 0 to 180. */ aupCustomFrequency?: pulumi.Input<number>; /** * Specifies which day of the week or month the AUP is shown for users when aupFrequency is set. Valid range is 0 to 31. */ aupDayOffset?: pulumi.Input<number>; /** * The frequency at which the Acceptable Use Policy (AUP) is shown to the end users */ aupFrequency?: pulumi.Input<string>; /** * The acceptable use statement that is shown in the AUP */ aupMessage?: pulumi.Input<string>; /** * The time interval at which the caution notification is shown when users continue browsing a restricted site. */ cautionAgainAfter?: pulumi.Input<number>; /** * The custom message that appears in the caution notification */ cautionCustomText?: pulumi.Input<string>; /** * Specifies whether to display the caution notification at a specific time interval for URLs in the Miscellaneous or * Unknown category. */ cautionPerDomain?: pulumi.Input<boolean>; /** * The custom text shown in the EUN */ customText?: pulumi.Input<string>; /** * A Boolean value indicating whether your organization's logo appears in the EUN or not */ displayCompLogo?: pulumi.Input<boolean>; /** * A Boolean value indicating whether the organization's name appears in the EUN or not */ displayCompName?: pulumi.Input<boolean>; /** * A Boolean value indicating whether or not the reason for cautioning or blocking access to a site, file, or application * is shown when the respective notification is triggered */ displayReason?: pulumi.Input<boolean>; /** * The message that appears in the IdP Proxy notification */ idpProxyNotificationText?: pulumi.Input<string>; /** * The type of EUN as default or custom */ notificationType?: pulumi.Input<string>; /** * The URL of the organization's policy page. This field is required for the default notification type. */ orgPolicyLink?: pulumi.Input<string>; /** * The message that appears in the quarantine notification */ quarantineCustomNotificationText?: pulumi.Input<string>; /** * The redirect URL for the external site hosting the EUN specified when the custom notification type is selected */ redirectUrl?: pulumi.Input<string>; /** * Value indicating whether or not to include the ECS option in all DNS queries, originating from all locations and remote * users. */ securityReviewCustomLocation?: pulumi.Input<string>; /** * A Boolean value indicating whether the Security Violation notification is enabled or disabled */ securityReviewEnabled?: pulumi.Input<boolean>; /** * A Boolean value indicating whether users' review requests for blocked URLs are submitted to the Zscaler service (i.e., * Security Cloud) or a custom location. */ securityReviewSubmitToSecurityCloud?: pulumi.Input<boolean>; /** * The message that appears in the Security Violation notification */ securityReviewText?: pulumi.Input<string>; /** * The email address for writing to IT Support */ supportEmail?: pulumi.Input<string>; /** * The phone number for contacting IT Support */ supportPhone?: pulumi.Input<string>; /** * A custom URL location where users' review requests for blocked URLs are sent */ urlCatReviewCustomLocation?: pulumi.Input<string>; /** * A Boolean value indicating whether the URL Categorization notification is enabled or disabled */ urlCatReviewEnabled?: pulumi.Input<boolean>; /** * A Boolean value indicating whether users' review requests for possibly misclassified URLs are submitted to the Zscaler * service (i.e., Security Cloud) or a custom location. */ urlCatReviewSubmitToSecurityCloud?: pulumi.Input<boolean>; /** * The message that appears in the URL Categorization notification */ urlCatReviewText?: pulumi.Input<string>; /** * A custom URL location where users' review requests for the web DLP policy violation are sent */ webDlpReviewCustomLocation?: pulumi.Input<string>; /** * A Boolean value indicating whether the Web DLP Violation notification is enabled or disabled */ webDlpReviewEnabled?: pulumi.Input<boolean>; /** * A Boolean value indicating whether users' review requests for web DLP policy violation are submitted to the Zscaler * service (i.e., Security Cloud) or a custom location. */ webDlpReviewSubmitToSecurityCloud?: pulumi.Input<boolean>; /** * The message that appears in the Web DLP Violation notification */ webDlpReviewText?: pulumi.Input<string>; } /** * The set of arguments for constructing a EndUserNotification resource. */ export interface EndUserNotificationArgs { /** * The custom frequency (in days) for showing the AUP to the end users. Valid range is 0 to 180. */ aupCustomFrequency?: pulumi.Input<number>; /** * Specifies which day of the week or month the AUP is shown for users when aupFrequency is set. Valid range is 0 to 31. */ aupDayOffset?: pulumi.Input<number>; /** * The frequency at which the Acceptable Use Policy (AUP) is shown to the end users */ aupFrequency?: pulumi.Input<string>; /** * The acceptable use statement that is shown in the AUP */ aupMessage?: pulumi.Input<string>; /** * The time interval at which the caution notification is shown when users continue browsing a restricted site. */ cautionAgainAfter?: pulumi.Input<number>; /** * The custom message that appears in the caution notification */ cautionCustomText?: pulumi.Input<string>; /** * Specifies whether to display the caution notification at a specific time interval for URLs in the Miscellaneous or * Unknown category. */ cautionPerDomain?: pulumi.Input<boolean>; /** * The custom text shown in the EUN */ customText?: pulumi.Input<string>; /** * A Boolean value indicating whether your organization's logo appears in the EUN or not */ displayCompLogo?: pulumi.Input<boolean>; /** * A Boolean value indicating whether the organization's name appears in the EUN or not */ displayCompName?: pulumi.Input<boolean>; /** * A Boolean value indicating whether or not the reason for cautioning or blocking access to a site, file, or application * is shown when the respective notification is triggered */ displayReason?: pulumi.Input<boolean>; /** * The message that appears in the IdP Proxy notification */ idpProxyNotificationText?: pulumi.Input<string>; /** * The type of EUN as default or custom */ notificationType?: pulumi.Input<string>; /** * The URL of the organization's policy page. This field is required for the default notification type. */ orgPolicyLink?: pulumi.Input<string>; /** * The message that appears in the quarantine notification */ quarantineCustomNotificationText?: pulumi.Input<string>; /** * The redirect URL for the external site hosting the EUN specified when the custom notification type is selected */ redirectUrl?: pulumi.Input<string>; /** * Value indicating whether or not to include the ECS option in all DNS queries, originating from all locations and remote * users. */ securityReviewCustomLocation?: pulumi.Input<string>; /** * A Boolean value indicating whether the Security Violation notification is enabled or disabled */ securityReviewEnabled?: pulumi.Input<boolean>; /** * A Boolean value indicating whether users' review requests for blocked URLs are submitted to the Zscaler service (i.e., * Security Cloud) or a custom location. */ securityReviewSubmitToSecurityCloud?: pulumi.Input<boolean>; /** * The message that appears in the Security Violation notification */ securityReviewText?: pulumi.Input<string>; /** * The email address for writing to IT Support */ supportEmail?: pulumi.Input<string>; /** * The phone number for contacting IT Support */ supportPhone?: pulumi.Input<string>; /** * A custom URL location where users' review requests for blocked URLs are sent */ urlCatReviewCustomLocation?: pulumi.Input<string>; /** * A Boolean value indicating whether the URL Categorization notification is enabled or disabled */ urlCatReviewEnabled?: pulumi.Input<boolean>; /** * A Boolean value indicating whether users' review requests for possibly misclassified URLs are submitted to the Zscaler * service (i.e., Security Cloud) or a custom location. */ urlCatReviewSubmitToSecurityCloud?: pulumi.Input<boolean>; /** * The message that appears in the URL Categorization notification */ urlCatReviewText?: pulumi.Input<string>; /** * A custom URL location where users' review requests for the web DLP policy violation are sent */ webDlpReviewCustomLocation?: pulumi.Input<string>; /** * A Boolean value indicating whether the Web DLP Violation notification is enabled or disabled */ webDlpReviewEnabled?: pulumi.Input<boolean>; /** * A Boolean value indicating whether users' review requests for web DLP policy violation are submitted to the Zscaler * service (i.e., Security Cloud) or a custom location. */ webDlpReviewSubmitToSecurityCloud?: pulumi.Input<boolean>; /** * The message that appears in the Web DLP Violation notification */ webDlpReviewText?: pulumi.Input<string>; }