Struct aws_sdk_wafv2::types::builders::ByteMatchStatementBuilder
source · #[non_exhaustive]pub struct ByteMatchStatementBuilder { /* private fields */ }
Expand description
A builder for ByteMatchStatement
.
Implementations§
source§impl ByteMatchStatementBuilder
impl ByteMatchStatementBuilder
sourcepub fn search_string(self, input: Blob) -> Self
pub fn search_string(self, input: Blob) -> Self
A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch
. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch
:
-
Method
: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request. -
UriPath
: The value that you want WAF to search for in the URI path, for example,/images/daily-ad.jpg
. -
JA3Fingerprint
: Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string matchByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
-
HeaderOrder
: The list of header names to match for. WAF creates a string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of Type
is HEADER
and the value of Data
is User-Agent
. If you want to search the User-Agent
header for the value BadBot
, you base64-encode BadBot
using MIME base64-encoding and include the resulting value, QmFkQm90
, in the value of SearchString
.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
This field is required.sourcepub fn set_search_string(self, input: Option<Blob>) -> Self
pub fn set_search_string(self, input: Option<Blob>) -> Self
A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch
. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch
:
-
Method
: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request. -
UriPath
: The value that you want WAF to search for in the URI path, for example,/images/daily-ad.jpg
. -
JA3Fingerprint
: Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string matchByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
-
HeaderOrder
: The list of header names to match for. WAF creates a string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of Type
is HEADER
and the value of Data
is User-Agent
. If you want to search the User-Agent
header for the value BadBot
, you base64-encode BadBot
using MIME base64-encoding and include the resulting value, QmFkQm90
, in the value of SearchString
.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
sourcepub fn get_search_string(&self) -> &Option<Blob>
pub fn get_search_string(&self) -> &Option<Blob>
A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch
. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch
:
-
Method
: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request. -
UriPath
: The value that you want WAF to search for in the URI path, for example,/images/daily-ad.jpg
. -
JA3Fingerprint
: Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string matchByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
-
HeaderOrder
: The list of header names to match for. WAF creates a string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If SearchString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of Type
is HEADER
and the value of Data
is User-Agent
. If you want to search the User-Agent
header for the value BadBot
, you base64-encode BadBot
using MIME base64-encoding and include the resulting value, QmFkQm90
, in the value of SearchString
.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
sourcepub fn field_to_match(self, input: FieldToMatch) -> Self
pub fn field_to_match(self, input: FieldToMatch) -> Self
The part of the web request that you want WAF to inspect.
This field is required.sourcepub fn set_field_to_match(self, input: Option<FieldToMatch>) -> Self
pub fn set_field_to_match(self, input: Option<FieldToMatch>) -> Self
The part of the web request that you want WAF to inspect.
sourcepub fn get_field_to_match(&self) -> &Option<FieldToMatch>
pub fn get_field_to_match(&self) -> &Option<FieldToMatch>
The part of the web request that you want WAF to inspect.
sourcepub fn text_transformations(self, input: TextTransformation) -> Self
pub fn text_transformations(self, input: TextTransformation) -> Self
Appends an item to text_transformations
.
To override the contents of this collection use set_text_transformations
.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
sourcepub fn set_text_transformations(
self,
input: Option<Vec<TextTransformation>>
) -> Self
pub fn set_text_transformations( self, input: Option<Vec<TextTransformation>> ) -> Self
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
sourcepub fn get_text_transformations(&self) -> &Option<Vec<TextTransformation>>
pub fn get_text_transformations(&self) -> &Option<Vec<TextTransformation>>
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
sourcepub fn positional_constraint(self, input: PositionalConstraint) -> Self
pub fn positional_constraint(self, input: PositionalConstraint) -> Self
The area within the portion of the web request that you want WAF to search for SearchString
. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString
, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString
, and SearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString
must be a word, which means that both of the following are true:
-
SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
. -
SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString
.
STARTS_WITH
The value of SearchString
must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString
must appear at the end of the specified part of the web request.
sourcepub fn set_positional_constraint(
self,
input: Option<PositionalConstraint>
) -> Self
pub fn set_positional_constraint( self, input: Option<PositionalConstraint> ) -> Self
The area within the portion of the web request that you want WAF to search for SearchString
. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString
, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString
, and SearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString
must be a word, which means that both of the following are true:
-
SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
. -
SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString
.
STARTS_WITH
The value of SearchString
must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString
must appear at the end of the specified part of the web request.
sourcepub fn get_positional_constraint(&self) -> &Option<PositionalConstraint>
pub fn get_positional_constraint(&self) -> &Option<PositionalConstraint>
The area within the portion of the web request that you want WAF to search for SearchString
. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString
, but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString
, and SearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString
must be a word, which means that both of the following are true:
-
SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
. -
SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString
.
STARTS_WITH
The value of SearchString
must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString
must appear at the end of the specified part of the web request.
sourcepub fn build(self) -> Result<ByteMatchStatement, BuildError>
pub fn build(self) -> Result<ByteMatchStatement, BuildError>
Consumes the builder and constructs a ByteMatchStatement
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for ByteMatchStatementBuilder
impl Clone for ByteMatchStatementBuilder
source§fn clone(&self) -> ByteMatchStatementBuilder
fn clone(&self) -> ByteMatchStatementBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ByteMatchStatementBuilder
impl Debug for ByteMatchStatementBuilder
source§impl Default for ByteMatchStatementBuilder
impl Default for ByteMatchStatementBuilder
source§fn default() -> ByteMatchStatementBuilder
fn default() -> ByteMatchStatementBuilder
source§impl PartialEq for ByteMatchStatementBuilder
impl PartialEq for ByteMatchStatementBuilder
source§fn eq(&self, other: &ByteMatchStatementBuilder) -> bool
fn eq(&self, other: &ByteMatchStatementBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.