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

Description

Synopsis

Documentation

data VerificationMessageTemplateType Source #

The template for verification messages.

See: newVerificationMessageTemplateType smart constructor.

Constructors

VerificationMessageTemplateType'

Fields

defaultEmailOption :: Maybe DefaultEmailOptionType
The default email option.
emailMessage :: Maybe Text
The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
emailMessageByLink :: Maybe Text
The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
emailSubject :: Maybe Text
The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
emailSubjectByLink :: Maybe Text
The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
smsMessage :: Maybe Text
The template for SMS messages that Amazon Cognito sends to your users.

Instances

Instances details

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

newVerificationMessageTemplateType :: VerificationMessageTemplateType Source #

Create a value of VerificationMessageTemplateType 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:defaultEmailOption:VerificationMessageTemplateType', verificationMessageTemplateType_defaultEmailOption - The default email option.

$sel:emailMessage:VerificationMessageTemplateType', verificationMessageTemplateType_emailMessage - The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

$sel:emailMessageByLink:VerificationMessageTemplateType', verificationMessageTemplateType_emailMessageByLink - The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

$sel:emailSubject:VerificationMessageTemplateType', verificationMessageTemplateType_emailSubject - The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

$sel:emailSubjectByLink:VerificationMessageTemplateType', verificationMessageTemplateType_emailSubjectByLink - The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

$sel:smsMessage:VerificationMessageTemplateType', verificationMessageTemplateType_smsMessage - The template for SMS messages that Amazon Cognito sends to your users.

verificationMessageTemplateType_defaultEmailOption :: Lens' VerificationMessageTemplateType (Maybe DefaultEmailOptionType) Source #

The default email option.

verificationMessageTemplateType_emailMessage :: Lens' VerificationMessageTemplateType (Maybe Text) Source #

The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

verificationMessageTemplateType_emailMessageByLink :: Lens' VerificationMessageTemplateType (Maybe Text) Source #

The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

verificationMessageTemplateType_emailSubject :: Lens' VerificationMessageTemplateType (Maybe Text) Source #

The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

verificationMessageTemplateType_emailSubjectByLink :: Lens' VerificationMessageTemplateType (Maybe Text) Source #

The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

verificationMessageTemplateType_smsMessage :: Lens' VerificationMessageTemplateType (Maybe Text) Source #

The template for SMS messages that Amazon Cognito sends to your users.