GetSecurityPolicyRuleRateLimitOption class
Constructors
-
GetSecurityPolicyRuleRateLimitOption({required Input<int> banDurationSec, required Input<List<GetSecurityPolicyRuleRateLimitOptionBanThreshold>> banThresholds, required Input<String> conformAction, required Input<String> enforceOnKey, required Input<List<GetSecurityPolicyRuleRateLimitOptionEnforceOnKeyConfig>> enforceOnKeyConfigs, required Input<String> enforceOnKeyName, required Input<String> exceedAction, required Input<List<GetSecurityPolicyRuleRateLimitOptionExceedRedirectOption>> exceedRedirectOptions, required Input<List<GetSecurityPolicyRuleRateLimitOptionRateLimitThreshold>> rateLimitThresholds})
-
Creates a new GetSecurityPolicyRuleRateLimitOption.
banDurationSec Can only be specified if the action for the rule is "rateBasedBan". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
banThresholds Can only be specified if the action for the rule is "rateBasedBan". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'.
conformAction Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
enforceOnKey Determines the key to enforce the rateLimitThreshold on
enforceOnKeyConfigs Enforce On Key Config of this security policy
enforceOnKeyName Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
exceedAction Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502, and "redirect" where the redirect parameters come from exceedRedirectOptions below.
exceedRedirectOptions Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.
rateLimitThresholds Threshold at which to begin ratelimiting.
const
-
GetSecurityPolicyRuleRateLimitOption.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
banDurationSec
→ Input<int>
-
Can only be specified if the action for the rule is "rateBasedBan". If specified, determines the time (in seconds) the traffic will continue to be banned by the rate limit after the rate falls below the threshold.
final
-
banThresholds
→ Input<List<GetSecurityPolicyRuleRateLimitOptionBanThreshold>>
-
Can only be specified if the action for the rule is "rateBasedBan". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'.
final
-
conformAction
→ Input<String>
-
Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.
final
-
enforceOnKey
→ Input<String>
-
Determines the key to enforce the rateLimitThreshold on
final
-
enforceOnKeyConfigs
→ Input<List<GetSecurityPolicyRuleRateLimitOptionEnforceOnKeyConfig>>
-
Enforce On Key Config of this security policy
final
-
enforceOnKeyName
→ Input<String>
-
Rate limit key name applicable only for the following key types: HTTP_HEADER -- Name of the HTTP header whose value is taken as the key value. HTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key value.
final
-
exceedAction
→ Input<String>
-
Action to take for requests that are above the configured rate limit threshold, to either deny with a specified HTTP response code, or redirect to a different endpoint. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502, and "redirect" where the redirect parameters come from exceedRedirectOptions below.
final
-
exceedRedirectOptions
→ Input<List<GetSecurityPolicyRuleRateLimitOptionExceedRedirectOption>>
-
Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
rateLimitThresholds
→ Input<List<GetSecurityPolicyRuleRateLimitOptionRateLimitThreshold>>
-
Threshold at which to begin ratelimiting.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
