All Superinterfaces:

Buildable, CopyableBuilder<RegexMatchTuple.Builder,RegexMatchTuple>, SdkBuilder<RegexMatchTuple.Builder,RegexMatchTuple>, SdkPojo

Enclosing class:

RegexMatchTuple
```
public static interface RegexMatchTuple.Builder
extends SdkPojo, CopyableBuilder<RegexMatchTuple.Builder,RegexMatchTuple>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default RegexMatchTuple.Builder`	`fieldToMatch(Consumer<FieldToMatch.Builder> fieldToMatch)`	Specifies where in a web request to look for the `RegexPatternSet`.
`RegexMatchTuple.Builder`	`fieldToMatch(FieldToMatch fieldToMatch)`	Specifies where in a web request to look for the `RegexPatternSet`.
`RegexMatchTuple.Builder`	`regexPatternSetId(String regexPatternSetId)`	The `RegexPatternSetId` for a `RegexPatternSet`.
`RegexMatchTuple.Builder`	`textTransformation(String textTransformation)`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.
`RegexMatchTuple.Builder`	`textTransformation(TextTransformation textTransformation)`	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

- Method Detail
  - fieldToMatch
```
RegexMatchTuple.Builder fieldToMatch(FieldToMatch fieldToMatch)
```
    Specifies where in a web request to look for the RegexPatternSet.
    
    Parameters:
    
    fieldToMatch - Specifies where in a web request to look for the RegexPatternSet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - fieldToMatch
```
default RegexMatchTuple.Builder fieldToMatch(Consumer<FieldToMatch.Builder> fieldToMatch)
```
    Specifies where in a web request to look for the RegexPatternSet.
    This is a convenience method that creates an instance of the FieldToMatch.Builder avoiding the need to create one manually via FieldToMatch.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldToMatch(FieldToMatch).
    
    Parameters:
    
    fieldToMatch - a consumer that will call methods on FieldToMatch.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    fieldToMatch(FieldToMatch)
  - textTransformation
```
RegexMatchTuple.Builder textTransformation(String 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.
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TextTransformation, TextTransformation
  - textTransformation
```
RegexMatchTuple.Builder textTransformation(TextTransformation 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.
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TextTransformation, TextTransformation
  - regexPatternSetId
```
RegexMatchTuple.Builder regexPatternSetId(String regexPatternSetId)
```
    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.
    
    Parameters:
    
    regexPatternSetId - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface RegexMatchTuple.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Method Detail

fieldToMatch

fieldToMatch

textTransformation

textTransformation

regexPatternSetId