libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Description

 
Synopsis

Documentation

data SoftwareTokenMfaSettingsType Source #

The type used for enabling software token MFA at the user level. 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: newSoftwareTokenMfaSettingsType smart constructor.

Constructors

SoftwareTokenMfaSettingsType' 

Fields

  • enabled :: Maybe Bool

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

Instances

Instances details
Eq SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Read SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Show SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Generic SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Associated Types

type Rep SoftwareTokenMfaSettingsType :: Type -> Type #

NFData SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

Hashable SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

ToJSON SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

type Rep SoftwareTokenMfaSettingsType Source # 
Instance details

Defined in Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType

type Rep SoftwareTokenMfaSettingsType = D1 ('MetaData "SoftwareTokenMfaSettingsType" "Amazonka.CognitoIdentityProvider.Types.SoftwareTokenMfaSettingsType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" '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 Source #

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 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:SoftwareTokenMfaSettingsType', softwareTokenMfaSettingsType_preferredMfa - Specifies whether software token MFA is the preferred MFA method.

softwareTokenMfaSettingsType_enabled :: Lens' SoftwareTokenMfaSettingsType (Maybe Bool) Source #

Specifies whether software token 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.

softwareTokenMfaSettingsType_preferredMfa :: Lens' SoftwareTokenMfaSettingsType (Maybe Bool) Source #

Specifies whether software token MFA is the preferred MFA method.