Package software.amazon.awscdk.services.cognito

Interface DeviceTracking

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeviceTracking.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:25.575Z")
@Stability(Stable)
public interface DeviceTracking
extends software.amazon.jsii.JsiiSerializable

Device tracking settings.

Example:

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .deviceTracking(DeviceTracking.builder()
                 .challengeRequiredOnNewDevice(true)
                 .deviceOnlyRememberedOnUserPrompt(true)
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DeviceTracking.Builder	builder()
Boolean	getChallengeRequiredOnNewDevice()	Indicates whether a challenge is required on a new device.
Boolean	getDeviceOnlyRememberedOnUserPrompt()	If true, a device is only remembered on user prompt.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChallengeRequiredOnNewDevice

@Stability(Stable)
@NotNull
Boolean getChallengeRequiredOnNewDevice()

Indicates whether a challenge is required on a new device.

Only applicable to a new device.

Default: false

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html

getDeviceOnlyRememberedOnUserPrompt

@Stability(Stable)
@NotNull
Boolean getDeviceOnlyRememberedOnUserPrompt()

If true, a device is only remembered on user prompt.

Default: false

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html

builder

@Stability(Stable)
static DeviceTracking.Builder builder()

Returns:

a DeviceTracking.Builder of DeviceTracking