Struct aws_sdk_cognitoidentityprovider::types::UserAttributeUpdateSettingsType

#[non_exhaustive]
pub struct UserAttributeUpdateSettingsType {
    pub attributes_require_verification_before_update: Option<Vec<VerifiedAttributeType>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

attributes_require_verification_before_update: Option<Vec<VerifiedAttributeType>>

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.

Implementations

impl UserAttributeUpdateSettingsType

pub fn attributes_require_verification_before_update( &self ) -> &[VerifiedAttributeType]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .attributes_require_verification_before_update.is_none().

impl UserAttributeUpdateSettingsType

pub fn builder() -> UserAttributeUpdateSettingsTypeBuilder

Creates a new builder-style object to manufacture UserAttributeUpdateSettingsType.

Trait Implementations

impl Clone for UserAttributeUpdateSettingsType

fn clone(&self) -> UserAttributeUpdateSettingsType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserAttributeUpdateSettingsType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UserAttributeUpdateSettingsType

fn eq(&self, other: &UserAttributeUpdateSettingsType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserAttributeUpdateSettingsType