Package software.amazon.awscdk.services.cognito

Class CfnUserPool.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPool>

Enclosing class:

CfnUserPool

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

A fluent builder for CfnUserPool.

Method Summary

Modifier and Type	Method	Description
CfnUserPool.Builder	accountRecoverySetting(IResolvable accountRecoverySetting)	The available verified method a user can use to recover their password when they call ForgotPassword .
CfnUserPool.Builder	accountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty accountRecoverySetting)	The available verified method a user can use to recover their password when they call ForgotPassword .
CfnUserPool.Builder	adminCreateUserConfig(IResolvable adminCreateUserConfig)	The settings for administrator creation of users in a user pool.
CfnUserPool.Builder	adminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty adminCreateUserConfig)	The settings for administrator creation of users in a user pool.
CfnUserPool.Builder	aliasAttributes(List<String> aliasAttributes)	Attributes supported as an alias for this user pool.
CfnUserPool.Builder	autoVerifiedAttributes(List<String> autoVerifiedAttributes)	The attributes that you want your user pool to automatically verify.
CfnUserPool	build()
static CfnUserPool.Builder	create(software.constructs.Construct scope, String id)
CfnUserPool.Builder	deletionProtection(String deletionProtection)	When active, DeletionProtection prevents accidental deletion of your user pool.
CfnUserPool.Builder	deviceConfiguration(IResolvable deviceConfiguration)	The device-remembering configuration for a user pool.
CfnUserPool.Builder	deviceConfiguration(CfnUserPool.DeviceConfigurationProperty deviceConfiguration)	The device-remembering configuration for a user pool.
CfnUserPool.Builder	emailAuthenticationMessage(String emailAuthenticationMessage)
CfnUserPool.Builder	emailAuthenticationSubject(String emailAuthenticationSubject)
CfnUserPool.Builder	emailConfiguration(IResolvable emailConfiguration)	The email configuration of your user pool.
CfnUserPool.Builder	emailConfiguration(CfnUserPool.EmailConfigurationProperty emailConfiguration)	The email configuration of your user pool.
CfnUserPool.Builder	emailVerificationMessage(String emailVerificationMessage)	This parameter is no longer used.
CfnUserPool.Builder	emailVerificationSubject(String emailVerificationSubject)	This parameter is no longer used.
CfnUserPool.Builder	enabledMfas(List<String> enabledMfas)	Set enabled MFA options on a specified user pool.
CfnUserPool.Builder	lambdaConfig(IResolvable lambdaConfig)	A collection of user pool Lambda triggers.
CfnUserPool.Builder	lambdaConfig(CfnUserPool.LambdaConfigProperty lambdaConfig)	A collection of user pool Lambda triggers.
CfnUserPool.Builder	mfaConfiguration(String mfaConfiguration)	Displays the state of multi-factor authentication (MFA) as on, off, or optional.
CfnUserPool.Builder	policies(IResolvable policies)	A list of user pool policies.
CfnUserPool.Builder	policies(CfnUserPool.PoliciesProperty policies)	A list of user pool policies.
CfnUserPool.Builder	schema(List<? extends Object> schema)	An array of attributes for the new user pool.
CfnUserPool.Builder	schema(IResolvable schema)	An array of attributes for the new user pool.
CfnUserPool.Builder	smsAuthenticationMessage(String smsAuthenticationMessage)	The contents of the SMS authentication message.
CfnUserPool.Builder	smsConfiguration(IResolvable smsConfiguration)	The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.
CfnUserPool.Builder	smsConfiguration(CfnUserPool.SmsConfigurationProperty smsConfiguration)	The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.
CfnUserPool.Builder	smsVerificationMessage(String smsVerificationMessage)	This parameter is no longer used.
CfnUserPool.Builder	userAttributeUpdateSettings(IResolvable userAttributeUpdateSettings)	The settings for updates to user attributes.
CfnUserPool.Builder	userAttributeUpdateSettings(CfnUserPool.UserAttributeUpdateSettingsProperty userAttributeUpdateSettings)	The settings for updates to user attributes.
CfnUserPool.Builder	usernameAttributes(List<String> usernameAttributes)	Specifies whether a user can use an email address or phone number as a username when they sign up.
CfnUserPool.Builder	usernameConfiguration(IResolvable usernameConfiguration)	Sets the case sensitivity option for sign-in usernames.
CfnUserPool.Builder	usernameConfiguration(CfnUserPool.UsernameConfigurationProperty usernameConfiguration)	Sets the case sensitivity option for sign-in usernames.
CfnUserPool.Builder	userPoolAddOns(IResolvable userPoolAddOns)	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
CfnUserPool.Builder	userPoolAddOns(CfnUserPool.UserPoolAddOnsProperty userPoolAddOns)	Contains settings for activation of threat protection, including the operating mode and additional authentication types.
CfnUserPool.Builder	userPoolName(String userPoolName)	A friendly name for your user pool.
CfnUserPool.Builder	userPoolTags(Object userPoolTags)	The tag keys and values to assign to the user pool.
CfnUserPool.Builder	userPoolTier(String userPoolTier)	The user pool feature plan , or tier.
CfnUserPool.Builder	verificationMessageTemplate(IResolvable verificationMessageTemplate)	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
CfnUserPool.Builder	verificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty verificationMessageTemplate)	The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
CfnUserPool.Builder	webAuthnRelyingPartyId(String webAuthnRelyingPartyId)	Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.
CfnUserPool.Builder	webAuthnUserVerification(String webAuthnUserVerification)	When required , users can only register and sign in users with passkeys that are capable of user verification .

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnUserPool.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnUserPool.Builder.

accountRecoverySetting

@Stability(Stable)
public CfnUserPool.Builder accountRecoverySetting(IResolvable accountRecoverySetting)

The available verified method a user can use to recover their password when they call ForgotPassword .

You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

Parameters:

accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

accountRecoverySetting

@Stability(Stable)
public CfnUserPool.Builder accountRecoverySetting(CfnUserPool.AccountRecoverySettingProperty accountRecoverySetting)

The available verified method a user can use to recover their password when they call ForgotPassword .

You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.

Parameters:

accountRecoverySetting - The available verified method a user can use to recover their password when they call ForgotPassword . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-accountrecoverysetting

adminCreateUserConfig

@Stability(Stable)
public CfnUserPool.Builder adminCreateUserConfig(IResolvable adminCreateUserConfig)

The settings for administrator creation of users in a user pool.

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

Parameters:

adminCreateUserConfig - The settings for administrator creation of users in a user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

adminCreateUserConfig

@Stability(Stable)
public CfnUserPool.Builder adminCreateUserConfig(CfnUserPool.AdminCreateUserConfigProperty adminCreateUserConfig)

The settings for administrator creation of users in a user pool.

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

Parameters:

adminCreateUserConfig - The settings for administrator creation of users in a user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-admincreateuserconfig

aliasAttributes

@Stability(Stable)
public CfnUserPool.Builder aliasAttributes(List<String> aliasAttributes)

Attributes supported as an alias for this user pool.

For more information about alias attributes, see Customizing sign-in attributes .

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-aliasattributes

autoVerifiedAttributes

@Stability(Stable)
public CfnUserPool.Builder autoVerifiedAttributes(List<String> autoVerifiedAttributes)

The attributes that you want your user pool to automatically verify.

For more information, see Verifying contact information at sign-up .

Parameters:

autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-autoverifiedattributes

deletionProtection

@Stability(Stable)
public CfnUserPool.Builder deletionProtection(String deletionProtection)

When active, DeletionProtection prevents accidental deletion of your user pool.

Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

Parameters:

deletionProtection - When active, DeletionProtection prevents accidental deletion of your user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deletionprotection

deviceConfiguration

@Stability(Stable)
public CfnUserPool.Builder deviceConfiguration(IResolvable deviceConfiguration)

The device-remembering configuration for a user pool.

Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool . A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices .

Parameters:

deviceConfiguration - The device-remembering configuration for a user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration

deviceConfiguration

@Stability(Stable)
public CfnUserPool.Builder deviceConfiguration(CfnUserPool.DeviceConfigurationProperty deviceConfiguration)

The device-remembering configuration for a user pool.

Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool . A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature. For more information, see Working with devices .

Parameters:

deviceConfiguration - The device-remembering configuration for a user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-deviceconfiguration

emailAuthenticationMessage

@Stability(Stable)
public CfnUserPool.Builder emailAuthenticationMessage(String emailAuthenticationMessage)

Parameters:

emailAuthenticationMessage - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationmessage

emailAuthenticationSubject

@Stability(Stable)
public CfnUserPool.Builder emailAuthenticationSubject(String emailAuthenticationSubject)

Parameters:

emailAuthenticationSubject - This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailauthenticationsubject

emailConfiguration

@Stability(Stable)
public CfnUserPool.Builder emailConfiguration(IResolvable emailConfiguration)

The email configuration of your user pool.

The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

Parameters:

emailConfiguration - The email configuration of your user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

emailConfiguration

@Stability(Stable)
public CfnUserPool.Builder emailConfiguration(CfnUserPool.EmailConfigurationProperty emailConfiguration)

The email configuration of your user pool.

The email configuration type sets your preferred sending method, AWS Region, and sender for messages from your user pool.

Parameters:

emailConfiguration - The email configuration of your user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailconfiguration

emailVerificationMessage

@Stability(Stable)
public CfnUserPool.Builder emailVerificationMessage(String emailVerificationMessage)

This parameter is no longer used.

See VerificationMessageTemplateType .

Parameters:

emailVerificationMessage - This parameter is no longer used. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationmessage

emailVerificationSubject

@Stability(Stable)
public CfnUserPool.Builder emailVerificationSubject(String emailVerificationSubject)

This parameter is no longer used.

See VerificationMessageTemplateType .

Parameters:

emailVerificationSubject - This parameter is no longer used. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-emailverificationsubject

enabledMfas

@Stability(Stable)
public CfnUserPool.Builder enabledMfas(List<String> enabledMfas)

Set enabled MFA options on a specified user pool.

To disable all MFAs after it has been enabled, set MfaConfiguration to OFF and remove EnabledMfas. MFAs can only be all disabled if MfaConfiguration is OFF . After you enable SMS_MFA , you can only disable it by setting MfaConfiguration to OFF . Can be one of the following values:

• SMS_MFA - Enables MFA with SMS for the user pool. To select this option, you must also provide values for SmsConfiguration .
• SOFTWARE_TOKEN_MFA - Enables software token MFA for the user pool.
• EMAIL_OTP - Enables MFA with email for the user pool. To select this option, you must provide values for EmailConfiguration and within those, set EmailSendingAccount to DEVELOPER .

Allowed values: SMS_MFA | SOFTWARE_TOKEN_MFA | EMAIL_OTP

Parameters:

enabledMfas - Set enabled MFA options on a specified user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-enabledmfas

lambdaConfig

@Stability(Stable)
public CfnUserPool.Builder lambdaConfig(IResolvable lambdaConfig)

A collection of user pool Lambda triggers.

Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

Parameters:

lambdaConfig - A collection of user pool Lambda triggers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

lambdaConfig

@Stability(Stable)
public CfnUserPool.Builder lambdaConfig(CfnUserPool.LambdaConfigProperty lambdaConfig)

A collection of user pool Lambda triggers.

Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

Parameters:

lambdaConfig - A collection of user pool Lambda triggers. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-lambdaconfig

mfaConfiguration

@Stability(Stable)
public CfnUserPool.Builder mfaConfiguration(String mfaConfiguration)

Displays the state of multi-factor authentication (MFA) as on, off, or optional.

When ON , all users must set up MFA before they can sign in. When OPTIONAL , your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL .

When MfaConfiguration is OPTIONAL , managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

Parameters:

mfaConfiguration - Displays the state of multi-factor authentication (MFA) as on, off, or optional. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-mfaconfiguration

policies

@Stability(Stable)
public CfnUserPool.Builder policies(IResolvable policies)

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

Parameters:

policies - A list of user pool policies. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies

policies

@Stability(Stable)
public CfnUserPool.Builder policies(CfnUserPool.PoliciesProperty policies)

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

Parameters:

policies - A list of user pool policies. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-policies

schema

@Stability(Stable)
public CfnUserPool.Builder schema(IResolvable schema)

An array of attributes for the new user pool.

You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes .

Parameters:

schema - An array of attributes for the new user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

schema

@Stability(Stable)
public CfnUserPool.Builder schema(List<? extends Object> schema)

An array of attributes for the new user pool.

You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes .

Parameters:

schema - An array of attributes for the new user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-schema

smsAuthenticationMessage

@Stability(Stable)
public CfnUserPool.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

The contents of the SMS authentication message.

Parameters:

smsAuthenticationMessage - The contents of the SMS authentication message. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsauthenticationmessage

smsConfiguration

@Stability(Stable)
public CfnUserPool.Builder smsConfiguration(IResolvable smsConfiguration)

The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.

To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see SMS message settings .

Parameters:

smsConfiguration - The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

smsConfiguration

@Stability(Stable)
public CfnUserPool.Builder smsConfiguration(CfnUserPool.SmsConfigurationProperty smsConfiguration)

The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service.

To send SMS messages with Amazon SNS in the AWS Region that you want, the Amazon Cognito user pool uses an AWS Identity and Access Management (IAM) role in your AWS account . For more information see SMS message settings .

Parameters:

smsConfiguration - The settings for your Amazon Cognito user pool to send SMS messages with Amazon Simple Notification Service. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsconfiguration

smsVerificationMessage

@Stability(Stable)
public CfnUserPool.Builder smsVerificationMessage(String smsVerificationMessage)

This parameter is no longer used.

See VerificationMessageTemplateType .

Parameters:

smsVerificationMessage - This parameter is no longer used. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-smsverificationmessage

userAttributeUpdateSettings

@Stability(Stable)
public CfnUserPool.Builder userAttributeUpdateSettings(IResolvable userAttributeUpdateSettings)

The settings for updates to user attributes.

These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

Parameters:

userAttributeUpdateSettings - The settings for updates to user attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings

userAttributeUpdateSettings

@Stability(Stable)
public CfnUserPool.Builder userAttributeUpdateSettings(CfnUserPool.UserAttributeUpdateSettingsProperty userAttributeUpdateSettings)

The settings for updates to user attributes.

These settings include the property AttributesRequireVerificationBeforeUpdate , a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers .

Parameters:

userAttributeUpdateSettings - The settings for updates to user attributes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userattributeupdatesettings

usernameAttributes

@Stability(Stable)
public CfnUserPool.Builder usernameAttributes(List<String> usernameAttributes)

Specifies whether a user can use an email address or phone number as a username when they sign up.

Parameters:

usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameattributes

usernameConfiguration

@Stability(Stable)
public CfnUserPool.Builder usernameConfiguration(IResolvable usernameConfiguration)

Sets the case sensitivity option for sign-in usernames.

When CaseSensitive is false (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to false as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

This configuration is immutable after you set it.

Parameters:

usernameConfiguration - Sets the case sensitivity option for sign-in usernames. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

usernameConfiguration

@Stability(Stable)
public CfnUserPool.Builder usernameConfiguration(CfnUserPool.UsernameConfigurationProperty usernameConfiguration)

Sets the case sensitivity option for sign-in usernames.

When CaseSensitive is false (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username , USERNAME , or UserName , or for email, email@example.com or EMaiL@eXamplE.Com . For most use cases, set case sensitivity to false as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

This configuration is immutable after you set it.

Parameters:

usernameConfiguration - Sets the case sensitivity option for sign-in usernames. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-usernameconfiguration

userPoolAddOns

@Stability(Stable)
public CfnUserPool.Builder userPoolAddOns(IResolvable userPoolAddOns)

Contains settings for activation of threat protection, including the operating mode and additional authentication types.

To log user security information but take no action, set to AUDIT . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED .

For more information, see Adding advanced security to a user pool . To activate this setting, your user pool must be on the Plus tier .

Parameters:

userPoolAddOns - Contains settings for activation of threat protection, including the operating mode and additional authentication types. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons

userPoolAddOns

@Stability(Stable)
public CfnUserPool.Builder userPoolAddOns(CfnUserPool.UserPoolAddOnsProperty userPoolAddOns)

Contains settings for activation of threat protection, including the operating mode and additional authentication types.

To log user security information but take no action, set to AUDIT . To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED .

For more information, see Adding advanced security to a user pool . To activate this setting, your user pool must be on the Plus tier .

Parameters:

userPoolAddOns - Contains settings for activation of threat protection, including the operating mode and additional authentication types. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooladdons

userPoolName

@Stability(Stable)
public CfnUserPool.Builder userPoolName(String userPoolName)

A friendly name for your user pool.

Parameters:

userPoolName - A friendly name for your user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpoolname

userPoolTags

@Stability(Stable)
public CfnUserPool.Builder userPoolTags(Object userPoolTags)

The tag keys and values to assign to the user pool.

A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Parameters:

userPoolTags - The tag keys and values to assign to the user pool. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltags

userPoolTier

@Stability(Stable)
public CfnUserPool.Builder userPoolTier(String userPoolTier)

The user pool feature plan , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS .

Parameters:

userPoolTier - The user pool feature plan , or tier. This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection. Defaults to ESSENTIALS . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-userpooltier

verificationMessageTemplate

@Stability(Stable)
public CfnUserPool.Builder verificationMessageTemplate(IResolvable verificationMessageTemplate)

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK , specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE , specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

Parameters:

verificationMessageTemplate - The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

verificationMessageTemplate

@Stability(Stable)
public CfnUserPool.Builder verificationMessageTemplate(CfnUserPool.VerificationMessageTemplateProperty verificationMessageTemplate)

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK , specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE , specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

Parameters:

verificationMessageTemplate - The template for the verification message that your user pool delivers to users who set an email address or phone number attribute. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-verificationmessagetemplate

webAuthnRelyingPartyId

@Stability(Stable)
public CfnUserPool.Builder webAuthnRelyingPartyId(String webAuthnRelyingPartyId)

Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration.

Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

• The user pool is configured for passkey authentication.
• The user pool has a custom domain, whether or not it also has a prefix domain.
• Your application performs authentication with managed login or the classic hosted UI.

Parameters:

webAuthnRelyingPartyId - Sets or displays the authentication domain, typically your user pool domain, that passkey providers must use as a relying party (RP) in their configuration. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnrelyingpartyid

webAuthnUserVerification

@Stability(Stable)
public CfnUserPool.Builder webAuthnUserVerification(String webAuthnUserVerification)

When required , users can only register and sign in users with passkeys that are capable of user verification . When preferred , your user pool doesn't require the use of authenticators with user verification but encourages it.

Parameters:

webAuthnUserVerification - When required , users can only register and sign in users with passkeys that are capable of user verification . When preferred , your user pool doesn't require the use of authenticators with user verification but encourages it. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpool.html#cfn-cognito-userpool-webauthnuserverification

build

@Stability(Stable)
public CfnUserPool build()

Specified by:

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

Returns:

a newly built instance of CfnUserPool.