SecurityPolicyRuleRateLimitOptionsArgs

data class SecurityPolicyRuleRateLimitOptionsArgs(val banDurationSec: Output<Int>? = null, val banThreshold: Output<SecurityPolicyRuleRateLimitOptionsBanThresholdArgs>? = null, val conformAction: Output<String>? = null, val enforceOnKey: Output<String>? = null, val enforceOnKeyConfigs: Output<List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs>>? = null, val enforceOnKeyName: Output<String>? = null, val exceedAction: Output<String>? = null, val exceedRedirectOptions: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = null, val rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>? = null) : ConvertibleToJava<SecurityPolicyRuleRateLimitOptionsArgs>

Constructors

Link copied to clipboard
constructor(banDurationSec: Output<Int>? = null, banThreshold: Output<SecurityPolicyRuleRateLimitOptionsBanThresholdArgs>? = null, conformAction: Output<String>? = null, enforceOnKey: Output<String>? = null, enforceOnKeyConfigs: Output<List<SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfigArgs>>? = null, enforceOnKeyName: Output<String>? = null, exceedAction: Output<String>? = null, exceedRedirectOptions: Output<SecurityPolicyRuleRateLimitOptionsExceedRedirectOptionsArgs>? = null, rateLimitThreshold: Output<SecurityPolicyRuleRateLimitOptionsRateLimitThresholdArgs>? = null)

Properties

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

Can only be specified if the action for the rule is "rate_based_ban". 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.

Link copied to clipboard

Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'banDurationSec' when the number of requests that exceed the 'rateLimitThreshold' also exceed this 'banThreshold'. Structure is documented below.

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

Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only.

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

Determines the key to enforce the rateLimitThreshold on. Possible values are:

Link copied to clipboard

If specified, any combination of values of enforceOnKeyType/enforceOnKeyName is treated as the key on which ratelimit threshold/action is enforced. You can specify up to 3 enforceOnKeyConfigs. If enforceOnKeyConfigs is specified, enforceOnKey must not be specified. Structure is documented below.

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

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.

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

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(STATUS), where valid values for STATUS are 403, 404, 429, and 502.

Link copied to clipboard

Parameters defining the redirect action that is used as the exceed action. Cannot be specified if the exceed action is not redirect. This field is only supported in Global Security Policies of type CLOUD_ARMOR. Structure is documented below.

Link copied to clipboard

Threshold at which to begin ratelimiting. Structure is documented below.

Functions

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