Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.UserAttributeUpdateSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.UserAttributeUpdateSettingsProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.UserAttributeUpdateSettingsProperty
extends software.amazon.jsii.JsiiSerializable

The settings for updates to user attributes.

These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 UserAttributeUpdateSettingsProperty userAttributeUpdateSettingsProperty = UserAttributeUpdateSettingsProperty.builder()
         .attributesRequireVerificationBeforeUpdate(List.of("attributesRequireVerificationBeforeUpdate"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.UserAttributeUpdateSettingsProperty.Builder	A builder for CfnUserPool.UserAttributeUpdateSettingsProperty
static final class	CfnUserPool.UserAttributeUpdateSettingsProperty.Jsii$Proxy	An implementation for CfnUserPool.UserAttributeUpdateSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.UserAttributeUpdateSettingsProperty.Builder	builder()
List<String>	getAttributesRequireVerificationBeforeUpdate()	Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributesRequireVerificationBeforeUpdate

@Stability(Stable)
@NotNull
List<String> getAttributesRequireVerificationBeforeUpdate()

Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.

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.

builder

@Stability(Stable)
static CfnUserPool.UserAttributeUpdateSettingsProperty.Builder builder()

Returns:

a CfnUserPool.UserAttributeUpdateSettingsProperty.Builder of CfnUserPool.UserAttributeUpdateSettingsProperty