UserVerificationConfig¶
-
class
aws_cdk.aws_cognito.
UserVerificationConfig
(*, email_body=None, email_style=None, email_subject=None, sms_message=None)¶ Bases:
object
User pool configuration for user self sign up.
- Parameters
email_body (
Optional
[str
]) – The email body template for the verification email sent to the user upon sign up. See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates. Default: - ‘The verification code to your new account is {####}’ if VerificationEmailStyle.CODE is chosen, ‘Verify your account by clicking on {##Verify Email##}’ if VerificationEmailStyle.LINK is chosen.email_style (
Optional
[VerificationEmailStyle
]) – Emails can be verified either using a code or a link. Learn more at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-email-verification-message-customization.html Default: VerificationEmailStyle.CODEemail_subject (
Optional
[str
]) – The email subject template for the verification email sent to the user upon sign up. See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates. Default: ‘Verify your new account’sms_message (
Optional
[str
]) – The message template for the verification SMS sent to the user upon sign up. See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates. Default: - ‘The verification code to your new account is {####}’ if VerificationEmailStyle.CODE is chosen, not configured if VerificationEmailStyle.LINK is chosen
Attributes
-
email_body
¶ The email body template for the verification email sent to the user upon sign up.
See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.
- Default
‘The verification code to your new account is {####}’ if VerificationEmailStyle.CODE is chosen,
‘Verify your account by clicking on {##Verify Email##}’ if VerificationEmailStyle.LINK is chosen.
- Return type
Optional
[str
]
-
email_style
¶ Emails can be verified either using a code or a link.
- Default
VerificationEmailStyle.CODE
- Return type
Optional
[VerificationEmailStyle
]
-
email_subject
¶ The email subject template for the verification email sent to the user upon sign up.
See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.
- Default
‘Verify your new account’
- Return type
Optional
[str
]
-
sms_message
¶ The message template for the verification SMS sent to the user upon sign up.
See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.
- Default
‘The verification code to your new account is {####}’ if VerificationEmailStyle.CODE is chosen,
not configured if VerificationEmailStyle.LINK is chosen
- Return type
Optional
[str
]