Package software.amazon.awscdk.services.cognito

Enum Class VerificationEmailStyle

java.lang.Object

java.lang.Enum<VerificationEmailStyle>

software.amazon.awscdk.services.cognito.VerificationEmailStyle

All Implemented Interfaces:

Serializable, Comparable<VerificationEmailStyle>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.654Z")
@Stability(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();
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CODE

@Stability(Stable)
public static final VerificationEmailStyle CODE

Verify email via code.

LINK

@Stability(Stable)
public static final VerificationEmailStyle LINK

Verify email via link.

Method Details

values

public static VerificationEmailStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static VerificationEmailStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null