import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* > `cloudflare.RateLimit` is in a deprecation phase until June 15th, 2025.
* During this time period, this resource is still
* fully supported but you are strongly advised to move to the
* `cloudflare.Ruleset` resource. Full details can be found in the
* developer documentation.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cloudflare from "@pulumi/cloudflare";
*
* const exampleRateLimit = new cloudflare.RateLimit("example_rate_limit", {
* zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
* action: {
* mode: "challenge",
* response: {
* body: "This request has been rate-limited.",
* contentType: "text/xml",
* },
* timeout: 86400,
* },
* match: {
* headers: [{
* name: "Cf-Cache-Status",
* op: "ne",
* value: "HIT",
* }],
* request: {
* methods: [
* "GET",
* "POST",
* ],
* schemes: [
* "HTTP",
* "HTTPS",
* ],
* url: "*.example.org/path*",
* },
* response: {
* originTraffic: true,
* },
* },
* period: 900,
* threshold: 60,
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import cloudflare:index/rateLimit:RateLimit example '/'
* ```
*/
export declare class RateLimit extends pulumi.CustomResource {
/**
* Get an existing RateLimit 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?: RateLimitState, opts?: pulumi.CustomResourceOptions): RateLimit;
/**
* Returns true if the given object is an instance of RateLimit. 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 RateLimit;
/**
* The action to perform when the threshold of matched traffic within the configured period is exceeded.
*/
readonly action: pulumi.Output;
/**
* Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.
*/
readonly bypasses: pulumi.Output;
/**
* An informative summary of the rate limit. This value is sanitized and any tags will be removed.
*/
readonly description: pulumi.Output;
/**
* When true, indicates that the rate limit is currently disabled.
*/
readonly disabled: pulumi.Output;
/**
* Determines which traffic the rate limit counts towards the threshold.
*/
readonly match: pulumi.Output;
/**
* The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.
*/
readonly period: pulumi.Output;
/**
* The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.
*/
readonly threshold: pulumi.Output;
/**
* Defines an identifier.
*/
readonly zoneId: pulumi.Output;
/**
* Create a RateLimit 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: RateLimitArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RateLimit resources.
*/
export interface RateLimitState {
/**
* The action to perform when the threshold of matched traffic within the configured period is exceeded.
*/
action?: pulumi.Input;
/**
* Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.
*/
bypasses?: pulumi.Input[]>;
/**
* An informative summary of the rate limit. This value is sanitized and any tags will be removed.
*/
description?: pulumi.Input;
/**
* When true, indicates that the rate limit is currently disabled.
*/
disabled?: pulumi.Input;
/**
* Determines which traffic the rate limit counts towards the threshold.
*/
match?: pulumi.Input;
/**
* The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.
*/
period?: pulumi.Input;
/**
* The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.
*/
threshold?: pulumi.Input;
/**
* Defines an identifier.
*/
zoneId?: pulumi.Input;
}
/**
* The set of arguments for constructing a RateLimit resource.
*/
export interface RateLimitArgs {
/**
* The action to perform when the threshold of matched traffic within the configured period is exceeded.
*/
action: pulumi.Input;
/**
* Determines which traffic the rate limit counts towards the threshold.
*/
match: pulumi.Input;
/**
* The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.
*/
period: pulumi.Input;
/**
* The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.
*/
threshold: pulumi.Input;
/**
* Defines an identifier.
*/
zoneId: pulumi.Input;
}