Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Documentation
data GeoMatchStatement Source #
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
- To manage requests only by country, you can use this statement by
itself and specify the countries that you want to match against in
the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
WAF labels requests using the alpha-2 country and region codes from the
International Organization for Standardization (ISO) 3166 standard. WAF
determines the codes using either the IP address in the web request
origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.
If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
and
awswaf:clientip:geo:country:<ISO country code>
.
If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
and awswaf:forwardedip:geo:country:<ISO country code>
.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
See: newGeoMatchStatement
smart constructor.
GeoMatchStatement' | |
|
Instances
newGeoMatchStatement :: GeoMatchStatement Source #
Create a value of GeoMatchStatement
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:countryCodes:GeoMatchStatement'
, geoMatchStatement_countryCodes
- An array of two-character country codes that you want to match against,
for example, [ "US", "CN" ]
, from the alpha-2 country ISO codes of
the ISO 3166 international standard.
When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
$sel:forwardedIPConfig:GeoMatchStatement'
, geoMatchStatement_forwardedIPConfig
- 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.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
geoMatchStatement_countryCodes :: Lens' GeoMatchStatement (Maybe (NonEmpty CountryCode)) Source #
An array of two-character country codes that you want to match against,
for example, [ "US", "CN" ]
, from the alpha-2 country ISO codes of
the ISO 3166 international standard.
When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
geoMatchStatement_forwardedIPConfig :: Lens' GeoMatchStatement (Maybe ForwardedIPConfig) Source #
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.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.