@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RegexPatternSetReferenceStatement extends Object implements Serializable, Cloneable, StructuredPojo
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
Constructor and Description |
---|
RegexPatternSetReferenceStatement() |
Modifier and Type | Method and Description |
---|---|
RegexPatternSetReferenceStatement |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
|
FieldToMatch |
getFieldToMatch()
The part of the web request that you want WAF to inspect.
|
List<TextTransformation> |
getTextTransformations()
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
|
void |
setFieldToMatch(FieldToMatch fieldToMatch)
The part of the web request that you want WAF to inspect.
|
void |
setTextTransformations(Collection<TextTransformation> textTransformations)
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection.
|
String |
toString()
Returns a string representation of this object.
|
RegexPatternSetReferenceStatement |
withARN(String aRN)
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
|
RegexPatternSetReferenceStatement |
withFieldToMatch(FieldToMatch fieldToMatch)
The part of the web request that you want WAF to inspect.
|
RegexPatternSetReferenceStatement |
withTextTransformations(Collection<TextTransformation> textTransformations)
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection.
|
RegexPatternSetReferenceStatement |
withTextTransformations(TextTransformation... textTransformations)
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection.
|
public void setARN(String aRN)
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
aRN
- The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.public String getARN()
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
public RegexPatternSetReferenceStatement withARN(String aRN)
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
aRN
- The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.public void setFieldToMatch(FieldToMatch fieldToMatch)
The part of the web request that you want WAF to inspect.
fieldToMatch
- The part of the web request that you want WAF to inspect.public FieldToMatch getFieldToMatch()
The part of the web request that you want WAF to inspect.
public RegexPatternSetReferenceStatement withFieldToMatch(FieldToMatch fieldToMatch)
The part of the web request that you want WAF to inspect.
fieldToMatch
- The part of the web request that you want WAF to inspect.public List<TextTransformation> getTextTransformations()
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.
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.public void setTextTransformations(Collection<TextTransformation> textTransformations)
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.
textTransformations
- 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.public RegexPatternSetReferenceStatement withTextTransformations(TextTransformation... textTransformations)
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.
NOTE: This method appends the values to the existing list (if any). Use
setTextTransformations(java.util.Collection)
or withTextTransformations(java.util.Collection)
if you want to override the existing values.
textTransformations
- 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.public RegexPatternSetReferenceStatement withTextTransformations(Collection<TextTransformation> textTransformations)
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.
textTransformations
- 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.public String toString()
toString
in class Object
Object.toString()
public RegexPatternSetReferenceStatement clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.