Struct RegexPatternSetReferenceStatement

#[non_exhaustive]
pub struct RegexPatternSetReferenceStatement {
    pub arn: String,
    pub field_to_match: Option<FieldToMatch>,
    pub text_transformations: Vec<TextTransformation>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: String

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

field_to_match: Option<FieldToMatch>

The part of the web request that you want WAF to inspect.

text_transformations: 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.

Implementations

impl RegexPatternSetReferenceStatement

pub fn arn(&self) -> &str

The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

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

The part of the web request that you want WAF to inspect.

pub fn text_transformations(&self) -> &[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.

impl RegexPatternSetReferenceStatement

pub fn builder() -> RegexPatternSetReferenceStatementBuilder

Creates a new builder-style object to manufacture RegexPatternSetReferenceStatement.

Trait Implementations

impl Clone for RegexPatternSetReferenceStatement

fn clone(&self) -> RegexPatternSetReferenceStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegexPatternSetReferenceStatement

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

Formats the value using the given formatter.

impl PartialEq for RegexPatternSetReferenceStatement

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RegexPatternSetReferenceStatement