software.amazon.awscdk.services.cognito

Class CfnUserPool.DeviceConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPool.DeviceConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPool.DeviceConfigurationProperty>

Enclosing interface:

CfnUserPool.DeviceConfigurationProperty

@Stability(value=Stable)
public static final class CfnUserPool.DeviceConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPool.DeviceConfigurationProperty>

A builder for CfnUserPool.DeviceConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnUserPool.DeviceConfigurationProperty	build() Builds the configured instance.
CfnUserPool.DeviceConfigurationProperty.Builder	challengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice) Sets the value of CfnUserPool.DeviceConfigurationProperty.getChallengeRequiredOnNewDevice()
CfnUserPool.DeviceConfigurationProperty.Builder	challengeRequiredOnNewDevice(IResolvable challengeRequiredOnNewDevice) Sets the value of CfnUserPool.DeviceConfigurationProperty.getChallengeRequiredOnNewDevice()
CfnUserPool.DeviceConfigurationProperty.Builder	deviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt) Sets the value of CfnUserPool.DeviceConfigurationProperty.getDeviceOnlyRememberedOnUserPrompt()
CfnUserPool.DeviceConfigurationProperty.Builder	deviceOnlyRememberedOnUserPrompt(IResolvable deviceOnlyRememberedOnUserPrompt) Sets the value of CfnUserPool.DeviceConfigurationProperty.getDeviceOnlyRememberedOnUserPrompt()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

challengeRequiredOnNewDevice

@Stability(value=Stable)
public CfnUserPool.DeviceConfigurationProperty.Builder challengeRequiredOnNewDevice(Boolean challengeRequiredOnNewDevice)

Sets the value of CfnUserPool.DeviceConfigurationProperty.getChallengeRequiredOnNewDevice()

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:

this

challengeRequiredOnNewDevice

@Stability(value=Stable)
public CfnUserPool.DeviceConfigurationProperty.Builder challengeRequiredOnNewDevice(IResolvable challengeRequiredOnNewDevice)

Sets the value of CfnUserPool.DeviceConfigurationProperty.getChallengeRequiredOnNewDevice()

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:

this

deviceOnlyRememberedOnUserPrompt

@Stability(value=Stable)
public CfnUserPool.DeviceConfigurationProperty.Builder deviceOnlyRememberedOnUserPrompt(Boolean deviceOnlyRememberedOnUserPrompt)

Sets the value of CfnUserPool.DeviceConfigurationProperty.getDeviceOnlyRememberedOnUserPrompt()

Parameters:

deviceOnlyRememberedOnUserPrompt - When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) 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](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request. When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

Returns:

this

deviceOnlyRememberedOnUserPrompt

@Stability(value=Stable)
public CfnUserPool.DeviceConfigurationProperty.Builder deviceOnlyRememberedOnUserPrompt(IResolvable deviceOnlyRememberedOnUserPrompt)

Sets the value of CfnUserPool.DeviceConfigurationProperty.getDeviceOnlyRememberedOnUserPrompt()

Parameters:

deviceOnlyRememberedOnUserPrompt - When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a [ConfirmDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmDevice.html) 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](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateDeviceStatus.html) API request. When DeviceOnlyRememberedOnUserPrompt is false , Amazon Cognito immediately remembers devices that you register in a ConfirmDevice API request.

Returns:

this

build

@Stability(value=Stable)
public CfnUserPool.DeviceConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPool.DeviceConfigurationProperty>

Returns:

a new instance of CfnUserPool.DeviceConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided