com.amazonaws.services.cognitoidentityprovider.model

Class SmsMfaConfigType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.SmsMfaConfigType

All Implemented Interfaces:

java.io.Serializable

public class SmsMfaConfigType
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SmsMfaConfigType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getSmsAuthenticationMessage() The SMS authentication message that will be sent to users with the code they must sign in.
SmsConfigurationType	getSmsConfiguration() The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
int	hashCode()
void	setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage) The SMS authentication message that will be sent to users with the code they must sign in.
void	setSmsConfiguration(SmsConfigurationType smsConfiguration) The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SmsMfaConfigType	withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage) The SMS authentication message that will be sent to users with the code they must sign in.
SmsMfaConfigType	withSmsConfiguration(SmsConfigurationType smsConfiguration) The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SmsMfaConfigType

public SmsMfaConfigType()

Method Detail

getSmsAuthenticationMessage

public java.lang.String getSmsAuthenticationMessage()

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.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

Returns:

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.

setSmsAuthenticationMessage

public void setSmsAuthenticationMessage(java.lang.String 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.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

Parameters:

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.

withSmsAuthenticationMessage

public SmsMfaConfigType withSmsAuthenticationMessage(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getSmsConfiguration

public SmsConfigurationType getSmsConfiguration()

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

Returns:

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

setSmsConfiguration

public void setSmsConfiguration(SmsConfigurationType smsConfiguration)

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

Parameters:

smsConfiguration -

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

withSmsConfiguration

public SmsMfaConfigType withSmsConfiguration(SmsConfigurationType smsConfiguration)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

smsConfiguration -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object