RulesetRuleRatelimitArgs

data class RulesetRuleRatelimitArgs(val characteristics: Output<List<String>>, val countingExpression: Output<String>? = null, val mitigationTimeout: Output<Int>? = null, val period: Output<Int>, 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>>, countingExpression: Output<String>? = null, mitigationTimeout: Output<Int>? = null, period: Output<Int>, requestsPerPeriod: Output<Int>? = null, requestsToOrigin: Output<Boolean>? = null, scorePerPeriod: Output<Int>? = null, scoreResponseHeaderName: Output<String>? = null)

Properties

Link copied to clipboard

Characteristics of the request on which the ratelimiter counter will be incremented.

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

Defines when the ratelimit counter should be incremented. It is optional and defaults to the same as the rule's expression.

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

Period of time in seconds after which the action will be disabled following its first execution.

Link copied to clipboard
val period: Output<Int>

Period in seconds over which the counter is being incremented. Available values: 10, 60, 600, 3600.

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

The threshold of requests per period after which the action will be executed for the first time.

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

Defines if ratelimit counting is only done when an origin is reached.

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

The score threshold per period for which the action will be executed the first time.

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

The response header name provided by the origin which should contain the score to increment ratelimit counter on.

Functions

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