DeviceConfigurationProperty Struct
The device-remembering configuration for a user pool.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const deviceConfigurationProperty: cognito.CfnUserPool.DeviceConfigurationProperty = {
challengeRequiredOnNewDevice: false,
deviceOnlyRememberedOnUserPrompt: false,
};
Properties
challengeRequiredOnNewDeviceboolean | IResolvablechallenge_required_on_new_devicetyping.Union[bool, IResolvable]challengeRequiredOnNewDeviceBooleanChallengeRequiredOnNewDeviceboolChallengeRequiredOnNewDeviceinterface{}#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
ChallengeRequiredOnNewDeviceis 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.
deviceOnlyRememberedOnUserPromptboolean | IResolvabledevice_only_remembered_on_user_prompttyping.Union[bool, IResolvable]deviceOnlyRememberedOnUserPromptBooleanDeviceOnlyRememberedOnUserPromptboolDeviceOnlyRememberedOnUserPromptinterface{}#When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a `ConfirmDevice` API request.
notes
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 API request.
When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.