Class UserVerificationConfig

User pool configuration for user self sign up.

Inheritance
System.Object
UserVerificationConfig
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UserVerificationConfig : Object, IUserVerificationConfig
Syntax (vb)
Public Class UserVerificationConfig
    Inherits Object
    Implements IUserVerificationConfig
Remarks

ExampleMetadata: infused

Examples
new UserPool(this, "myuserpool", new UserPoolProps {
    // ...
    SelfSignUpEnabled = true,
    UserVerification = new UserVerificationConfig {
        EmailSubject = "Verify your email for our awesome app!",
        EmailBody = "Thanks for signing up to our awesome app! Your verification code is {####}",
        EmailStyle = VerificationEmailStyle.CODE,
        SmsMessage = "Thanks for signing up to our awesome app! Your verification code is {####}"
    }
});

Synopsis

Constructors

UserVerificationConfig()

Properties

EmailBody

The email body template for the verification email sent to the user upon sign up.
EmailStyle

Emails can be verified either using a code or a link.
EmailSubject

The email subject template for the verification email sent to the user upon sign up.
SmsMessage

The message template for the verification SMS sent to the user upon sign up.

Constructors

UserVerificationConfig()

public UserVerificationConfig()

Properties

EmailBody

The email body template for the verification email sent to the user upon sign up.

public string EmailBody { get; set; }
Property Value

System.String

Remarks

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.

EmailStyle

Emails can be verified either using a code or a link.

public Nullable<VerificationEmailStyle> EmailStyle { get; set; }
Property Value

System.Nullable<VerificationEmailStyle>

Remarks

Learn more at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-email-verification-message-customization.html

Default: VerificationEmailStyle.CODE

EmailSubject

The email subject template for the verification email sent to the user upon sign up.

public string EmailSubject { get; set; }
Property Value

System.String

Remarks

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'

SmsMessage

The message template for the verification SMS sent to the user upon sign up.

public string SmsMessage { get; set; }
Property Value

System.String

Remarks

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

Implements