AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SetUserPoolMfaConfig operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.SetUserPoolMfaConfigRequest

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C# 
public class SetUserPoolMfaConfigRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The SetUserPoolMfaConfigRequest type exposes the following members

Constructors

NameDescription
Public Method SetUserPoolMfaConfigRequest()

Properties

NameTypeDescription
Public Property MfaConfiguration Amazon.CognitoIdentityProvider.UserPoolMfaType

Gets and sets the property MfaConfiguration.

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.

Public Property SmsMfaConfiguration Amazon.CognitoIdentityProvider.Model.SmsMfaConfigType

Gets and sets the property SmsMfaConfiguration.

The SMS text message MFA configuration.

Public Property SoftwareTokenMfaConfiguration Amazon.CognitoIdentityProvider.Model.SoftwareTokenMfaConfigType

Gets and sets the property SoftwareTokenMfaConfiguration.

The software token MFA configuration.

Public Property UserPoolId System.String

Gets and sets the property UserPoolId.

The user pool ID.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5