Struct aws_sdk_wafv2::types::RequestInspection

#[non_exhaustive]
pub struct RequestInspection {
    pub payload_type: PayloadType,
    pub username_field: Option<UsernameField>,
    pub password_field: Option<PasswordField>,
}

The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

This is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.

In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

payload_type: PayloadType

The payload type for your login endpoint, either JSON or form encoded.

username_field: Option<UsernameField>

The name of the field in the request payload that contains your customer's username.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

  For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

• For form encoded payload types, use the HTML form names.

  For example, for an HTML form with the input element named username1, the username field specification is username1

password_field: Option<PasswordField>

The name of the field in the request payload that contains your customer's password.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

  For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

• For form encoded payload types, use the HTML form names.

  For example, for an HTML form with the input element named password1, the password field specification is password1.

Implementations

impl RequestInspection

pub fn payload_type(&self) -> &PayloadType

The payload type for your login endpoint, either JSON or form encoded.

pub fn username_field(&self) -> Option<&UsernameField>

The name of the field in the request payload that contains your customer's username.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

  For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username field specification is /form/username.

• For form encoded payload types, use the HTML form names.

  For example, for an HTML form with the input element named username1, the username field specification is username1

pub fn password_field(&self) -> Option<&PasswordField>

The name of the field in the request payload that contains your customer's password.

How you specify this depends on the request inspection payload type.

• For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

  For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password field specification is /form/password.

• For form encoded payload types, use the HTML form names.

  For example, for an HTML form with the input element named password1, the password field specification is password1.

impl RequestInspection

pub fn builder() -> RequestInspectionBuilder

Creates a new builder-style object to manufacture RequestInspection.

Trait Implementations

impl Clone for RequestInspection

fn clone(&self) -> RequestInspection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestInspection

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

Formats the value using the given formatter.

impl PartialEq for RequestInspection

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RequestInspection