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

Description

Synopsis

Documentation

data IPSetReferenceStatement Source #

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

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, WAF automatically updates all rules that reference it.

See: newIPSetReferenceStatement smart constructor.

Constructors

IPSetReferenceStatement'

Fields

iPSetForwardedIPConfig :: Maybe 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.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
arn :: Text
The Amazon Resource Name (ARN) of the IPSet that this statement references.

Instances

Instances details

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

newIPSetReferenceStatement Source #

Arguments

:: Text	`$sel:arn:IPSetReferenceStatement'`
-> IPSetReferenceStatement

Create a value of IPSetReferenceStatement 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:iPSetForwardedIPConfig:IPSetReferenceStatement', iPSetReferenceStatement_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.

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

$sel:arn:IPSetReferenceStatement', iPSetReferenceStatement_arn - The Amazon Resource Name (ARN) of the IPSet that this statement references.

iPSetReferenceStatement_iPSetForwardedIPConfig :: Lens' IPSetReferenceStatement (Maybe IPSetForwardedIPConfig) 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.

iPSetReferenceStatement_arn :: Lens' IPSetReferenceStatement Text Source #

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