Rate
data class RateLimitArgs(val action: Output<RateLimitActionArgs>? = null, val bypassUrlPatterns: Output<List<String>>? = null, val correlate: Output<RateLimitCorrelateArgs>? = null, val description: Output<String>? = null, val disabled: Output<Boolean>? = null, val match: Output<RateLimitMatchArgs>? = null, val period: Output<Int>? = null, val threshold: Output<Int>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<RateLimitArgs>
Provides a Cloudflare rate limit resource for a given zone. This can be used to limit the traffic you receive zone-wide, or matching more specific types of requests/responses.
cloudflare.RateLimitis 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 thecloudflare.Rulesetresource. Full details can be found in the developer documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const example = new cloudflare.RateLimit("example", {
zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
threshold: 2000,
period: 2,
match: {
request: {
urlPattern: `${cloudflareZone}/*`,
schemes: [
"HTTP",
"HTTPS",
],
methods: [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD",
],
},
response: {
statuses: [
200,
201,
202,
301,
429,
],
originTraffic: false,
headers: [
{
name: "Host",
op: "eq",
value: "localhost",
},
{
name: "X-Example",
op: "ne",
value: "my-example",
},
],
},
},
action: {
mode: "simulate",
timeout: 43200,
response: {
contentType: "text/plain",
body: "custom response body",
},
},
correlate: {
by: "nat",
},
disabled: false,
description: "example rate limit for a zone",
bypassUrlPatterns: [
"example.com/bypass1",
"example.com/bypass2",
],
});Content copied to clipboard
import pulumi
import pulumi_cloudflare as cloudflare
example = cloudflare.RateLimit("example",
zone_id="0da42c8d2132a9ddaf714f9e7c920711",
threshold=2000,
period=2,
match={
"request": {
"url_pattern": f"{cloudflare_zone}/*",
"schemes": [
"HTTP",
"HTTPS",
],
"methods": [
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD",
],
},
"response": {
"statuses": [
200,
201,
202,
301,
429,
],
"origin_traffic": False,
"headers": [
{
"name": "Host",
"op": "eq",
"value": "localhost",
},
{
"name": "X-Example",
"op": "ne",
"value": "my-example",
},
],
},
},
action={
"mode": "simulate",
"timeout": 43200,
"response": {
"content_type": "text/plain",
"body": "custom response body",
},
},
correlate={
"by": "nat",
},
disabled=False,
description="example rate limit for a zone",
bypass_url_patterns=[
"example.com/bypass1",
"example.com/bypass2",
])Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var example = new Cloudflare.RateLimit("example", new()
{
ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
Threshold = 2000,
Period = 2,
Match = new Cloudflare.Inputs.RateLimitMatchArgs
{
Request = new Cloudflare.Inputs.RateLimitMatchRequestArgs
{
UrlPattern = $"{cloudflareZone}/*",
Schemes = new[]
{
"HTTP",
"HTTPS",
},
Methods = new[]
{
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD",
},
},
Response = new Cloudflare.Inputs.RateLimitMatchResponseArgs
{
Statuses = new[]
{
200,
201,
202,
301,
429,
},
OriginTraffic = false,
Headers = new[]
{
{
{ "name", "Host" },
{ "op", "eq" },
{ "value", "localhost" },
},
{
{ "name", "X-Example" },
{ "op", "ne" },
{ "value", "my-example" },
},
},
},
},
Action = new Cloudflare.Inputs.RateLimitActionArgs
{
Mode = "simulate",
Timeout = 43200,
Response = new Cloudflare.Inputs.RateLimitActionResponseArgs
{
ContentType = "text/plain",
Body = "custom response body",
},
},
Correlate = new Cloudflare.Inputs.RateLimitCorrelateArgs
{
By = "nat",
},
Disabled = false,
Description = "example rate limit for a zone",
BypassUrlPatterns = new[]
{
"example.com/bypass1",
"example.com/bypass2",
},
});
});Content copied to clipboard
package main
import (
"fmt"
"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewRateLimit(ctx, "example", &cloudflare.RateLimitArgs{
ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
Threshold: pulumi.Int(2000),
Period: pulumi.Int(2),
Match: &cloudflare.RateLimitMatchArgs{
Request: &cloudflare.RateLimitMatchRequestArgs{
UrlPattern: pulumi.Sprintf("%v/*", cloudflareZone),
Schemes: pulumi.StringArray{
pulumi.String("HTTP"),
pulumi.String("HTTPS"),
},
Methods: pulumi.StringArray{
pulumi.String("GET"),
pulumi.String("POST"),
pulumi.String("PUT"),
pulumi.String("DELETE"),
pulumi.String("PATCH"),
pulumi.String("HEAD"),
},
},
Response: &cloudflare.RateLimitMatchResponseArgs{
Statuses: pulumi.IntArray{
pulumi.Int(200),
pulumi.Int(201),
pulumi.Int(202),
pulumi.Int(301),
pulumi.Int(429),
},
OriginTraffic: pulumi.Bool(false),
Headers: pulumi.StringMapArray{
pulumi.StringMap{
"name": pulumi.String("Host"),
"op": pulumi.String("eq"),
"value": pulumi.String("localhost"),
},
pulumi.StringMap{
"name": pulumi.String("X-Example"),
"op": pulumi.String("ne"),
"value": pulumi.String("my-example"),
},
},
},
},
Action: &cloudflare.RateLimitActionArgs{
Mode: pulumi.String("simulate"),
Timeout: pulumi.Int(43200),
Response: &cloudflare.RateLimitActionResponseArgs{
ContentType: pulumi.String("text/plain"),
Body: pulumi.String("custom response body"),
},
},
Correlate: &cloudflare.RateLimitCorrelateArgs{
By: pulumi.String("nat"),
},
Disabled: pulumi.Bool(false),
Description: pulumi.String("example rate limit for a zone"),
BypassUrlPatterns: pulumi.StringArray{
pulumi.String("example.com/bypass1"),
pulumi.String("example.com/bypass2"),
},
})
if err != nil {
return err
}
return nil
})
}Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.RateLimit;
import com.pulumi.cloudflare.RateLimitArgs;
import com.pulumi.cloudflare.inputs.RateLimitMatchArgs;
import com.pulumi.cloudflare.inputs.RateLimitMatchRequestArgs;
import com.pulumi.cloudflare.inputs.RateLimitMatchResponseArgs;
import com.pulumi.cloudflare.inputs.RateLimitActionArgs;
import com.pulumi.cloudflare.inputs.RateLimitActionResponseArgs;
import com.pulumi.cloudflare.inputs.RateLimitCorrelateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new RateLimit("example", RateLimitArgs.builder()
.zoneId("0da42c8d2132a9ddaf714f9e7c920711")
.threshold(2000)
.period(2)
.match(RateLimitMatchArgs.builder()
.request(RateLimitMatchRequestArgs.builder()
.urlPattern(String.format("%s/*", cloudflareZone))
.schemes(
"HTTP",
"HTTPS")
.methods(
"GET",
"POST",
"PUT",
"DELETE",
"PATCH",
"HEAD")
.build())
.response(RateLimitMatchResponseArgs.builder()
.statuses(
200,
201,
202,
301,
429)
.originTraffic(false)
.headers(
Map.ofEntries(
Map.entry("name", "Host"),
Map.entry("op", "eq"),
Map.entry("value", "localhost")
),
Map.ofEntries(
Map.entry("name", "X-Example"),
Map.entry("op", "ne"),
Map.entry("value", "my-example")
))
.build())
.build())
.action(RateLimitActionArgs.builder()
.mode("simulate")
.timeout(43200)
.response(RateLimitActionResponseArgs.builder()
.contentType("text/plain")
.body("custom response body")
.build())
.build())
.correlate(RateLimitCorrelateArgs.builder()
.by("nat")
.build())
.disabled(false)
.description("example rate limit for a zone")
.bypassUrlPatterns(
"example.com/bypass1",
"example.com/bypass2")
.build());
}
}Content copied to clipboard
resources:
example:
type: cloudflare:RateLimit
properties:
zoneId: 0da42c8d2132a9ddaf714f9e7c920711
threshold: 2000
period: 2
match:
request:
urlPattern: ${cloudflareZone}/*
schemes:
- HTTP
- HTTPS
methods:
- GET
- POST
- PUT
- DELETE
- PATCH
- HEAD
response:
statuses:
- 200
- 201
- 202
- 301
- 429
originTraffic: false
headers:
- name: Host
op: eq
value: localhost
- name: X-Example
op: ne
value: my-example
action:
mode: simulate
timeout: 43200
response:
contentType: text/plain
body: custom response body
correlate:
by: nat
disabled: false
description: example rate limit for a zone
bypassUrlPatterns:
- example.com/bypass1
- example.com/bypass2Content copied to clipboard
Import
$ pulumi import cloudflare:index/rateLimit:RateLimit example <zone_id>/<rate_limit_id>Content copied to clipboard
Constructors
Link copied to clipboard
constructor(action: Output<RateLimitActionArgs>? = null, bypassUrlPatterns: Output<List<String>>? = null, correlate: Output<RateLimitCorrelateArgs>? = null, description: Output<String>? = null, disabled: Output<Boolean>? = null, match: Output<RateLimitMatchArgs>? = null, period: Output<Int>? = null, threshold: Output<Int>? = null, zoneId: Output<String>? = null)
Properties
Link copied to clipboard
The action to be performed when the threshold of matched traffic within the period defined is exceeded.
Link copied to clipboard
Link copied to clipboard
Determines how rate limiting is applied. By default if not specified, rate limiting applies to the clients IP address.
Link copied to clipboard
A note that you can use to describe the reason for a rate limit. This value is sanitized and all tags are removed.
Link copied to clipboard
Determines which traffic the rate limit counts towards the threshold. By default matches all traffic in the zone.