Class SecurityPolicyRuleRateLimitOptions (1.5.2)

SecurityPolicyRuleRateLimitOptions(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Attributes

Name	Description
`ban_duration_sec`	`int` 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. This field is a member of `oneof`_ `_ban_duration_sec`.
`ban_threshold`	`google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsThreshold` Can only be specified if the action for the rule is "rate_based_ban". If specified, the key will be banned for the configured 'ban_duration_sec' when the number of requests that exceed the 'rate_limit_threshold' also exceed this 'ban_threshold'. This field is a member of `oneof`_ `_ban_threshold`.
`conform_action`	`str` Action to take for requests that are under the configured rate limit threshold. Valid option is "allow" only. This field is a member of `oneof`_ `_conform_action`.
`enforce_on_key`	`str` Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if this field 'enforce_on_key' is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL. Check the EnforceOnKey enum for the list of possible values. This field is a member of `oneof`_ `_enforce_on_key`.
`enforce_on_key_name`	`str` 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. This field is a member of `oneof`_ `_enforce_on_key_name`.
`exceed_action`	`str` 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, and "redirect" where the redirect parameters come from exceedRedirectOptions below. This field is a member of `oneof`_ `_exceed_action`.
`exceed_redirect_options`	`google.cloud.compute_v1.types.SecurityPolicyRuleRedirectOptions` 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 a member of `oneof`_ `_exceed_redirect_options`.
`rate_limit_threshold`	`google.cloud.compute_v1.types.SecurityPolicyRuleRateLimitOptionsThreshold` Threshold at which to begin ratelimiting. This field is a member of `oneof`_ `_rate_limit_threshold`.

Classes

EnforceOnKey

EnforceOnKey(value)

Determines the key to enforce the rate_limit_threshold on. Possible values are: - ALL: A single rate limit threshold is applied to all the requests matching this rule. This is the default value if this field 'enforce_on_key' is not configured. - IP: The source IP address of the request is the key. Each IP has this limit enforced separately. - HTTP_HEADER: The value of the HTTP header whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the header value. If no such header is present in the request, the key type defaults to ALL. - XFF_IP: The first IP address (i.e. the originating client IP address) specified in the list of IPs under X-Forwarded-For HTTP header. If no such header is present or the value is not a valid IP, the key defaults to the source IP address of the request i.e. key type IP. - HTTP_COOKIE: The value of the HTTP cookie whose name is configured under "enforce_on_key_name". The key value is truncated to the first 128 bytes of the cookie value. If no such cookie is present in the request, the key type defaults to ALL.