Class: Aws::WAFV2::Types::UsernameField

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::UsernameField

Defined in:

gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

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

This data type is used in the RequestInspection and RequestInspectionACFP data types.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #identifier ⇒ String

  The name of the username field.

Instance Attribute Details

#identifier ⇒ String

The name of the username field.

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

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9065

class UsernameField < Struct.new(
  :identifier)
  SENSITIVE = []
  include Aws::Structure
end