@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Cookies extends Object implements Serializable, Cloneable, StructuredPojo
Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON:
"Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }
Constructor and Description |
---|
Cookies() |
Modifier and Type | Method and Description |
---|---|
Cookies |
clone() |
boolean |
equals(Object obj) |
CookieMatchPattern |
getMatchPattern()
The filter to use to identify the subset of cookies to inspect in a web request.
|
String |
getMatchScope()
The parts of the cookies to inspect with the rule inspection criteria.
|
String |
getOversizeHandling()
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setMatchPattern(CookieMatchPattern matchPattern)
The filter to use to identify the subset of cookies to inspect in a web request.
|
void |
setMatchScope(String matchScope)
The parts of the cookies to inspect with the rule inspection criteria.
|
void |
setOversizeHandling(String oversizeHandling)
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect.
|
String |
toString()
Returns a string representation of this object.
|
Cookies |
withMatchPattern(CookieMatchPattern matchPattern)
The filter to use to identify the subset of cookies to inspect in a web request.
|
Cookies |
withMatchScope(MapMatchScope matchScope)
The parts of the cookies to inspect with the rule inspection criteria.
|
Cookies |
withMatchScope(String matchScope)
The parts of the cookies to inspect with the rule inspection criteria.
|
Cookies |
withOversizeHandling(OversizeHandling oversizeHandling)
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect.
|
Cookies |
withOversizeHandling(String oversizeHandling)
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect.
|
public void setMatchPattern(CookieMatchPattern matchPattern)
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
, or
ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
matchPattern
- The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
, or
ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
public CookieMatchPattern getMatchPattern()
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
, or
ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
You must specify exactly one setting: either All
, IncludedCookies
, or
ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
public Cookies withMatchPattern(CookieMatchPattern matchPattern)
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
, or
ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
matchPattern
- The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
, or
ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
public void setMatchScope(String matchScope)
The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
, WAF
inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values. It
requires a match to be found in the keys or the values or both. To require a match in the keys and in the values,
use a logical AND
statement to combine two match rules, one that inspects the keys and another that
inspects the values.
matchScope
- The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
,
WAF inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values.
It requires a match to be found in the keys or the values or both. To require a match in the keys and in
the values, use a logical AND
statement to combine two match rules, one that inspects the
keys and another that inspects the values.
MapMatchScope
public String getMatchScope()
The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
, WAF
inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values. It
requires a match to be found in the keys or the values or both. To require a match in the keys and in the values,
use a logical AND
statement to combine two match rules, one that inspects the keys and another that
inspects the values.
ALL
,
WAF inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values.
It requires a match to be found in the keys or the values or both. To require a match in the keys and in
the values, use a logical AND
statement to combine two match rules, one that inspects the
keys and another that inspects the values.
MapMatchScope
public Cookies withMatchScope(String matchScope)
The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
, WAF
inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values. It
requires a match to be found in the keys or the values or both. To require a match in the keys and in the values,
use a logical AND
statement to combine two match rules, one that inspects the keys and another that
inspects the values.
matchScope
- The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
,
WAF inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values.
It requires a match to be found in the keys or the values or both. To require a match in the keys and in
the values, use a logical AND
statement to combine two match rules, one that inspects the
keys and another that inspects the values.
MapMatchScope
public Cookies withMatchScope(MapMatchScope matchScope)
The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
, WAF
inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values. It
requires a match to be found in the keys or the values or both. To require a match in the keys and in the values,
use a logical AND
statement to combine two match rules, one that inspects the keys and another that
inspects the values.
matchScope
- The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL
,
WAF inspects both keys and values.
All
does not require a match to be found in the keys and a match to be found in the values.
It requires a match to be found in the keys or the values or both. To require a match in the keys and in
the values, use a logical AND
statement to combine two match rules, one that inspects the
keys and another that inspects the values.
MapMatchScope
public void setOversizeHandling(String oversizeHandling)
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH
- Treat the web request as not matching the rule statement.
oversizeHandling
- What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF
does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or
200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of
cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to
the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
OversizeHandling
public String getOversizeHandling()
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH
- Treat the web request as not matching the rule statement.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection
criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to
the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
OversizeHandling
public Cookies withOversizeHandling(String oversizeHandling)
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH
- Treat the web request as not matching the rule statement.
oversizeHandling
- What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF
does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or
200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of
cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to
the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
OversizeHandling
public Cookies withOversizeHandling(OversizeHandling oversizeHandling)
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH
- Treat the web request as not matching the rule statement.
oversizeHandling
- What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF
does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or
200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of
cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria.
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to
the request.
NO_MATCH
- Treat the web request as not matching the rule statement.
OversizeHandling
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.