Struct rusoto_cognito_idp::UpdateUserPoolRequest

pub struct UpdateUserPoolRequest {

    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>,
}

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.

user_pool_tags: Option<HashMap<String, String>>

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

impl Clone for UpdateUserPoolRequest

fn clone(&self) -> UpdateUserPoolRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserPoolRequest

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

Formats the value using the given formatter.

impl Default for UpdateUserPoolRequest

fn default() -> UpdateUserPoolRequest

Returns the “default value” for a type.

impl PartialEq<UpdateUserPoolRequest> for UpdateUserPoolRequest

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

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

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

This method tests for !=.

impl Serialize for UpdateUserPoolRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UpdateUserPoolRequest