software.amazon.awscdk.services.cognito

Enum VerificationEmailStyle

java.lang.Object

java.lang.Enum<VerificationEmailStyle>

software.amazon.awscdk.services.cognito.VerificationEmailStyle

All Implemented Interfaces:

Serializable, Comparable<VerificationEmailStyle>

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.659Z")
 @Stability(value=Stable)
public enum VerificationEmailStyle
extends Enum<VerificationEmailStyle>

The email verification style.

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .selfSignUpEnabled(true)
         .userVerification(UserVerificationConfig.builder()
                 .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 {####}")
                 .build())
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE Verify email via code.
LINK Verify email via link.

Method Summary

Modifier and Type	Method and Description
static VerificationEmailStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static VerificationEmailStyle[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CODE

@Stability(value=Stable)
public static final VerificationEmailStyle CODE

Verify email via code.

LINK

@Stability(value=Stable)
public static final VerificationEmailStyle LINK

Verify email via link.

Method Detail

values

public static VerificationEmailStyle[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VerificationEmailStyle c : VerificationEmailStyle.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VerificationEmailStyle valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null