Struct SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

pub struct SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig {
    pub enforce_on_key_name: Option<String>,
    pub enforce_on_key_type: Option<String>,
}

There is no detailed description.

This type is not used in any activity, and only used as part of another schema.

Fields

enforce_on_key_name: Option<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.

enforce_on_key_type: Option<String>

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 “enforceOnKeyConfigs” 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 “enforceOnKeyName”. 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 “enforceOnKeyName”. 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. - HTTP_PATH: The URL path of the HTTP request. The key value is truncated to the first 128 bytes. - SNI: Server name indication in the TLS session of the HTTPS request. The key value is truncated to the first 128 bytes. The key type defaults to ALL on a HTTP session. - REGION_CODE: The country/region from which the request originates. - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the key type defaults to ALL. - USER_IP: The IP address of the originating client, which is resolved based on “userIpRequestHeaders” configured with the security policy. If there is no “userIpRequestHeaders” configuration or an IP address cannot be resolved from it, the key type defaults to IP.

Trait Implementations

impl Clone for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn clone(&self) -> SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn default() -> SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig