Struct aws_sdk_cognitoidentityprovider::operation::set_user_pool_mfa_config::builders::SetUserPoolMfaConfigFluentBuilder

pub struct SetUserPoolMfaConfigFluentBuilder { /* private fields */ }

Fluent builder constructing a request to SetUserPoolMfaConfig.

Sets the user pool multi-factor authentication (MFA) configuration.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Implementations

impl SetUserPoolMfaConfigFluentBuilder

pub fn as_input(&self) -> &SetUserPoolMfaConfigInputBuilder

Access the SetUserPoolMfaConfig as a reference.

pub async fn send( self, ) -> Result<SetUserPoolMfaConfigOutput, SdkError<SetUserPoolMfaConfigError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<SetUserPoolMfaConfigOutput, SetUserPoolMfaConfigError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn user_pool_id(self, input: impl Into<String>) -> Self

The user pool ID.

pub fn set_user_pool_id(self, input: Option<String>) -> Self

The user pool ID.

pub fn get_user_pool_id(&self) -> &Option<String>

The user pool ID.

pub fn sms_mfa_configuration(self, input: SmsMfaConfigType) -> Self

The SMS text message MFA configuration.

pub fn set_sms_mfa_configuration(self, input: Option<SmsMfaConfigType>) -> Self

The SMS text message MFA configuration.

pub fn get_sms_mfa_configuration(&self) -> &Option<SmsMfaConfigType>

The SMS text message MFA configuration.

pub fn software_token_mfa_configuration( self, input: SoftwareTokenMfaConfigType, ) -> Self

The software token MFA configuration.

pub fn set_software_token_mfa_configuration( self, input: Option<SoftwareTokenMfaConfigType>, ) -> Self

The software token MFA configuration.

pub fn get_software_token_mfa_configuration( &self, ) -> &Option<SoftwareTokenMfaConfigType>

The software token MFA configuration.

pub fn mfa_configuration(self, input: UserPoolMfaType) -> Self

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

pub fn set_mfa_configuration(self, input: Option<UserPoolMfaType>) -> Self

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

pub fn get_mfa_configuration(&self) -> &Option<UserPoolMfaType>

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Trait Implementations

impl Clone for SetUserPoolMfaConfigFluentBuilder

fn clone(&self) -> SetUserPoolMfaConfigFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetUserPoolMfaConfigFluentBuilder

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

Formats the value using the given formatter.