@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class JsonBody extends Object implements Serializable, Cloneable, StructuredPojo
Inspect the body of the web request as JSON. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }
For additional information about this request component option, see JSON body in the WAF Developer Guide.
Constructor and Description |
---|
JsonBody() |
Modifier and Type | Method and Description |
---|---|
JsonBody |
clone() |
boolean |
equals(Object obj) |
String |
getInvalidFallbackBehavior()
What WAF should do if it fails to completely parse the JSON body.
|
JsonMatchPattern |
getMatchPattern()
The patterns to look for in the JSON body.
|
String |
getMatchScope()
The parts of the JSON to match against using the
MatchPattern . |
String |
getOversizeHandling()
What WAF should do if the body is larger than WAF can inspect.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setInvalidFallbackBehavior(String invalidFallbackBehavior)
What WAF should do if it fails to completely parse the JSON body.
|
void |
setMatchPattern(JsonMatchPattern matchPattern)
The patterns to look for in the JSON body.
|
void |
setMatchScope(String matchScope)
The parts of the JSON to match against using the
MatchPattern . |
void |
setOversizeHandling(String oversizeHandling)
What WAF should do if the body is larger than WAF can inspect.
|
String |
toString()
Returns a string representation of this object.
|
JsonBody |
withInvalidFallbackBehavior(BodyParsingFallbackBehavior invalidFallbackBehavior)
What WAF should do if it fails to completely parse the JSON body.
|
JsonBody |
withInvalidFallbackBehavior(String invalidFallbackBehavior)
What WAF should do if it fails to completely parse the JSON body.
|
JsonBody |
withMatchPattern(JsonMatchPattern matchPattern)
The patterns to look for in the JSON body.
|
JsonBody |
withMatchScope(JsonMatchScope matchScope)
The parts of the JSON to match against using the
MatchPattern . |
JsonBody |
withMatchScope(String matchScope)
The parts of the JSON to match against using the
MatchPattern . |
JsonBody |
withOversizeHandling(OversizeHandling oversizeHandling)
What WAF should do if the body is larger than WAF can inspect.
|
JsonBody |
withOversizeHandling(String oversizeHandling)
What WAF should do if the body is larger than WAF can inspect.
|
public void setMatchPattern(JsonMatchPattern matchPattern)
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
matchPattern
- The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the
rule inspection criteria.public JsonMatchPattern getMatchPattern()
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
public JsonBody withMatchPattern(JsonMatchPattern matchPattern)
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
matchPattern
- The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the
rule inspection criteria.public void setMatchScope(String matchScope)
The parts of the JSON to match against using the MatchPattern
. If you specify ALL
, WAF
matches against 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 JSON to match against using the MatchPattern
. If you specify
ALL
, WAF matches against 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.
JsonMatchScope
public String getMatchScope()
The parts of the JSON to match against using the MatchPattern
. If you specify ALL
, WAF
matches against 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.
MatchPattern
. If you specify
ALL
, WAF matches against 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.
JsonMatchScope
public JsonBody withMatchScope(String matchScope)
The parts of the JSON to match against using the MatchPattern
. If you specify ALL
, WAF
matches against 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 JSON to match against using the MatchPattern
. If you specify
ALL
, WAF matches against 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.
JsonMatchScope
public JsonBody withMatchScope(JsonMatchScope matchScope)
The parts of the JSON to match against using the MatchPattern
. If you specify ALL
, WAF
matches against 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 JSON to match against using the MatchPattern
. If you specify
ALL
, WAF matches against 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.
JsonMatchScope
public void setInvalidFallbackBehavior(String invalidFallbackBehavior)
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
invalidFallbackBehavior
- What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
BodyParsingFallbackBehavior
public String getInvalidFallbackBehavior()
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations
and inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
BodyParsingFallbackBehavior
public JsonBody withInvalidFallbackBehavior(String invalidFallbackBehavior)
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
invalidFallbackBehavior
- What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
BodyParsingFallbackBehavior
public JsonBody withInvalidFallbackBehavior(BodyParsingFallbackBehavior invalidFallbackBehavior)
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
invalidFallbackBehavior
- What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
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.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
BodyParsingFallbackBehavior
public void setOversizeHandling(String oversizeHandling)
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384
bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig
, for
additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and
web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
oversizeHandling
- What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB
(16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your
rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
OversizeHandling
public String getOversizeHandling()
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384
bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig
, for
additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and
web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB
(16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your
rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
OversizeHandling
public JsonBody withOversizeHandling(String oversizeHandling)
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384
bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig
, for
additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and
web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
oversizeHandling
- What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB
(16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your
rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
OversizeHandling
public JsonBody withOversizeHandling(OversizeHandling oversizeHandling)
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384
bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig
, for
additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your rule and
web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
oversizeHandling
- What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB
(16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
CONTINUE
- Inspect the available body contents 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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling with your
rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
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.