@pulumi/cloudngfwaws/customUrlCategory.d.ts

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

import * as pulumi from "@pulumi/pulumi";
/**
 * Resource for custom url category manipulation.
 *
 * ## 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: "terraform-rulestack",
 *     scope: "Local",
 *     accountId: "123456789",
 *     description: "Made by Pulumi",
 *     profileConfig: {
 *         antiSpyware: "BestPractice",
 *     },
 * });
 * const example = new cloudngfwaws.CustomUrlCategory("example", {
 *     rulestack: r.name,
 *     name: "tf-custom-category",
 *     description: "Also configured by Terraform",
 *     urlLists: [
 *         "example.com",
 *         "paloaltonetworks.com",
 *         "foobar.org",
 *     ],
 *     action: "alert",
 * });
 * ```
 *
 * ## Import
 *
 * import name is <scope>:<rulestack>:<category_name>
 *
 * ```sh
 * $ pulumi import cloudngfwaws:index/customUrlCategory:CustomUrlCategory example Local:terraform-rulestack:tf-custom-category
 * ```
 */
export declare class CustomUrlCategory extends pulumi.CustomResource {
    /**
     * Get an existing CustomUrlCategory 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?: CustomUrlCategoryState, opts?: pulumi.CustomResourceOptions): CustomUrlCategory;
    /**
     * Returns true if the given object is an instance of CustomUrlCategory.  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 CustomUrlCategory;
    /**
     * The action to take. Valid values are `none`, `alert`, `allow`, `block`, `continue`, or `override`. Defaults to `none`.
     */
    readonly action: pulumi.Output<string | undefined>;
    /**
     * The audit comment.
     */
    readonly auditComment: pulumi.Output<string | undefined>;
    /**
     * The description.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The rulestack.
     */
    readonly rulestack: pulumi.Output<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: pulumi.Output<string | undefined>;
    /**
     * The update token.
     */
    readonly updateToken: pulumi.Output<string>;
    /**
     * The URL list for this custom URL category.
     */
    readonly urlLists: pulumi.Output<string[]>;
    /**
     * Create a CustomUrlCategory 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: CustomUrlCategoryArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering CustomUrlCategory resources.
 */
export interface CustomUrlCategoryState {
    /**
     * The action to take. Valid values are `none`, `alert`, `allow`, `block`, `continue`, or `override`. Defaults to `none`.
     */
    action?: pulumi.Input<string>;
    /**
     * The audit comment.
     */
    auditComment?: pulumi.Input<string>;
    /**
     * The description.
     */
    description?: 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>;
    /**
     * The update token.
     */
    updateToken?: pulumi.Input<string>;
    /**
     * The URL list for this custom URL category.
     */
    urlLists?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a CustomUrlCategory resource.
 */
export interface CustomUrlCategoryArgs {
    /**
     * The action to take. Valid values are `none`, `alert`, `allow`, `block`, `continue`, or `override`. Defaults to `none`.
     */
    action?: pulumi.Input<string>;
    /**
     * The audit comment.
     */
    auditComment?: pulumi.Input<string>;
    /**
     * The description.
     */
    description?: 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>;
    /**
     * The URL list for this custom URL category.
     */
    urlLists: pulumi.Input<pulumi.Input<string>[]>;
}