pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin.outputs/RulesetRuleRatelimit

RulesetRuleRatelimit

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

Constructors

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

Types

Companion

object Companion

Properties

characteristics

val characteristics: List<String>

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

countingExpression

val countingExpression: String? = null

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

mitigationTimeout

val mitigationTimeout: Int? = null

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

period

val period: Int

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

requestsPerPeriod

val requestsPerPeriod: Int? = null

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

requestsToOrigin

val requestsToOrigin: Boolean? = null

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

scorePerPeriod

val scorePerPeriod: Int? = null

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

scoreResponseHeaderName

val scoreResponseHeaderName: String? = null

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