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(value="software.amazon.awssdk:codegen")
public final class DeviceConfigurationType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DeviceConfigurationType.Builder,DeviceConfigurationType>

The device tracking configuration for a user pool. A user pool with device tracking deactivated returns a null value.

When you provide values for any DeviceConfiguration field, you activate device tracking.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeviceConfigurationType.Builder

Method Summary

Modifier and Type	Method and Description
static DeviceConfigurationType.Builder	builder()
Boolean	challengeRequiredOnNewDevice() When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Boolean	deviceOnlyRememberedOnUserPrompt() When true, users can opt in to remembering their device.
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 DeviceConfigurationType.Builder>	serializableBuilderClass()
DeviceConfigurationType.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

challengeRequiredOnNewDevice

public final Boolean challengeRequiredOnNewDevice()

When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Users that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA.

Returns:

When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).

Users that sign in with devices that have not been confirmed or remembered will still have to provide a second factor, whether or not ChallengeRequiredOnNewDevice is true, when your user pool requires MFA.

deviceOnlyRememberedOnUserPrompt

public final Boolean deviceOnlyRememberedOnUserPrompt()

When true, users can opt in to remembering their device. Your app code must use callback functions to return the user's choice.

Returns:

When true, users can opt in to remembering their device. Your app code must use callback functions to return the user's choice.

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