Package software.amazon.awscdk.services.cognito

Class AutoVerifiedAttrs.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.AutoVerifiedAttrs.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AutoVerifiedAttrs>

Enclosing interface:

AutoVerifiedAttrs

@Stability(Stable)
public static final class AutoVerifiedAttrs.Builder
extends Object
implements software.amazon.jsii.Builder<AutoVerifiedAttrs>

A builder for AutoVerifiedAttrs

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AutoVerifiedAttrs	build()	Builds the configured instance.
AutoVerifiedAttrs.Builder	email(Boolean email)	Sets the value of AutoVerifiedAttrs.getEmail()
AutoVerifiedAttrs.Builder	phone(Boolean phone)	Sets the value of AutoVerifiedAttrs.getPhone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

email

@Stability(Stable)
public AutoVerifiedAttrs.Builder email(Boolean email)

Sets the value of AutoVerifiedAttrs.getEmail()

Parameters:

email - Whether the email address of the user should be auto verified at sign up. Note: If both email and phone is set, Cognito only verifies the phone number. To also verify email, see here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html

Returns:

this

phone

@Stability(Stable)
public AutoVerifiedAttrs.Builder phone(Boolean phone)

Sets the value of AutoVerifiedAttrs.getPhone()

Parameters:

phone - Whether the phone number of the user should be auto verified at sign up.

Returns:

this

build

@Stability(Stable)
public AutoVerifiedAttrs build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AutoVerifiedAttrs>

Returns:

a new instance of AutoVerifiedAttrs

Throws:

NullPointerException - if any required attribute was not provided