Interface DeviceConfigurationType.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DeviceConfigurationType.Builder,
,DeviceConfigurationType> SdkBuilder<DeviceConfigurationType.Builder,
,DeviceConfigurationType> SdkPojo
- Enclosing class:
DeviceConfigurationType
-
Method Summary
Modifier and TypeMethodDescriptionchallengeRequiredOnNewDevice
(Boolean 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).deviceOnlyRememberedOnUserPrompt
(Boolean deviceOnlyRememberedOnUserPrompt) When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a ConfirmDevice API request.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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).
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.- Parameters:
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).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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deviceOnlyRememberedOnUserPrompt
DeviceConfigurationType.Builder deviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt) 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
isfalse
, Amazon Cognito immediately remembers devices that you register in aConfirmDevice
API request.- Parameters:
deviceOnlyRememberedOnUserPrompt
- 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
isfalse
, Amazon Cognito immediately remembers devices that you register in aConfirmDevice
API request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-