CustomRuleResponse

data class CustomRuleResponse(val action: String, val enabledState: String? = null, val matchConditions: List<FrontDoorMatchConditionResponse>, val name: String? = null, val priority: Int, val rateLimitDurationInMinutes: Int? = null, val rateLimitThreshold: Int? = null, val ruleType: String)

Defines contents of a web application rule

Constructors

Link copied to clipboard
constructor(action: String, enabledState: String? = null, matchConditions: List<FrontDoorMatchConditionResponse>, name: String? = null, priority: Int, rateLimitDurationInMinutes: Int? = null, rateLimitThreshold: Int? = null, ruleType: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Describes what action to be applied when rule matches.

Link copied to clipboard
val enabledState: String? = null

Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.

Link copied to clipboard
Link copied to clipboard
val name: String? = null

Describes the name of the rule.

Link copied to clipboard

Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.

Link copied to clipboard

Time window for resetting the rate limit count. Default is 1 minute.

Link copied to clipboard
val rateLimitThreshold: Int? = null

Number of allowed requests per client within the time window.

Link copied to clipboard

Describes type of rule.