Struct aws_sdk_cognitoidentityprovider::types::builders::UserAttributeUpdateSettingsTypeBuilder

#[non_exhaustive]
pub struct UserAttributeUpdateSettingsTypeBuilder { /* private fields */ }

A builder for UserAttributeUpdateSettingsType.

Implementations

impl UserAttributeUpdateSettingsTypeBuilder

pub fn attributes_require_verification_before_update( self, input: VerifiedAttributeType ) -> Self

Appends an item to attributes_require_verification_before_update.

To override the contents of this collection use set_attributes_require_verification_before_update.

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.

pub fn set_attributes_require_verification_before_update( self, input: Option<Vec<VerifiedAttributeType>> ) -> Self

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.

pub fn get_attributes_require_verification_before_update( &self ) -> &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.

pub fn build(self) -> UserAttributeUpdateSettingsType

Consumes the builder and constructs a UserAttributeUpdateSettingsType.

Trait Implementations

impl Clone for UserAttributeUpdateSettingsTypeBuilder

fn clone(&self) -> UserAttributeUpdateSettingsTypeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserAttributeUpdateSettingsTypeBuilder

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

Formats the value using the given formatter.

impl Default for UserAttributeUpdateSettingsTypeBuilder

fn default() -> UserAttributeUpdateSettingsTypeBuilder

Returns the “default value” for a type.

impl PartialEq for UserAttributeUpdateSettingsTypeBuilder

fn eq(&self, other: &UserAttributeUpdateSettingsTypeBuilder) -> 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 UserAttributeUpdateSettingsTypeBuilder