Class SmsMfaConfigType
- java.lang.Object
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.SmsMfaConfigType
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SmsMfaConfigType.Builder,SmsMfaConfigType>
@Generated("software.amazon.awssdk:codegen") public final class SmsMfaConfigType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SmsMfaConfigType.Builder,SmsMfaConfigType>
The SMS text message multi-factor authentication (MFA) configuration type.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SmsMfaConfigType.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SmsMfaConfigType.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends SmsMfaConfigType.Builder>
serializableBuilderClass()
String
smsAuthenticationMessage()
The SMS authentication message that will be sent to users with the code they must sign in.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.SmsMfaConfigType.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
smsAuthenticationMessage
public final 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:
- 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.
-
smsConfiguration
public final 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:
- 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.
-
toBuilder
public SmsMfaConfigType.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SmsMfaConfigType.Builder,SmsMfaConfigType>
-
builder
public static SmsMfaConfigType.Builder builder()
-
serializableBuilderClass
public static Class<? extends SmsMfaConfigType.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-