Package software.amazon.awscdk.services.cognito

Class UserPoolProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolProps>

Enclosing interface:

UserPoolProps

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

A builder for UserPoolProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolProps.Builder	accountRecovery(AccountRecovery accountRecovery)	Sets the value of UserPoolProps.getAccountRecovery()
UserPoolProps.Builder	autoVerify(AutoVerifiedAttrs autoVerify)	Sets the value of UserPoolProps.getAutoVerify()
UserPoolProps	build()	Builds the configured instance.
UserPoolProps.Builder	customAttributes(Map<String,? extends ICustomAttribute> customAttributes)	Sets the value of UserPoolProps.getCustomAttributes()
UserPoolProps.Builder	customSenderKmsKey(IKey customSenderKmsKey)	Sets the value of UserPoolProps.getCustomSenderKmsKey()
UserPoolProps.Builder	deviceTracking(DeviceTracking deviceTracking)	Sets the value of UserPoolProps.getDeviceTracking()
UserPoolProps.Builder	email(UserPoolEmail email)	Sets the value of UserPoolProps.getEmail()
UserPoolProps.Builder	emailSettings(EmailSettings emailSettings)	Deprecated. Use 'email' instead.
UserPoolProps.Builder	enableSmsRole(Boolean enableSmsRole)	Sets the value of UserPoolProps.getEnableSmsRole()
UserPoolProps.Builder	lambdaTriggers(UserPoolTriggers lambdaTriggers)	Sets the value of UserPoolProps.getLambdaTriggers()
UserPoolProps.Builder	mfa(Mfa mfa)	Sets the value of UserPoolProps.getMfa()
UserPoolProps.Builder	mfaMessage(String mfaMessage)	Sets the value of UserPoolProps.getMfaMessage()
UserPoolProps.Builder	mfaSecondFactor(MfaSecondFactor mfaSecondFactor)	Sets the value of UserPoolProps.getMfaSecondFactor()
UserPoolProps.Builder	passwordPolicy(PasswordPolicy passwordPolicy)	Sets the value of UserPoolProps.getPasswordPolicy()
UserPoolProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of UserPoolProps.getRemovalPolicy()
UserPoolProps.Builder	selfSignUpEnabled(Boolean selfSignUpEnabled)	Sets the value of UserPoolProps.getSelfSignUpEnabled()
UserPoolProps.Builder	signInAliases(SignInAliases signInAliases)	Sets the value of UserPoolProps.getSignInAliases()
UserPoolProps.Builder	signInCaseSensitive(Boolean signInCaseSensitive)	Sets the value of UserPoolProps.getSignInCaseSensitive()
UserPoolProps.Builder	smsRole(IRole smsRole)	Sets the value of UserPoolProps.getSmsRole()
UserPoolProps.Builder	smsRoleExternalId(String smsRoleExternalId)	Sets the value of UserPoolProps.getSmsRoleExternalId()
UserPoolProps.Builder	snsRegion(String snsRegion)	Sets the value of UserPoolProps.getSnsRegion()
UserPoolProps.Builder	standardAttributes(StandardAttributes standardAttributes)	Sets the value of UserPoolProps.getStandardAttributes()
UserPoolProps.Builder	userInvitation(UserInvitationConfig userInvitation)	Sets the value of UserPoolProps.getUserInvitation()
UserPoolProps.Builder	userPoolName(String userPoolName)	Sets the value of UserPoolProps.getUserPoolName()
UserPoolProps.Builder	userVerification(UserVerificationConfig userVerification)	Sets the value of UserPoolProps.getUserVerification()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

accountRecovery

@Stability(Stable)
public UserPoolProps.Builder accountRecovery(AccountRecovery accountRecovery)

Sets the value of UserPoolProps.getAccountRecovery()

Parameters:

accountRecovery - How will a user be able to recover their account?.

Returns:

this

autoVerify

@Stability(Stable)
public UserPoolProps.Builder autoVerify(AutoVerifiedAttrs autoVerify)

Sets the value of UserPoolProps.getAutoVerify()

Parameters:

autoVerify - Attributes which Cognito will look to verify automatically upon user sign up. EMAIL and PHONE are the only available options.

Returns:

this

customAttributes

@Stability(Stable)
public UserPoolProps.Builder customAttributes(Map<String,? extends ICustomAttribute> customAttributes)

Sets the value of UserPoolProps.getCustomAttributes()

Parameters:

customAttributes - Define a set of custom attributes that can be configured for each user in the user pool.

Returns:

this

customSenderKmsKey

@Stability(Stable)
public UserPoolProps.Builder customSenderKmsKey(IKey customSenderKmsKey)

Sets the value of UserPoolProps.getCustomSenderKmsKey()

Parameters:

customSenderKmsKey - This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates.

Returns:

this

deviceTracking

@Stability(Stable)
public UserPoolProps.Builder deviceTracking(DeviceTracking deviceTracking)

Sets the value of UserPoolProps.getDeviceTracking()

Parameters:

deviceTracking - Device tracking settings.

Returns:

this

email

@Stability(Stable)
public UserPoolProps.Builder email(UserPoolEmail email)

Sets the value of UserPoolProps.getEmail()

Parameters:

email - Email settings for a user pool.

Returns:

this

emailSettings

@Stability(Deprecated)
@Deprecated
public UserPoolProps.Builder emailSettings(EmailSettings emailSettings)

Deprecated.

Use 'email' instead.

Sets the value of UserPoolProps.getEmailSettings()

Parameters:

emailSettings - Email settings for a user pool.

Returns:

this

enableSmsRole

@Stability(Stable)
public UserPoolProps.Builder enableSmsRole(Boolean enableSmsRole)

Sets the value of UserPoolProps.getEnableSmsRole()

Parameters:

enableSmsRole - Setting this would explicitly enable or disable SMS role creation. When left unspecified, CDK will determine based on other properties if a role is needed or not.

Returns:

this

lambdaTriggers

@Stability(Stable)
public UserPoolProps.Builder lambdaTriggers(UserPoolTriggers lambdaTriggers)

Sets the value of UserPoolProps.getLambdaTriggers()

Parameters:

lambdaTriggers - Lambda functions to use for supported Cognito triggers.

Returns:

this

mfa

@Stability(Stable)
public UserPoolProps.Builder mfa(Mfa mfa)

Sets the value of UserPoolProps.getMfa()

Parameters:

mfa - Configure whether users of this user pool can or are required use MFA to sign in.

Returns:

this

mfaMessage

@Stability(Stable)
public UserPoolProps.Builder mfaMessage(String mfaMessage)

Sets the value of UserPoolProps.getMfaMessage()

Parameters:

mfaMessage - The SMS message template sent during MFA verification. Use '{####}' in the template where Cognito should insert the verification code.

Returns:

this

mfaSecondFactor

@Stability(Stable)
public UserPoolProps.Builder mfaSecondFactor(MfaSecondFactor mfaSecondFactor)

Sets the value of UserPoolProps.getMfaSecondFactor()

Parameters:

mfaSecondFactor - Configure the MFA types that users can use in this user pool. Ignored if mfa is set to OFF.

Returns:

this

passwordPolicy

@Stability(Stable)
public UserPoolProps.Builder passwordPolicy(PasswordPolicy passwordPolicy)

Sets the value of UserPoolProps.getPasswordPolicy()

Parameters:

passwordPolicy - Password policy for this user pool.

Returns:

this

removalPolicy

@Stability(Stable)
public UserPoolProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of UserPoolProps.getRemovalPolicy()

Parameters:

removalPolicy - Policy to apply when the user pool is removed from the stack.

Returns:

this

selfSignUpEnabled

@Stability(Stable)
public UserPoolProps.Builder selfSignUpEnabled(Boolean selfSignUpEnabled)

Sets the value of UserPoolProps.getSelfSignUpEnabled()

Parameters:

selfSignUpEnabled - Whether self sign up should be enabled. This can be further configured via the selfSignUp property.

Returns:

this

signInAliases

@Stability(Stable)
public UserPoolProps.Builder signInAliases(SignInAliases signInAliases)

Sets the value of UserPoolProps.getSignInAliases()

Parameters:

signInAliases - Methods in which a user registers or signs in to a user pool. Allows either username with aliases OR sign in with email, phone, or both.

Read the sections on usernames and aliases to learn more - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

To match with 'Option 1' in the above link, with a verified email, this property should be set to { username: true, email: true }. To match with 'Option 2' in the above link with both a verified email and phone number, this property should be set to { email: true, phone: true }.

Returns:

this

signInCaseSensitive

@Stability(Stable)
public UserPoolProps.Builder signInCaseSensitive(Boolean signInCaseSensitive)

Sets the value of UserPoolProps.getSignInCaseSensitive()

Parameters:

signInCaseSensitive - Whether sign-in aliases should be evaluated with case sensitivity. For example, when this option is set to false, users will be able to sign in using either MyUsername or myusername.

Returns:

this

smsRole

@Stability(Stable)
public UserPoolProps.Builder smsRole(IRole smsRole)

Sets the value of UserPoolProps.getSmsRole()

Parameters:

smsRole - The IAM role that Cognito will assume while sending SMS messages.

Returns:

this

smsRoleExternalId

@Stability(Stable)
public UserPoolProps.Builder smsRoleExternalId(String smsRoleExternalId)

Sets the value of UserPoolProps.getSmsRoleExternalId()

Parameters:

smsRoleExternalId - The 'ExternalId' that Cognito service must using when assuming the smsRole, if the role is restricted with an 'sts:ExternalId' conditional. Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

This property will be ignored if smsRole is not specified.

Returns:

this

snsRegion

@Stability(Stable)
public UserPoolProps.Builder snsRegion(String snsRegion)

Sets the value of UserPoolProps.getSnsRegion()

Parameters:

snsRegion - The region to integrate with SNS to send SMS messages. This property will do nothing if SMS configuration is not configured

Returns:

this

standardAttributes

@Stability(Stable)
public UserPoolProps.Builder standardAttributes(StandardAttributes standardAttributes)

Sets the value of UserPoolProps.getStandardAttributes()

Parameters:

standardAttributes - The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

Returns:

this

userInvitation

@Stability(Stable)
public UserPoolProps.Builder userInvitation(UserInvitationConfig userInvitation)

Sets the value of UserPoolProps.getUserInvitation()

Parameters:

userInvitation - Configuration around admins signing up users into a user pool.

Returns:

this

userPoolName

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

Sets the value of UserPoolProps.getUserPoolName()

Parameters:

userPoolName - Name of the user pool.

Returns:

this

userVerification

@Stability(Stable)
public UserPoolProps.Builder userVerification(UserVerificationConfig userVerification)

Sets the value of UserPoolProps.getUserVerification()

Parameters:

userVerification - Configuration around users signing themselves up to the user pool. Enable or disable self sign-up via the selfSignUpEnabled property.

Returns:

this

build

@Stability(Stable)
public UserPoolProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolProps

Throws:

NullPointerException - if any required attribute was not provided