Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SetUserMfaPreferenceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.SetUserMfaPreferenceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetUserMfaPreferenceRequest.Builder,SetUserMfaPreferenceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SetUserMfaPreferenceRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<SetUserMfaPreferenceRequest.Builder,SetUserMfaPreferenceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetUserMfaPreferenceRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accessToken()	A valid access token that Amazon Cognito issued to the currently signed-in user.
static SetUserMfaPreferenceRequest.Builder	builder()
EmailMfaSettingsType	emailMfaSettings()	User preferences for email message MFA.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SetUserMfaPreferenceRequest.Builder>	serializableBuilderClass()
SMSMfaSettingsType	smsMfaSettings()	User preferences for SMS message MFA.
SoftwareTokenMfaSettingsType	softwareTokenMfaSettings()	User preferences for time-based one-time password (TOTP) MFA.
SetUserMfaPreferenceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

smsMfaSettings

public final SMSMfaSettingsType smsMfaSettings()

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

Returns:

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

softwareTokenMfaSettings

public final SoftwareTokenMfaSettingsType softwareTokenMfaSettings()

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. Users must register a TOTP authenticator before they set this as their preferred MFA method.

Returns:

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. Users must register a TOTP authenticator before they set this as their preferred MFA method.

emailMfaSettings

public final EmailMfaSettingsType emailMfaSettings()

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

Returns:

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

accessToken

public final String accessToken()

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

toBuilder

public SetUserMfaPreferenceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetUserMfaPreferenceRequest.Builder,SetUserMfaPreferenceRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static SetUserMfaPreferenceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetUserMfaPreferenceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo