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

Class AdminSetUserMfaPreferenceRequest

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.AdminSetUserMfaPreferenceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AdminSetUserMfaPreferenceRequest.Builder,AdminSetUserMfaPreferenceRequest>
@Generated("software.amazon.awssdk:codegen") public final class AdminSetUserMfaPreferenceRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<AdminSetUserMfaPreferenceRequest.Builder,AdminSetUserMfaPreferenceRequest>

  • Method Details

    • 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.

      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.

    • 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.

    • webAuthnMfaSettings

      public final WebAuthnMfaSettingsType webAuthnMfaSettings()

      User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the FactorConfiguration of your user pool WebAuthnConfiguration must be MULTI_FACTOR_WITH_USER_VERIFICATION. To activate this setting, your user pool must be in the Essentials tier or higher.

      Returns:
      User preferences for passkey MFA. Activates or deactivates passkey MFA for the user. When activated, passkey authentication requires user verification, and passkey sign-in is available when MFA is required. To activate this setting, the FactorConfiguration of your user pool WebAuthnConfiguration must be MULTI_FACTOR_WITH_USER_VERIFICATION. To activate this setting, your user pool must be in the Essentials tier or higher.

    • username

      public final String username()

      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

      Returns:
      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where you want to set a user's MFA preferences.

      Returns:
      The ID of the user pool where you want to set a user's MFA preferences.

    • toBuilder

      public AdminSetUserMfaPreferenceRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<AdminSetUserMfaPreferenceRequest.Builder,AdminSetUserMfaPreferenceRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest

    • builder

      public static AdminSetUserMfaPreferenceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AdminSetUserMfaPreferenceRequest.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