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

Amazonka.WAFV2.Types.ForwardedIPConfig

Description

Synopsis

data ForwardedIPConfig = ForwardedIPConfig' {
- headerName :: Text
- fallbackBehavior :: FallbackBehavior
}
newForwardedIPConfig :: Text -> FallbackBehavior -> ForwardedIPConfig
forwardedIPConfig_headerName :: Lens' ForwardedIPConfig Text
forwardedIPConfig_fallbackBehavior :: Lens' ForwardedIPConfig FallbackBehavior

Documentation

data 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.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

WAF only evaluates the first IP address found in the specified HTTP header.

See: newForwardedIPConfig smart constructor.

Constructors

ForwardedIPConfig'

Fields

headerName :: Text
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
fallbackBehavior :: FallbackBehavior
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
- MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
- NO_MATCH - Treat the web request as not matching the rule statement.

Instances

Instances details

FromJSON ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods parseJSON :: Value -> Parser ForwardedIPConfig # parseJSONList :: Value -> Parser [ForwardedIPConfig] #
ToJSON ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods toJSON :: ForwardedIPConfig -> Value # toEncoding :: ForwardedIPConfig -> Encoding # toJSONList :: [ForwardedIPConfig] -> Value # toEncodingList :: [ForwardedIPConfig] -> Encoding #
Generic ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Associated Types type Rep ForwardedIPConfig :: Type -> Type # Methods from :: ForwardedIPConfig -> Rep ForwardedIPConfig x # to :: Rep ForwardedIPConfig x -> ForwardedIPConfig #
Read ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods readsPrec :: Int -> ReadS ForwardedIPConfig # readList :: ReadS [ForwardedIPConfig] # readPrec :: ReadPrec ForwardedIPConfig # readListPrec :: ReadPrec [ForwardedIPConfig] #
Show ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods showsPrec :: Int -> ForwardedIPConfig -> ShowS # show :: ForwardedIPConfig -> String # showList :: [ForwardedIPConfig] -> ShowS #
NFData ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods rnf :: ForwardedIPConfig -> () #
Eq ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods (==) :: ForwardedIPConfig -> ForwardedIPConfig -> Bool # (/=) :: ForwardedIPConfig -> ForwardedIPConfig -> Bool #
Hashable ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig Methods hashWithSalt :: Int -> ForwardedIPConfig -> Int # hash :: ForwardedIPConfig -> Int #
type Rep ForwardedIPConfig Source #
Instance details Defined in Amazonka.WAFV2.Types.ForwardedIPConfig type Rep ForwardedIPConfig = D1 ('MetaData "ForwardedIPConfig" "Amazonka.WAFV2.Types.ForwardedIPConfig" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "ForwardedIPConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fallbackBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FallbackBehavior)))

newForwardedIPConfig Source #

Arguments

:: Text	`$sel:headerName:ForwardedIPConfig'`
-> FallbackBehavior	`$sel:fallbackBehavior:ForwardedIPConfig'`
-> ForwardedIPConfig

Create a value of ForwardedIPConfig 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:headerName:ForwardedIPConfig', forwardedIPConfig_headerName - The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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

$sel:fallbackBehavior:ForwardedIPConfig', forwardedIPConfig_fallbackBehavior - The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.

forwardedIPConfig_headerName :: Lens' ForwardedIPConfig Text Source #

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

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

forwardedIPConfig_fallbackBehavior :: Lens' ForwardedIPConfig FallbackBehavior Source #

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

You can specify the following fallback behaviors:

MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.