Struct UpdateRateLimiterParams

pub struct UpdateRateLimiterParams {
    pub rate_limiter_id: String,
    pub name: Option<String>,
    pub uri_dictionary_name: Option<String>,
    pub http_methods: Option<Vec<String>>,
    pub rps_limit: Option<i32>,
    pub window_size: Option<i32>,
    pub client_key: Option<Vec<String>>,
    pub penalty_box_duration: Option<i32>,
    pub action: Option<String>,
    pub response_object_name: Option<String>,
    pub logger_type: Option<String>,
    pub feature_revision: Option<i32>,
}

struct for passing parameters to the method update_rate_limiter

Fields

rate_limiter_id: String

Alphanumeric string identifying the rate limiter.

name: Option<String>

A human readable name for the rate limiting rule.

uri_dictionary_name: Option<String>

The name of a Dictionary containing URIs as keys. If not defined or null, all origin URIs will be rate limited.

http_methods: Option<Vec<String>>

Array of HTTP methods to apply rate limiting to.

rps_limit: Option<i32>

Upper limit of requests per second allowed by the rate limiter.

window_size: Option<i32>

Number of seconds during which the RPS limit must be exceeded in order to trigger a violation.

client_key: Option<Vec<String>>

Array of VCL variables used to generate a counter key to identify a client. Example variables include req.http.Fastly-Client-IP, req.http.User-Agent, or a custom header like req.http.API-Key.

penalty_box_duration: Option<i32>

Length of time in minutes that the rate limiter is in effect after the initial violation is detected.

action: Option<String>

The action to take when a rate limiter violation is detected.

response_object_name: Option<String>

Name of existing response object. Required if action is response_object. Note that the rate limiter response is only updated to reflect the response object content when saving the rate limiter configuration.

logger_type: Option<String>

Name of the type of logging endpoint to be used when action is log_only. The logging endpoint type is used to determine the appropriate log format to use when emitting log entries.

feature_revision: Option<i32>

Revision number of the rate limiting feature implementation. Defaults to the most recent revision.

Trait Implementations

impl Clone for UpdateRateLimiterParams

fn clone(&self) -> UpdateRateLimiterParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateRateLimiterParams

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

Formats the value using the given formatter.

impl Default for UpdateRateLimiterParams

fn default() -> UpdateRateLimiterParams

Returns the “default value” for a type.