Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType

Description

Documentation

data SMSMfaSettingsType Source #

The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.

See: newSMSMfaSettingsType smart constructor.

Constructors

SMSMfaSettingsType'
Fields enabled :: Maybe Bool Specifies whether SMS text message MFA is enabled. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted. preferredMfa :: Maybe Bool Specifies whether SMS is the preferred MFA method.

Instances

Instances details

Eq SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Methods (==) :: SMSMfaSettingsType -> SMSMfaSettingsType -> Bool # (/=) :: SMSMfaSettingsType -> SMSMfaSettingsType -> Bool #
Read SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Methods readsPrec :: Int -> ReadS SMSMfaSettingsType # readList :: ReadS [SMSMfaSettingsType] # readPrec :: ReadPrec SMSMfaSettingsType # readListPrec :: ReadPrec [SMSMfaSettingsType] #
Show SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Methods showsPrec :: Int -> SMSMfaSettingsType -> ShowS # show :: SMSMfaSettingsType -> String # showList :: [SMSMfaSettingsType] -> ShowS #
Generic SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Associated Types type Rep SMSMfaSettingsType :: Type -> Type # Methods from :: SMSMfaSettingsType -> Rep SMSMfaSettingsType x # to :: Rep SMSMfaSettingsType x -> SMSMfaSettingsType #
NFData SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Methods rnf :: SMSMfaSettingsType -> () #
Hashable SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Methods hashWithSalt :: Int -> SMSMfaSettingsType -> Int # hash :: SMSMfaSettingsType -> Int #
ToJSON SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType Methods toJSON :: SMSMfaSettingsType -> Value # toEncoding :: SMSMfaSettingsType -> Encoding # toJSONList :: [SMSMfaSettingsType] -> Value # toEncodingList :: [SMSMfaSettingsType] -> Encoding #
type Rep SMSMfaSettingsType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType type Rep SMSMfaSettingsType = D1 ('MetaData "SMSMfaSettingsType" "Amazonka.CognitoIdentityProvider.Types.SMSMfaSettingsType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "SMSMfaSettingsType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "preferredMfa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newSMSMfaSettingsType :: SMSMfaSettingsType Source #

Create a value of SMSMfaSettingsType 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:enabled:SMSMfaSettingsType', sMSMfaSettingsType_enabled - Specifies whether SMS text message MFA is enabled. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted.

$sel:preferredMfa:SMSMfaSettingsType', sMSMfaSettingsType_preferredMfa - Specifies whether SMS is the preferred MFA method.

sMSMfaSettingsType_enabled :: Lens' SMSMfaSettingsType (Maybe Bool) Source #

Specifies whether SMS text message MFA is enabled. If an MFA type is enabled for a user, the user will be prompted for MFA during all sign in attempts, unless device tracking is turned on and the device has been trusted.

sMSMfaSettingsType_preferredMfa :: Lens' SMSMfaSettingsType (Maybe Bool) Source #

Specifies whether SMS is the preferred MFA method.