@pulumi/cloudngfwaws/getRulestack.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Data source for retrieving rulestack 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 example = cloudngfwaws.getRulestack({
 *     name: "my-rulestack-name",
 * });
 * ```
 */
export declare function getRulestack(args: GetRulestackArgs, opts?: pulumi.InvokeOptions): Promise<GetRulestackResult>;
/**
 * A collection of arguments for invoking getRulestack.
 */
export interface GetRulestackArgs {
    /**
     * Retrieve either the candidate or running config. Valid values are `candidate` or `running`. Defaults to `candidate`.
     */
    configType?: string;
    /**
     * The name.
     */
    name: 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 getRulestack.
 */
export interface GetRulestackResult {
    /**
     * Account group.
     */
    readonly accountGroup: string;
    /**
     * The account ID.
     */
    readonly accountId: 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;
    /**
     * Lookup x forwarded for.
     */
    readonly lookupXForwardedFor: string;
    /**
     * Minimum App-ID version number.
     */
    readonly minimumAppIdVersion: string;
    /**
     * The name.
     */
    readonly name: string;
    readonly profileConfigs: outputs.GetRulestackProfileConfig[];
    /**
     * 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 rulestack state.
     */
    readonly state: string;
    /**
     * The tags.
     */
    readonly tags: {
        [key: string]: string;
    };
}
/**
 * Data source for retrieving rulestack 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 example = cloudngfwaws.getRulestack({
 *     name: "my-rulestack-name",
 * });
 * ```
 */
export declare function getRulestackOutput(args: GetRulestackOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRulestackResult>;
/**
 * A collection of arguments for invoking getRulestack.
 */
export interface GetRulestackOutputArgs {
    /**
     * 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'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>;
}