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.CognitoIdentityProvider.Types.SmsMfaConfigType

Description

Documentation

data SmsMfaConfigType Source #

The SMS text message multi-factor authentication (MFA) configuration type.

See: newSmsMfaConfigType smart constructor.

Constructors

SmsMfaConfigType'

Fields

smsAuthenticationMessage :: Maybe Text
The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.
smsConfiguration :: Maybe SmsConfigurationType
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

Instances

Instances details

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

newSmsMfaConfigType :: SmsMfaConfigType Source #

Create a value of SmsMfaConfigType 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:smsAuthenticationMessage:SmsMfaConfigType', smsMfaConfigType_smsAuthenticationMessage - The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

$sel:smsConfiguration:SmsMfaConfigType', smsMfaConfigType_smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.

smsMfaConfigType_smsAuthenticationMessage :: Lens' SmsMfaConfigType (Maybe Text) Source #

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

smsMfaConfigType_smsConfiguration :: Lens' SmsMfaConfigType (Maybe SmsConfigurationType) Source #

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.