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.

The configuration of multi-factor authentication (MFA) with SMS messages in a user pool.

Inheritance Hierarchy

System.Object
  Amazon.CognitoIdentityProvider.Model.SmsMfaConfigType

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

Syntax

C# 
public class SmsMfaConfigType

The SmsMfaConfigType type exposes the following members

Constructors

NameDescription
Public Method SmsMfaConfigType()

Properties

NameTypeDescription
Public Property SmsAuthenticationMessage System.String

Gets and sets the property SmsAuthenticationMessage.

The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.

Public Property SmsConfiguration Amazon.CognitoIdentityProvider.Model.SmsConfigurationType

Gets and sets the property SmsConfiguration.

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5