RulesetRuleRatelimitArgs

data class RulesetRuleRatelimitArgs(val characteristics: Output<List<String>>? = null, val countingExpression: Output<String>? = null, val mitigationTimeout: Output<Int>? = null, val period: Output<Int>? = null, val requestsPerPeriod: Output<Int>? = null, val requestsToOrigin: Output<Boolean>? = null, val scorePerPeriod: Output<Int>? = null, val scoreResponseHeaderName: Output<String>? = null) : ConvertibleToJava<RulesetRuleRatelimitArgs>

Constructors

Link copied to clipboard
constructor(characteristics: Output<List<String>>? = null, countingExpression: Output<String>? = null, mitigationTimeout: Output<Int>? = null, period: Output<Int>? = null, requestsPerPeriod: Output<Int>? = null, requestsToOrigin: Output<Boolean>? = null, scorePerPeriod: Output<Int>? = null, scoreResponseHeaderName: Output<String>? = null)

Properties

Link copied to clipboard
val characteristics: Output<List<String>>? = null

List of parameters that define how Cloudflare tracks the request rate for this rule.

Link copied to clipboard
val countingExpression: Output<String>? = null

Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the Firewall Rules language documentation for all available fields, operators, and functions.

Link copied to clipboard
val mitigationTimeout: Output<Int>? = null

Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.

Link copied to clipboard
val period: Output<Int>? = null

The period of time to consider (in seconds) when evaluating the request rate.

Link copied to clipboard
val requestsPerPeriod: Output<Int>? = null

The number of requests over the period of time that will trigger the Rate Limiting rule.

Link copied to clipboard
val requestsToOrigin: Output<Boolean>? = null

Whether to include requests to origin within the Rate Limiting count.

Link copied to clipboard
val scorePerPeriod: Output<Int>? = null

The maximum aggregate score over the period of time that will trigger Rate Limiting rule.

Link copied to clipboard
val scoreResponseHeaderName: Output<String>? = null

Name of HTTP header in the response, set by the origin server, with the score for the current request.

Functions

Link copied to clipboard
open override fun toJava(): RulesetRuleRatelimitArgs