Class: Aws::CognitoIdentityProvider::Types::UserAttributeUpdateSettingsType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::UserAttributeUpdateSettingsType
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
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].
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attributes_require_verification_before_update ⇒ Array<String>
Requires that your user verifies their email address, phone number, or both before Amazon Cognito updates the value of that attribute.
Instance Attribute Details
#attributes_require_verification_before_update ⇒ Array<String>
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.
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.
11957 11958 11959 11960 11961 |
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 11957 class UserAttributeUpdateSettingsType < Struct.new( :attributes_require_verification_before_update) SENSITIVE = [] include Aws::Structure end |