Struct aws_sdk_waf::types::builders::RegexMatchTupleBuilder

#[non_exhaustive]
pub struct RegexMatchTupleBuilder { /* private fields */ }

A builder for RegexMatchTuple.

Implementations

impl RegexMatchTupleBuilder

pub fn field_to_match(self, input: FieldToMatch) -> Self

Specifies where in a web request to look for the RegexPatternSet.

This field is required.

pub fn set_field_to_match(self, input: Option<FieldToMatch>) -> Self

Specifies where in a web request to look for the RegexPatternSet.

pub fn get_field_to_match(&self) -> &Option<FieldToMatch>

Specifies where in a web request to look for the RegexPatternSet.

pub fn text_transformation(self, input: TextTransformation) -> Self

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

• Delete the following characters: \ " ' ^

• Delete spaces before the following characters: / (

• Replace the following characters with a space: , ;

• Replace multiple spaces with one space

• Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

• \f, formfeed, decimal 12

• \t, tab, decimal 9

• \n, newline, decimal 10

• \r, carriage return, decimal 13

• \v, vertical tab, decimal 11

• non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

• Replaces (ampersand)quot; with "

• Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

• Replaces (ampersand)lt; with a "less than" symbol

• Replaces (ampersand)gt; with >

• Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

• Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

This field is required.

pub fn set_text_transformation(self, input: Option<TextTransformation>) -> Self

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

• Delete the following characters: \ " ' ^

• Delete spaces before the following characters: / (

• Replace the following characters with a space: , ;

• Replace multiple spaces with one space

• Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

• \f, formfeed, decimal 12

• \t, tab, decimal 9

• \n, newline, decimal 10

• \r, carriage return, decimal 13

• \v, vertical tab, decimal 11

• non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

• Replaces (ampersand)quot; with "

• Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

• Replaces (ampersand)lt; with a "less than" symbol

• Replaces (ampersand)gt; with >

• Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

• Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

pub fn get_text_transformation(&self) -> &Option<TextTransformation>

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

You can only specify a single type of TextTransformation.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

• Delete the following characters: \ " ' ^

• Delete spaces before the following characters: / (

• Replace the following characters with a space: , ;

• Replace multiple spaces with one space

• Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

• \f, formfeed, decimal 12

• \t, tab, decimal 9

• \n, newline, decimal 10

• \r, carriage return, decimal 13

• \v, vertical tab, decimal 11

• non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

• Replaces (ampersand)quot; with "

• Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

• Replaces (ampersand)lt; with a "less than" symbol

• Replaces (ampersand)gt; with >

• Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

• Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

pub fn regex_pattern_set_id(self, input: impl Into<String>) -> Self

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

This field is required.

pub fn set_regex_pattern_set_id(self, input: Option<String>) -> Self

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

pub fn get_regex_pattern_set_id(&self) -> &Option<String>

The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

pub fn build(self) -> Result<RegexMatchTuple, BuildError>

Consumes the builder and constructs a RegexMatchTuple. This method will fail if any of the following fields are not set:

• text_transformation
• regex_pattern_set_id

Trait Implementations

impl Clone for RegexMatchTupleBuilder

fn clone(&self) -> RegexMatchTupleBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RegexMatchTupleBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RegexMatchTupleBuilder

fn default() -> RegexMatchTupleBuilder

Returns the “default value” for a type.

impl PartialEq for RegexMatchTupleBuilder

fn eq(&self, other: &RegexMatchTupleBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RegexMatchTupleBuilder