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

Description

Documentation

data ManagedRuleGroupConfig Source #

Additional information that's used by a managed rule group. Many managed rule groups don't require this.

Use the AWSManagedRulesBotControlRuleSet configuration object to configure the protection level that you want the Bot Control rule group to use.

For example specifications, see the examples section of CreateWebACL.

See: newManagedRuleGroupConfig smart constructor.

Constructors

ManagedRuleGroupConfig'

Fields

aWSManagedRulesBotControlRuleSet :: Maybe AWSManagedRulesBotControlRuleSet
Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.
loginPath :: Maybe Text
The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.
passwordField :: Maybe PasswordField
Details about your login page password field.
payloadType :: Maybe PayloadType
The payload type for your login endpoint, either JSON or form encoded.
usernameField :: Maybe UsernameField
Details about your login page username field.

Instances

Instances details

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

newManagedRuleGroupConfig :: ManagedRuleGroupConfig Source #

Create a value of ManagedRuleGroupConfig 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:aWSManagedRulesBotControlRuleSet:ManagedRuleGroupConfig', managedRuleGroupConfig_aWSManagedRulesBotControlRuleSet - Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

$sel:loginPath:ManagedRuleGroupConfig', managedRuleGroupConfig_loginPath - The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.

$sel:passwordField:ManagedRuleGroupConfig', managedRuleGroupConfig_passwordField - Details about your login page password field.

$sel:payloadType:ManagedRuleGroupConfig', managedRuleGroupConfig_payloadType - The payload type for your login endpoint, either JSON or form encoded.

$sel:usernameField:ManagedRuleGroupConfig', managedRuleGroupConfig_usernameField - Details about your login page username field.

managedRuleGroupConfig_aWSManagedRulesBotControlRuleSet :: Lens' ManagedRuleGroupConfig (Maybe AWSManagedRulesBotControlRuleSet) Source #

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.

managedRuleGroupConfig_loginPath :: Lens' ManagedRuleGroupConfig (Maybe Text) Source #

The path of the login endpoint for your application. For example, for the URL https://example.com/web/login, you would provide the path /web/login.

managedRuleGroupConfig_passwordField :: Lens' ManagedRuleGroupConfig (Maybe PasswordField) Source #

Details about your login page password field.

managedRuleGroupConfig_payloadType :: Lens' ManagedRuleGroupConfig (Maybe PayloadType) Source #

The payload type for your login endpoint, either JSON or form encoded.

managedRuleGroupConfig_usernameField :: Lens' ManagedRuleGroupConfig (Maybe UsernameField) Source #

Details about your login page username field.