public static interface CfnUserPool.UserAttributeUpdateSettingsProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnUserPool.UserAttributeUpdateSettingsProperty.Builder
A builder for
CfnUserPool.UserAttributeUpdateSettingsProperty |
static class |
CfnUserPool.UserAttributeUpdateSettingsProperty.Jsii$Proxy
An implementation for
CfnUserPool.UserAttributeUpdateSettingsProperty |
Modifier and Type | Method and Description |
---|---|
static CfnUserPool.UserAttributeUpdateSettingsProperty.Builder |
builder() |
java.util.List<java.lang.String> |
getAttributesRequireVerificationBeforeUpdate()
Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.
|
java.util.List<java.lang.String> getAttributesRequireVerificationBeforeUpdate()
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.
static CfnUserPool.UserAttributeUpdateSettingsProperty.Builder builder()