@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SmsMfaConfigType extends Object implements Serializable, Cloneable, StructuredPojo
The SMS text message multi-factor authentication (MFA) configuration type.
Constructor and Description |
---|
SmsMfaConfigType() |
Modifier and Type | Method and Description |
---|---|
SmsMfaConfigType |
clone() |
boolean |
equals(Object obj) |
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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setSmsAuthenticationMessage(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.
|
String |
toString()
Returns a string representation of this object.
|
SmsMfaConfigType |
withSmsAuthenticationMessage(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.
|
public void setSmsAuthenticationMessage(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.
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.public 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.
public SmsMfaConfigType withSmsAuthenticationMessage(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.
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.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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public SmsMfaConfigType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.