import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * The zia_url_categories resource manages custom URL categories in the Zscaler Internet Access (ZIA) cloud service. Custom URL categories allow administrators to define their own groupings of URLs, keywords, and IP ranges for use in URL filtering policies. * * For more information, see the [ZIA URL Categories documentation](https://help.zscaler.com/zia/url-categories). * * ## Example Usage * ### Basic Custom URL Category * * ```typescript * import * as zia from "@bdzscaler/pulumi-zia"; * * const example = new zia.UrlCategory("example", { * configuredName: "Example Custom Category", * description: "Custom category for internal tools", * superCategory: "USER_DEFINED", * type: "URL_CATEGORY", * urls: [ * "internal.example.com", * "tools.example.com", * ], * customCategory: true, * }); * ``` * * ## Import * * An existing URL Category can be imported using its resource ID, e.g. * * ```sh * $ pulumi import zia:index:UrlCategory example CUSTOM_01 * ``` */ export declare class UrlCategory extends pulumi.CustomResource { /** * Get an existing UrlCategory 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 opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): UrlCategory; /** * Returns true if the given object is an instance of UrlCategory. 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 UrlCategory; /** * The system-generated ID of the URL category. */ readonly categoryId: pulumi.Output; /** * The name of the URL category. Must be unique. */ readonly configuredName: pulumi.Output; /** * If true, this is a custom URL category. Set to true for custom categories. */ readonly customCategory: pulumi.Output; /** * The number of custom IP ranges in the category. */ readonly customIpRangesCount: pulumi.Output; /** * The number of custom URLs in the category. */ readonly customUrlsCount: pulumi.Output; /** * URLs added to a custom URL category that have been categorized by the Zscaler database. */ readonly dbCategorizedUrls: pulumi.Output; /** * A description of the URL category. Maximum 256 characters. */ readonly description: pulumi.Output; /** * Whether the URL category is editable. */ readonly editable: pulumi.Output; /** * List of custom IP address ranges associated with the URL category. */ readonly ipRanges: pulumi.Output; /** * List of IP ranges that retain their parent category classification. */ readonly ipRangesRetainingParentCategory: pulumi.Output; /** * The number of IP ranges retaining parent category. */ readonly ipRangesRetainingParentCategoryCount: pulumi.Output; /** * List of custom keywords associated with the URL category. */ readonly keywords: pulumi.Output; /** * List of keywords that retain their parent category classification. */ readonly keywordsRetainingParentCategory: pulumi.Output; /** * List of regex-based patterns for URL matching. */ readonly regexPatterns: pulumi.Output; /** * List of regex patterns that retain their parent category classification. */ readonly regexPatternsRetainingParentCategory: pulumi.Output; /** * Scopes for the custom URL category, defining location or department restrictions. */ readonly scopes: pulumi.Output; /** * The super category for the URL category (e.g., `USER_DEFINED`). */ readonly superCategory: pulumi.Output; /** * The type of URL category. Valid values: `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`. */ readonly type: pulumi.Output; /** * URL and keyword count statistics for the category. */ readonly urlKeywordCounts: pulumi.Output; /** * The URL type. Valid values: `EXACT`, `REGEX`. */ readonly urlType: pulumi.Output; /** * List of custom URLs to add to the category. */ readonly urls: pulumi.Output; /** * The number of URLs retaining parent category. */ readonly urlsRetainingParentCategoryCount: pulumi.Output; /** * The internal numeric value of the URL category. */ readonly val: pulumi.Output; /** * Create a UrlCategory 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?: UrlCategoryArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a UrlCategory resource. */ export interface UrlCategoryArgs { /** * The name of the URL category. Must be unique. */ configuredName?: pulumi.Input; /** * If true, this is a custom URL category. Set to true for custom categories. */ customCategory?: pulumi.Input; /** * URLs added to a custom URL category that have been categorized by the Zscaler database. */ dbCategorizedUrls?: pulumi.Input[] | undefined>; /** * A description of the URL category. Maximum 256 characters. */ description?: pulumi.Input; /** * List of custom IP address ranges associated with the URL category. */ ipRanges?: pulumi.Input[] | undefined>; /** * List of IP ranges that retain their parent category classification. */ ipRangesRetainingParentCategory?: pulumi.Input[] | undefined>; /** * List of custom keywords associated with the URL category. */ keywords?: pulumi.Input[] | undefined>; /** * List of keywords that retain their parent category classification. */ keywordsRetainingParentCategory?: pulumi.Input[] | undefined>; /** * List of regex-based patterns for URL matching. */ regexPatterns?: pulumi.Input[] | undefined>; /** * List of regex patterns that retain their parent category classification. */ regexPatternsRetainingParentCategory?: pulumi.Input[] | undefined>; /** * Scopes for the custom URL category, defining location or department restrictions. */ scopes?: pulumi.Input[] | undefined>; /** * The super category for the URL category (e.g., `USER_DEFINED`). */ superCategory?: pulumi.Input; /** * The type of URL category. Valid values: `URL_CATEGORY`, `TLD_CATEGORY`, `ALL`. */ type?: pulumi.Input; /** * URL and keyword count statistics for the category. */ urlKeywordCounts?: pulumi.Input; /** * The URL type. Valid values: `EXACT`, `REGEX`. */ urlType?: pulumi.Input; /** * List of custom URLs to add to the category. */ urls?: pulumi.Input[] | undefined>; } //# sourceMappingURL=urlCategory.d.ts.map