import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * With this resource, you can manage Rate Limit Policies for the Authentication API, applying per-application (client-ID-based) throttling so a single application's traffic spike is isolated at the edge and does not exhaust the tenant's global rate limit. (EA only) * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as auth0 from "@pulumi/auth0"; * * const noisyApp = new auth0.RateLimitPolicy("noisy_app", { * configuration: { * action: "redirect", * limit: 1000, * redirectUri: "https://example.com/rate-limited", * }, * resource: "oauth_authentication_api", * consumer: "client", * consumerSelector: "client_id:abc123", * }); * ``` * * ## Import * * Rate limit policies can be imported using their ID. * * You can find existing rate limit policy IDs using the Auth0 Management API. * https://auth0.com/docs/api/management/v2#!/Rate_Limit_Policies/get_rate_limit_policies * * Example: * * ```sh * $ pulumi import auth0:index/rateLimitPolicy:RateLimitPolicy noisy_app "rlp_XXXXXXXXXXXXXXXX" * ``` */ export declare class RateLimitPolicy extends pulumi.CustomResource { /** * Get an existing RateLimitPolicy 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, state?: RateLimitPolicyState, opts?: pulumi.CustomResourceOptions): RateLimitPolicy; /** * Check whether an existing RateLimitPolicy resource with the given ID exists. * * @param id The _unique_ provider ID of the resource to check. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static exists(id: pulumi.Input, state?: RateLimitPolicyState, opts?: pulumi.CustomResourceOptions): pulumi.Output; /** * Returns true if the given object is an instance of RateLimitPolicy. 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 RateLimitPolicy; /** * The throttling configuration applied when the rate limit is reached. (EA only) */ readonly configuration: pulumi.Output; /** * The consumer category the policy applies to. Valid values are: client */ readonly consumer: pulumi.Output; /** * Identifier or category within the consumer to which the policy applies. Supported values: `client_id:`, `client_id:`, `cimdClients`, `thirdPartyClients`, or `default`. (EA only) */ readonly consumerSelector: pulumi.Output; /** * The date and time when the rate limit policy was created. */ readonly createdAt: pulumi.Output; /** * The resource the policy applies to. Valid values are: oauth*authentication*api */ readonly resource: pulumi.Output; /** * The date and time when the rate limit policy was last updated. */ readonly updatedAt: pulumi.Output; /** * Create a RateLimitPolicy 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: RateLimitPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering RateLimitPolicy resources. */ export interface RateLimitPolicyState { /** * The throttling configuration applied when the rate limit is reached. (EA only) */ configuration?: pulumi.Input; /** * The consumer category the policy applies to. Valid values are: client */ consumer?: pulumi.Input; /** * Identifier or category within the consumer to which the policy applies. Supported values: `client_id:`, `client_id:`, `cimdClients`, `thirdPartyClients`, or `default`. (EA only) */ consumerSelector?: pulumi.Input; /** * The date and time when the rate limit policy was created. */ createdAt?: pulumi.Input; /** * The resource the policy applies to. Valid values are: oauth*authentication*api */ resource?: pulumi.Input; /** * The date and time when the rate limit policy was last updated. */ updatedAt?: pulumi.Input; } /** * The set of arguments for constructing a RateLimitPolicy resource. */ export interface RateLimitPolicyArgs { /** * The throttling configuration applied when the rate limit is reached. (EA only) */ configuration: pulumi.Input; /** * The consumer category the policy applies to. Valid values are: client */ consumer: pulumi.Input; /** * Identifier or category within the consumer to which the policy applies. Supported values: `client_id:`, `client_id:`, `cimdClients`, `thirdPartyClients`, or `default`. (EA only) */ consumerSelector: pulumi.Input; /** * The resource the policy applies to. Valid values are: oauth*authentication*api */ resource: pulumi.Input; } //# sourceMappingURL=rateLimitPolicy.d.ts.map