This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Cognito::UserPool DeviceConfiguration
The device-remembering configuration for a user pool.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ChallengeRequiredOnNewDevice" :Boolean, "DeviceOnlyRememberedOnUserPrompt" :Boolean}
YAML
ChallengeRequiredOnNewDevice:BooleanDeviceOnlyRememberedOnUserPrompt:Boolean
Properties
ChallengeRequiredOnNewDevice-
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).
Note
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.Required: No
Type: Boolean
Update requires: No interruption
DeviceOnlyRememberedOnUserPrompt-
When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a
ConfirmDeviceAPI 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 anUpdateDeviceStatusAPI request.When
DeviceOnlyRememberedOnUserPromptisfalse, Amazon Cognito immediately remembers devices that you register in aConfirmDeviceAPI request.Required: No
Type: Boolean
Update requires: No interruption