Struct aws_sdk_wafv2::model::FieldToMatch

#[non_exhaustive]
pub struct FieldToMatch { /* private fields */ }

The part of the web request that you want WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.

Example JSON for a QueryString field to match:

"FieldToMatch": { "QueryString": {} }

Example JSON for a Method field to match specification:

"FieldToMatch": { "Method": { "Name": "DELETE" } }

Implementations

impl FieldToMatch

pub fn single_header(&self) -> Option<&SingleHeader>

Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

Example JSON: "SingleHeader": { "Name": "haystack" }

Alternately, you can filter and inspect all headers with the Headers FieldToMatch setting.

pub fn single_query_argument(&self) -> Option<&SingleQueryArgument>

Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.

Example JSON: "SingleQueryArgument": { "Name": "myArgument" }

pub fn all_query_arguments(&self) -> Option<&AllQueryArguments>

Inspect all query arguments.

pub fn uri_path(&self) -> Option<&UriPath>

Inspect the request URI path. This is the part of the web request that identifies a resource, for example, /images/daily-ad.jpg.

pub fn query_string(&self) -> Option<&QueryString>

Inspect the query string. This is the part of a URL that appears after a ? character, if any.

pub fn body(&self) -> Option<&Body>

Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the Body object configuration.

pub fn method(&self) -> Option<&Method>

Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

pub fn json_body(&self) -> Option<&JsonBody>

Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.

Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. For information about how to handle oversized request bodies, see the JsonBody object configuration.

pub fn headers(&self) -> Option<&Headers>

Inspect the request headers. You must configure scope and pattern matching filters in the Headers object, to define the set of headers to and the parts of the headers that WAF inspects.

Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the Headers object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service.

pub fn cookies(&self) -> Option<&Cookies>

Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies object, to define the set of cookies and the parts of the cookies that WAF inspects.

Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.

impl FieldToMatch

pub fn builder() -> Builder

Creates a new builder-style object to manufacture FieldToMatch.

Trait Implementations

impl Clone for FieldToMatch

fn clone(&self) -> FieldToMatch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldToMatch

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

Formats the value using the given formatter.

impl PartialEq<FieldToMatch> for FieldToMatch

fn eq(&self, other: &FieldToMatch) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FieldToMatch) -> bool

This method tests for !=.

impl StructuralPartialEq for FieldToMatch