Package software.amazon.awssdk.services.waf.model

Class FieldToMatch

java.lang.Object

software.amazon.awssdk.services.waf.model.FieldToMatch

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<FieldToMatch.Builder,FieldToMatch>

@Generated("software.amazon.awssdk:codegen")
public class FieldToMatch
extends Object
implements StructuredPojo, ToCopyableBuilder<FieldToMatch.Builder,FieldToMatch>

Specifies where in a web request to look for TargetString.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FieldToMatch.Builder

Method Summary

Modifier and Type	Method	Description
static FieldToMatch.Builder	builder()
String	data()	When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer.
boolean	equals(Object obj)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends FieldToMatch.Builder>	serializableBuilderClass()
FieldToMatch.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The part of the web request that you want AWS WAF to search for a specified string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

type

public String type()

The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

• HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

• METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

• QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

• URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

• BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

Returns:

The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

• HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

• METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

• QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

• URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

• BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

See Also:

MatchFieldType

data

public String data()

When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

The name of the header is not case sensitive.

Returns:

When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

The name of the header is not case sensitive.

toBuilder

public FieldToMatch.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FieldToMatch.Builder,FieldToMatch>

Returns:

a builder for type T

builder

public static FieldToMatch.Builder builder()

serializableBuilderClass

public static Class<? extends FieldToMatch.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.