Struct rusoto_cognito_idp::UpdateUserPoolRequest
source · [−]pub struct UpdateUserPoolRequest {Show 17 fields
pub account_recovery_setting: Option<AccountRecoverySettingType>,
pub admin_create_user_config: Option<AdminCreateUserConfigType>,
pub auto_verified_attributes: Option<Vec<String>>,
pub device_configuration: Option<DeviceConfigurationType>,
pub email_configuration: Option<EmailConfigurationType>,
pub email_verification_message: Option<String>,
pub email_verification_subject: Option<String>,
pub lambda_config: Option<LambdaConfigType>,
pub mfa_configuration: Option<String>,
pub policies: Option<UserPoolPolicyType>,
pub sms_authentication_message: Option<String>,
pub sms_configuration: Option<SmsConfigurationType>,
pub sms_verification_message: Option<String>,
pub user_pool_add_ons: Option<UserPoolAddOnsType>,
pub user_pool_id: String,
pub user_pool_tags: Option<HashMap<String, String>>,
pub verification_message_template: Option<VerificationMessageTemplateType>,
}
Expand description
Represents the request to update the user pool.
Fields
account_recovery_setting: Option<AccountRecoverySettingType>
Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword
. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
admin_create_user_config: Option<AdminCreateUserConfigType>
The configuration for AdminCreateUser
requests.
auto_verified_attributes: Option<Vec<String>>
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
device_configuration: Option<DeviceConfigurationType>
Device configuration.
email_configuration: Option<EmailConfigurationType>
Email configuration.
email_verification_message: Option<String>
The contents of the email verification message.
email_verification_subject: Option<String>
The subject of the email verification message.
lambda_config: Option<LambdaConfigType>
The AWS Lambda configuration information from the request to update the user pool.
mfa_configuration: Option<String>
Can be one of the following values:
-
OFF
- MFA tokens are not required and cannot be specified during user registration. -
ON
- MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools. -
OPTIONAL
- Users have the option when registering to create an MFA token.
policies: Option<UserPoolPolicyType>
A container with the policies you wish to update in a user pool.
sms_authentication_message: Option<String>
The contents of the SMS authentication message.
sms_configuration: Option<SmsConfigurationType>
SMS configuration.
sms_verification_message: Option<String>
A container with information about the SMS verification message.
user_pool_add_ons: Option<UserPoolAddOnsType>
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode
to the value "AUDIT".
user_pool_id: String
The user pool ID for the user pool you want to update.
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
verification_message_template: Option<VerificationMessageTemplateType>
The template for verification messages.
Trait Implementations
sourceimpl Clone for UpdateUserPoolRequest
impl Clone for UpdateUserPoolRequest
sourcefn clone(&self) -> UpdateUserPoolRequest
fn clone(&self) -> UpdateUserPoolRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for UpdateUserPoolRequest
impl Debug for UpdateUserPoolRequest
sourceimpl Default for UpdateUserPoolRequest
impl Default for UpdateUserPoolRequest
sourcefn default() -> UpdateUserPoolRequest
fn default() -> UpdateUserPoolRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<UpdateUserPoolRequest> for UpdateUserPoolRequest
impl PartialEq<UpdateUserPoolRequest> for UpdateUserPoolRequest
sourcefn eq(&self, other: &UpdateUserPoolRequest) -> bool
fn eq(&self, other: &UpdateUserPoolRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &UpdateUserPoolRequest) -> bool
fn ne(&self, other: &UpdateUserPoolRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for UpdateUserPoolRequest
impl Serialize for UpdateUserPoolRequest
impl StructuralPartialEq for UpdateUserPoolRequest
Auto Trait Implementations
impl RefUnwindSafe for UpdateUserPoolRequest
impl Send for UpdateUserPoolRequest
impl Sync for UpdateUserPoolRequest
impl Unpin for UpdateUserPoolRequest
impl UnwindSafe for UpdateUserPoolRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more