@pulumi/cloudngfwaws/getCustomUrlCategory.d.ts

A Pulumi package for creating and managing Cloud NGFW for AWS resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Data source for retrieving custom url category information.
 *
 * ## Admin Permission Type
 *
 * * `Rulestack` (for `scope="Local"`)
 * * `Global Rulestack` (for `scope="Global"`)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cloudngfwaws from "@pulumi/cloudngfwaws";
 *
 * const r = new cloudngfwaws.Rulestack("r", {
 *     name: "my-rulestack",
 *     scope: "Local",
 *     accountId: "12345",
 *     description: "Made by Pulumi",
 *     profileConfig: {
 *         antiSpyware: "BestPractice",
 *     },
 * });
 * const example = cloudngfwaws.getCustomUrlCategoryOutput({
 *     rulestack: r.name,
 *     name: "foobar",
 * });
 * ```
 */
export declare function getCustomUrlCategory(args: GetCustomUrlCategoryArgs, opts?: pulumi.InvokeOptions): Promise<GetCustomUrlCategoryResult>;
/**
 * A collection of arguments for invoking getCustomUrlCategory.
 */
export interface GetCustomUrlCategoryArgs {
    /**
     * Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
     */
    configType?: string;
    /**
     * The name.
     */
    name: string;
    /**
     * The rulestack.
     */
    rulestack: string;
    /**
     * The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are `Local` or `Global`. Defaults to `Local`.
     */
    scope?: string;
}
/**
 * A collection of values returned by getCustomUrlCategory.
 */
export interface GetCustomUrlCategoryResult {
    /**
     * The action to take. Valid values are `none`, `alert`, `allow`, `block`, `continue`, or `override`.
     */
    readonly action: string;
    /**
     * The audit comment.
     */
    readonly auditComment: string;
    /**
     * Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
     */
    readonly configType?: string;
    /**
     * The description.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The name.
     */
    readonly name: string;
    /**
     * The rulestack.
     */
    readonly rulestack: string;
    /**
     * The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are `Local` or `Global`. Defaults to `Local`.
     */
    readonly scope?: string;
    /**
     * The update token.
     */
    readonly updateToken: string;
    /**
     * The URL list for this custom URL category.
     */
    readonly urlLists: string[];
}
/**
 * Data source for retrieving custom url category information.
 *
 * ## Admin Permission Type
 *
 * * `Rulestack` (for `scope="Local"`)
 * * `Global Rulestack` (for `scope="Global"`)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cloudngfwaws from "@pulumi/cloudngfwaws";
 *
 * const r = new cloudngfwaws.Rulestack("r", {
 *     name: "my-rulestack",
 *     scope: "Local",
 *     accountId: "12345",
 *     description: "Made by Pulumi",
 *     profileConfig: {
 *         antiSpyware: "BestPractice",
 *     },
 * });
 * const example = cloudngfwaws.getCustomUrlCategoryOutput({
 *     rulestack: r.name,
 *     name: "foobar",
 * });
 * ```
 */
export declare function getCustomUrlCategoryOutput(args: GetCustomUrlCategoryOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCustomUrlCategoryResult>;
/**
 * A collection of arguments for invoking getCustomUrlCategory.
 */
export interface GetCustomUrlCategoryOutputArgs {
    /**
     * Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
     */
    configType?: pulumi.Input<string>;
    /**
     * The name.
     */
    name: pulumi.Input<string>;
    /**
     * The rulestack.
     */
    rulestack: pulumi.Input<string>;
    /**
     * The rulestack's scope. A local rulestack will require that you've retrieved a LRA JWT. A global rulestack will require that you've retrieved a GRA JWT. Valid values are `Local` or `Global`. Defaults to `Local`.
     */
    scope?: pulumi.Input<string>;
}