@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RequestInspection extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
RequestInspection() |
Modifier and Type | Method and Description |
---|---|
RequestInspection |
clone() |
boolean |
equals(Object obj) |
PasswordField |
getPasswordField()
The name of the field in the request payload that contains your customer's password.
|
String |
getPayloadType()
The payload type for your login endpoint, either JSON or form encoded.
|
UsernameField |
getUsernameField()
The name of the field in the request payload that contains your customer's username.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setPasswordField(PasswordField passwordField)
The name of the field in the request payload that contains your customer's password.
|
void |
setPayloadType(String payloadType)
The payload type for your login endpoint, either JSON or form encoded.
|
void |
setUsernameField(UsernameField usernameField)
The name of the field in the request payload that contains your customer's username.
|
String |
toString()
Returns a string representation of this object.
|
RequestInspection |
withPasswordField(PasswordField passwordField)
The name of the field in the request payload that contains your customer's password.
|
RequestInspection |
withPayloadType(PayloadType payloadType)
The payload type for your login endpoint, either JSON or form encoded.
|
RequestInspection |
withPayloadType(String payloadType)
The payload type for your login endpoint, either JSON or form encoded.
|
RequestInspection |
withUsernameField(UsernameField usernameField)
The name of the field in the request payload that contains your customer's username.
|
public void setPayloadType(String payloadType)
The payload type for your login endpoint, either JSON or form encoded.
payloadType
- The payload type for your login endpoint, either JSON or form encoded.PayloadType
public String getPayloadType()
The payload type for your login endpoint, either JSON or form encoded.
PayloadType
public RequestInspection withPayloadType(String payloadType)
The payload type for your login endpoint, either JSON or form encoded.
payloadType
- The payload type for your login endpoint, either JSON or form encoded.PayloadType
public RequestInspection withPayloadType(PayloadType payloadType)
The payload type for your login endpoint, either JSON or form encoded.
payloadType
- The payload type for your login endpoint, either JSON or form encoded.PayloadType
public void setUsernameField(UsernameField 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
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
public UsernameField getUsernameField()
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
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
public RequestInspection withUsernameField(UsernameField 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
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
public void setPasswordField(PasswordField 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
.
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
.
public PasswordField getPasswordField()
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
.
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
.
public RequestInspection withPasswordField(PasswordField 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
.
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
.
public String toString()
toString
in class Object
Object.toString()
public RequestInspection clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.