Struct aws_sdk_wafv2::types::builders::JsonBodyBuilder
source · #[non_exhaustive]pub struct JsonBodyBuilder { /* private fields */ }
Expand description
A builder for JsonBody
.
Implementations§
source§impl JsonBodyBuilder
impl JsonBodyBuilder
sourcepub fn match_pattern(self, input: JsonMatchPattern) -> Self
pub fn match_pattern(self, input: JsonMatchPattern) -> Self
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
This field is required.sourcepub fn set_match_pattern(self, input: Option<JsonMatchPattern>) -> Self
pub fn set_match_pattern(self, input: Option<JsonMatchPattern>) -> Self
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
sourcepub fn get_match_pattern(&self) -> &Option<JsonMatchPattern>
pub fn get_match_pattern(&self) -> &Option<JsonMatchPattern>
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
sourcepub fn match_scope(self, input: JsonMatchScope) -> Self
pub fn match_scope(self, input: JsonMatchScope) -> Self
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.
sourcepub fn set_match_scope(self, input: Option<JsonMatchScope>) -> Self
pub fn set_match_scope(self, input: Option<JsonMatchScope>) -> Self
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.
sourcepub fn get_match_scope(&self) -> &Option<JsonMatchScope>
pub fn get_match_scope(&self) -> &Option<JsonMatchScope>
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.
sourcepub fn invalid_fallback_behavior(
self,
input: BodyParsingFallbackBehavior
) -> Self
pub fn invalid_fallback_behavior( self, input: BodyParsingFallbackBehavior ) -> Self
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 does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
WAF parses the JSON in the following examples as two valid key, value pairs:
-
Missing comma:
{"key1":"value1""key2":"value2"}
-
Missing colon:
{"key1":"value1","key2""value2"}
-
Extra colons:
{"key1"::"value1","key2""value2"}
sourcepub fn set_invalid_fallback_behavior(
self,
input: Option<BodyParsingFallbackBehavior>
) -> Self
pub fn set_invalid_fallback_behavior( self, input: Option<BodyParsingFallbackBehavior> ) -> Self
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 does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
WAF parses the JSON in the following examples as two valid key, value pairs:
-
Missing comma:
{"key1":"value1""key2":"value2"}
-
Missing colon:
{"key1":"value1","key2""value2"}
-
Extra colons:
{"key1"::"value1","key2""value2"}
sourcepub fn get_invalid_fallback_behavior(
&self
) -> &Option<BodyParsingFallbackBehavior>
pub fn get_invalid_fallback_behavior( &self ) -> &Option<BodyParsingFallbackBehavior>
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 does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
WAF parses the JSON in the following examples as two valid key, value pairs:
-
Missing comma:
{"key1":"value1""key2":"value2"}
-
Missing colon:
{"key1":"value1","key2""value2"}
-
Extra colons:
{"key1"::"value1","key2""value2"}
sourcepub fn oversize_handling(self, input: OversizeHandling) -> Self
pub fn oversize_handling(self, input: OversizeHandling) -> Self
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
sourcepub fn set_oversize_handling(self, input: Option<OversizeHandling>) -> Self
pub fn set_oversize_handling(self, input: Option<OversizeHandling>) -> Self
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
sourcepub fn get_oversize_handling(&self) -> &Option<OversizeHandling>
pub fn get_oversize_handling(&self) -> &Option<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
Trait Implementations§
source§impl Clone for JsonBodyBuilder
impl Clone for JsonBodyBuilder
source§fn clone(&self) -> JsonBodyBuilder
fn clone(&self) -> JsonBodyBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for JsonBodyBuilder
impl Debug for JsonBodyBuilder
source§impl Default for JsonBodyBuilder
impl Default for JsonBodyBuilder
source§fn default() -> JsonBodyBuilder
fn default() -> JsonBodyBuilder
source§impl PartialEq for JsonBodyBuilder
impl PartialEq for JsonBodyBuilder
source§fn eq(&self, other: &JsonBodyBuilder) -> bool
fn eq(&self, other: &JsonBodyBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for JsonBodyBuilder
Auto Trait Implementations§
impl Freeze for JsonBodyBuilder
impl RefUnwindSafe for JsonBodyBuilder
impl Send for JsonBodyBuilder
impl Sync for JsonBodyBuilder
impl Unpin for JsonBodyBuilder
impl UnwindSafe for JsonBodyBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more