SmsMfaConfigType - Amazon Cognito User Pools

SmsMfaConfigType

The SMS text message multi-factor authentication (MFA) configuration type.

Contents

SmsAuthenticationMessage

The SMS authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 140.

Pattern: .*\{####\}.*

Required: No

SmsConfiguration

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your AWS account through Amazon Simple Notification Service. To request Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role that you provide for your AWS account.

Type: SmsConfigurationType object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: