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

Class DeviceConfigurationType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.DeviceConfigurationType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DeviceConfigurationType.Builder,DeviceConfigurationType>
@Generated("software.amazon.awssdk:codegen") public final class DeviceConfigurationType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DeviceConfigurationType.Builder,DeviceConfigurationType>

The device-remembering configuration for a user pool.

When you provide a value for any property of DeviceConfiguration, you activate the device remembering for the user pool.

See Also:

  • Method Details

    • challengeRequiredOnNewDevice

      public final Boolean challengeRequiredOnNewDevice()

      When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

      Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

      Returns:
      When true, a remembered device can sign in with device authentication instead of SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

      Whether or not ChallengeRequiredOnNewDevice is true, users who sign in with devices that have not been confirmed or remembered must still provide a second factor in a user pool that requires MFA.

    • deviceOnlyRememberedOnUserPrompt

      public final Boolean deviceOnlyRememberedOnUserPrompt()

      When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

      When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

      Returns:
      When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request. In your app, create a prompt for your user to choose whether they want to remember their device. Return the user's choice in an UpdateDeviceStatus API request.

      When DeviceOnlyRememberedOnUserPrompt is false, Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

    • toBuilder

      public DeviceConfigurationType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeviceConfigurationType.Builder,DeviceConfigurationType>

    • builder

      public static DeviceConfigurationType.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

    • 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