Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Documentation

data SoftwareTokenMfaSettingsType

The type used for enabling software token MFA at the user level. If an MFA type is activated 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 want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

See: newSoftwareTokenMfaSettingsType smart constructor.

Constructors

SoftwareTokenMfaSettingsType'

Fields

• enabled :: Maybe Bool

  Specifies whether software token MFA is activated. If an MFA type is activated 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 software token MFA is the preferred MFA method.

Instances

ToJSON SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Methods

toJSON :: SoftwareTokenMfaSettingsType -> Value

toEncoding :: SoftwareTokenMfaSettingsType -> Encoding

toJSONList :: [SoftwareTokenMfaSettingsType] -> Value

toEncodingList :: [SoftwareTokenMfaSettingsType] -> Encoding

Generic SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Associated Types

type Rep SoftwareTokenMfaSettingsType :: Type -> Type

Methods

from :: SoftwareTokenMfaSettingsType -> Rep SoftwareTokenMfaSettingsType x

to :: Rep SoftwareTokenMfaSettingsType x -> SoftwareTokenMfaSettingsType

Read SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Methods

readsPrec :: Int -> ReadS SoftwareTokenMfaSettingsType

readList :: ReadS [SoftwareTokenMfaSettingsType]

readPrec :: ReadPrec SoftwareTokenMfaSettingsType

readListPrec :: ReadPrec [SoftwareTokenMfaSettingsType]

Show SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Methods

showsPrec :: Int -> SoftwareTokenMfaSettingsType -> ShowS

show :: SoftwareTokenMfaSettingsType -> String

showList :: [SoftwareTokenMfaSettingsType] -> ShowS

NFData SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Methods

rnf :: SoftwareTokenMfaSettingsType -> ()

Eq SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Methods

(==) :: SoftwareTokenMfaSettingsType -> SoftwareTokenMfaSettingsType -> Bool

(/=) :: SoftwareTokenMfaSettingsType -> SoftwareTokenMfaSettingsType -> Bool

Hashable SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Methods

hashWithSalt :: Int -> SoftwareTokenMfaSettingsType -> Int

hash :: SoftwareTokenMfaSettingsType -> Int

type Rep SoftwareTokenMfaSettingsType

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

type Rep SoftwareTokenMfaSettingsType = D1 ('MetaData "SoftwareTokenMfaSettingsType" "Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "SoftwareTokenMfaSettingsType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "preferredMfa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newSoftwareTokenMfaSettingsType :: SoftwareTokenMfaSettingsType

Create a value of SoftwareTokenMfaSettingsType 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:SoftwareTokenMfaSettingsType', softwareTokenMfaSettingsType_enabled - Specifies whether software token MFA is activated. If an MFA type is activated 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:SoftwareTokenMfaSettingsType', softwareTokenMfaSettingsType_preferredMfa - Specifies whether software token MFA is the preferred MFA method.

softwareTokenMfaSettingsType_enabled :: Lens' SoftwareTokenMfaSettingsType (Maybe Bool)

Specifies whether software token MFA is activated. If an MFA type is activated 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.

softwareTokenMfaSettingsType_preferredMfa :: Lens' SoftwareTokenMfaSettingsType (Maybe Bool)

Specifies whether software token MFA is the preferred MFA method.