software.amazon.awscdk.services.cognito

Class CfnUserPool.UserAttributeUpdateSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPool.UserAttributeUpdateSettingsProperty.Builder

Enclosing interface:

CfnUserPool.UserAttributeUpdateSettingsProperty

public static final class CfnUserPool.UserAttributeUpdateSettingsProperty.Builder
extends java.lang.Object

A builder for CfnUserPool.UserAttributeUpdateSettingsProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnUserPool.UserAttributeUpdateSettingsProperty.Builder	attributesRequireVerificationBeforeUpdate(java.util.List<java.lang.String> attributesRequireVerificationBeforeUpdate) Sets the value of CfnUserPool.UserAttributeUpdateSettingsProperty.getAttributesRequireVerificationBeforeUpdate()
CfnUserPool.UserAttributeUpdateSettingsProperty	build() Builds the configured instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

attributesRequireVerificationBeforeUpdate

public CfnUserPool.UserAttributeUpdateSettingsProperty.Builder attributesRequireVerificationBeforeUpdate(java.util.List<java.lang.String> attributesRequireVerificationBeforeUpdate)

Sets the value of CfnUserPool.UserAttributeUpdateSettingsProperty.getAttributesRequireVerificationBeforeUpdate()

Parameters:

attributesRequireVerificationBeforeUpdate - Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. This parameter is required. When you update a user attribute that has this option activated, Amazon Cognito sends a verification message to the new phone number or email address. Amazon Cognito doesn’t change the value of the attribute until your user responds to the verification message and confirms the new value.

You can verify an updated email address or phone number with a VerifyUserAttribute API request. You can also call the AdminUpdateUserAttributes API and set email_verified or phone_number_verified to true.

When AttributesRequireVerificationBeforeUpdate is false, your user pool doesn't require that your users verify attribute changes before Amazon Cognito updates them. In a user pool where AttributesRequireVerificationBeforeUpdate is false, API operations that change attribute values can immediately update a user’s email or phone_number attribute.

Returns:

this

build

public CfnUserPool.UserAttributeUpdateSettingsProperty build()

Builds the configured instance.

Returns:

a new instance of CfnUserPool.UserAttributeUpdateSettingsProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided