software.amazon.awscdk.services.cognito

Interface CfnUserPool.DeviceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.DeviceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(value=Stable)
public static interface CfnUserPool.DeviceConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The device-remembering configuration for a user pool.

A DescribeUserPool request returns a null value for this object when the user pool isn't configured to remember devices. When device remembering is active, you can remember a user's device with a ConfirmDevice API request. Additionally. when the property DeviceOnlyRememberedOnUserPrompt is true , you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to remembered or not_remembered .

To sign in with a remembered device, include DEVICE_KEY in the authentication parameters in your user's InitiateAuth request. If your app doesn't include a DEVICE_KEY parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and DEVICE_GROUP_KEY values under NewDeviceMetadata . Store these values to use in future device-authentication requests.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 DeviceConfigurationProperty deviceConfigurationProperty = DeviceConfigurationProperty.builder()
         .challengeRequiredOnNewDevice(false)
         .deviceOnlyRememberedOnUserPrompt(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserPool.DeviceConfigurationProperty.Builder A builder for CfnUserPool.DeviceConfigurationProperty
static class	CfnUserPool.DeviceConfigurationProperty.Jsii$Proxy An implementation for CfnUserPool.DeviceConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnUserPool.DeviceConfigurationProperty.Builder	builder()
default Object	getChallengeRequiredOnNewDevice() 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).
default Object	getDeviceOnlyRememberedOnUserPrompt() When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) API request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChallengeRequiredOnNewDevice

@Stability(value=Stable)
 @Nullable
default Object getChallengeRequiredOnNewDevice()

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.

getDeviceOnlyRememberedOnUserPrompt

@Stability(value=Stable)
 @Nullable
default Object getDeviceOnlyRememberedOnUserPrompt()

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) 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](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request.

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

builder

@Stability(value=Stable)
static CfnUserPool.DeviceConfigurationProperty.Builder builder()

Returns:

a CfnUserPool.DeviceConfigurationProperty.Builder of CfnUserPool.DeviceConfigurationProperty