com.amazonaws.services.cognitoidp.model

Class DeviceConfigurationType

java.lang.Object

com.amazonaws.services.cognitoidp.model.DeviceConfigurationType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeviceConfigurationType
extends Object
implements Serializable, Cloneable, StructuredPojo

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceConfigurationType()

Method Summary

Modifier and Type	Method and Description
DeviceConfigurationType	clone()
boolean	equals(Object obj)
Boolean	getChallengeRequiredOnNewDevice() When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Boolean	getDeviceOnlyRememberedOnUserPrompt() When true, Amazon Cognito doesn't remember newly-confirmed devices.
int	hashCode()
Boolean	isChallengeRequiredOnNewDevice() When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
Boolean	isDeviceOnlyRememberedOnUserPrompt() When true, Amazon Cognito doesn't remember newly-confirmed devices.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice) When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
void	setDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt) When true, Amazon Cognito doesn't remember newly-confirmed devices.
String	toString() Returns a string representation of this object.
DeviceConfigurationType	withChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice) When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
DeviceConfigurationType	withDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt) When true, Amazon Cognito doesn't remember newly-confirmed devices.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceConfigurationType

public DeviceConfigurationType()

Method Detail

setChallengeRequiredOnNewDevice

public void setChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)

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

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

Parameters:

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

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

getChallengeRequiredOnNewDevice

public Boolean getChallengeRequiredOnNewDevice()

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

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if 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).

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

withChallengeRequiredOnNewDevice

public DeviceConfigurationType withChallengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)

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

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

Parameters:

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

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

Returns:

Returns a reference to this object so that method calls can be chained together.

isChallengeRequiredOnNewDevice

public Boolean isChallengeRequiredOnNewDevice()

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

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if 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).

Regardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.

setDeviceOnlyRememberedOnUserPrompt

public void setDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

Parameters:

deviceOnlyRememberedOnUserPrompt - When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

getDeviceOnlyRememberedOnUserPrompt

public Boolean getDeviceOnlyRememberedOnUserPrompt()

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

Returns:

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

withDeviceOnlyRememberedOnUserPrompt

public DeviceConfigurationType withDeviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

Parameters:

deviceOnlyRememberedOnUserPrompt - When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDeviceOnlyRememberedOnUserPrompt

public Boolean isDeviceOnlyRememberedOnUserPrompt()

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

Returns:

When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device can instead opt in to remembering their device. To collect a choice from your user, create an input prompt in your app and return the value that the user chooses in an UpdateDeviceStatus API request.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeviceConfigurationType clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo