DeviceConfigurationProperty Struct
The device-remembering configuration for a user pool.
| Source | |
|---|---|
| Type last changed |
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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito
device_configuration_property = cognito.CfnUserPool.DeviceConfigurationProperty(
challenge_required_on_new_device=False,
device_only_remembered_on_user_prompt=False
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var deviceConfigurationProperty = new DeviceConfigurationProperty {
ChallengeRequiredOnNewDevice = false,
DeviceOnlyRememberedOnUserPrompt = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
deviceConfigurationProperty := &DeviceConfigurationProperty{
ChallengeRequiredOnNewDevice: jsii.Boolean(false),
DeviceOnlyRememberedOnUserPrompt: jsii.Boolean(false),
}
Properties
challengeRequiredOnNewDeviceoptionalboolean | IResolvablechallenge_required_on_new_deviceoptionaltyping.Union[bool, IResolvable]challengeRequiredOnNewDeviceoptionalBooleanChallengeRequiredOnNewDeviceoptionalboolChallengeRequiredOnNewDeviceoptionalinterface{} #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.
deviceOnlyRememberedOnUserPromptoptionalboolean | IResolvabledevice_only_remembered_on_user_promptoptionaltyping.Union[bool, IResolvable]deviceOnlyRememberedOnUserPromptoptionalBooleanDeviceOnlyRememberedOnUserPromptoptionalboolDeviceOnlyRememberedOnUserPromptoptionalinterface{} #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.