#[non_exhaustive]pub struct UserAttributeUpdateSettingsType {
pub attributes_require_verification_before_update: Option<Vec<VerifiedAttributeType>>,
}
Expand description
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)§
This struct is marked as non-exhaustive
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§
source§impl UserAttributeUpdateSettingsType
impl UserAttributeUpdateSettingsType
sourcepub fn attributes_require_verification_before_update(
&self,
) -> &[VerifiedAttributeType]
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()
.
source§impl UserAttributeUpdateSettingsType
impl UserAttributeUpdateSettingsType
sourcepub fn builder() -> UserAttributeUpdateSettingsTypeBuilder
pub fn builder() -> UserAttributeUpdateSettingsTypeBuilder
Creates a new builder-style object to manufacture UserAttributeUpdateSettingsType
.
Trait Implementations§
source§impl Clone for UserAttributeUpdateSettingsType
impl Clone for UserAttributeUpdateSettingsType
source§fn clone(&self) -> UserAttributeUpdateSettingsType
fn clone(&self) -> UserAttributeUpdateSettingsType
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for UserAttributeUpdateSettingsType
impl PartialEq for UserAttributeUpdateSettingsType
source§fn eq(&self, other: &UserAttributeUpdateSettingsType) -> bool
fn eq(&self, other: &UserAttributeUpdateSettingsType) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UserAttributeUpdateSettingsType
Auto Trait Implementations§
impl Freeze for UserAttributeUpdateSettingsType
impl RefUnwindSafe for UserAttributeUpdateSettingsType
impl Send for UserAttributeUpdateSettingsType
impl Sync for UserAttributeUpdateSettingsType
impl Unpin for UserAttributeUpdateSettingsType
impl UnwindSafe for UserAttributeUpdateSettingsType
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more