CustomRuleArgs

data class CustomRuleArgs(val action: Output<Either<String, ActionType>>, val enabledState: Output<Either<String, CustomRuleEnabledState>>? = null, val matchConditions: Output<List<FrontDoorMatchConditionArgs>>, val name: Output<String>? = null, val priority: Output<Int>, val rateLimitDurationInMinutes: Output<Int>? = null, val rateLimitThreshold: Output<Int>? = null, val ruleType: Output<Either<String, RuleType>>) : ConvertibleToJava<CustomRuleArgs>

Defines contents of a web application rule

Constructors

Link copied to clipboard
constructor(action: Output<Either<String, ActionType>>, enabledState: Output<Either<String, CustomRuleEnabledState>>? = null, matchConditions: Output<List<FrontDoorMatchConditionArgs>>, name: Output<String>? = null, priority: Output<Int>, rateLimitDurationInMinutes: Output<Int>? = null, rateLimitThreshold: Output<Int>? = null, ruleType: Output<Either<String, RuleType>>)

Properties

Link copied to clipboard
val action: Output<Either<String, ActionType>>

Describes what action to be applied when rule matches.

Link copied to clipboard
val enabledState: Output<Either<String, CustomRuleEnabledState>>? = null

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

Link copied to clipboard

List of match conditions.

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

Describes the name of the rule.

Link copied to clipboard
val priority: Output<Int>

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

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

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

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

Number of allowed requests per client within the time window.

Link copied to clipboard
val ruleType: Output<Either<String, RuleType>>

Describes type of rule.

Functions

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