interface DeviceConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnUserPoolPropsMixin.DeviceConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnUserPoolPropsMixin_DeviceConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnUserPoolPropsMixin.DeviceConfigurationProperty
Python	aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolPropsMixin.DeviceConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_cognito » mixins » CfnUserPoolPropsMixin » DeviceConfigurationProperty

The device-remembering configuration for a user pool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const deviceConfigurationProperty: cognito_mixins.CfnUserPoolPropsMixin.DeviceConfigurationProperty = {
  challengeRequiredOnNewDevice: false,
  deviceOnlyRememberedOnUserPrompt: false,
};

Properties

Name	Type	Description
challengeRequiredOnNewDevice?	boolean | IResolvable	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).
deviceOnlyRememberedOnUserPrompt?	boolean | IResolvable	When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request.

---

challengeRequiredOnNewDevice?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-challengerequiredonnewdevice

---

deviceOnlyRememberedOnUserPrompt?

Type: boolean | IResolvable (optional)

When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice 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 API request.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-deviceconfiguration.html#cfn-cognito-userpool-deviceconfiguration-deviceonlyrememberedonuserprompt