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

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, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
default Object	getDeviceOnlyRememberedOnUserPrompt() When true, users can opt in to remembering their device.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChallengeRequiredOnNewDevice

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

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.

getDeviceOnlyRememberedOnUserPrompt

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

When true, users can opt in to remembering their device.

Your app code must use callback functions to return the user's choice.

builder

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

Returns:

a CfnUserPool.DeviceConfigurationProperty.Builder of CfnUserPool.DeviceConfigurationProperty