Interface CfnUserPool.IUserAttributeUpdateSettingsProperty
The settings for updates to user attributes.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnUserPool.IUserAttributeUpdateSettingsPropertySyntax (vb)
Public Interface CfnUserPool.IUserAttributeUpdateSettingsPropertyRemarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var userAttributeUpdateSettingsProperty = new UserAttributeUpdateSettingsProperty {
AttributesRequireVerificationBeforeUpdate = new [] { "attributesRequireVerificationBeforeUpdate" }
};Synopsis
Properties
| AttributesRequireVerificationBeforeUpdate | Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute. |
Properties
AttributesRequireVerificationBeforeUpdate
Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.
string[] AttributesRequireVerificationBeforeUpdate { get; }Property Value
string[]
Remarks
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.
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.