AWS::WAFv2::RuleGroup IPSetReferenceStatement

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an AWS::WAFv2::IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement.

Each IP set rule statement references an IP 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, AWS WAF automatically updates all rules that reference it.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Arn" : String,
  "IPSetForwardedIPConfig" : IPSetForwardedIPConfiguration
}

YAML

  Arn: String
  IPSetForwardedIPConfig: 
    IPSetForwardedIPConfiguration

Properties

Arn

The Amazon Resource Name (ARN) of the AWS::WAFv2::IPSet that this statement references.

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: No interruption

IPSetForwardedIPConfig

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

Note

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

Required: No

Type: IPSetForwardedIPConfiguration

Update requires: No interruption