@Stability(value=Stable) public static final class UserPoolProps.Builder extends Object implements software.amazon.jsii.Builder<UserPoolProps>
UserPoolProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public UserPoolProps.Builder accountRecovery(AccountRecovery accountRecovery)
UserPoolProps.getAccountRecovery()accountRecovery - How will a user be able to recover their account?.this@Stability(value=Stable) public UserPoolProps.Builder autoVerify(AutoVerifiedAttrs autoVerify)
UserPoolProps.getAutoVerify()autoVerify - Attributes which Cognito will look to verify automatically upon user sign up.
EMAIL and PHONE are the only available options.this@Stability(value=Stable) public UserPoolProps.Builder customAttributes(Map<String,? extends ICustomAttribute> customAttributes)
UserPoolProps.getCustomAttributes()customAttributes - Define a set of custom attributes that can be configured for each user in the user pool.this@Stability(value=Stable) public UserPoolProps.Builder customSenderKmsKey(IKey customSenderKmsKey)
UserPoolProps.getCustomSenderKmsKey()customSenderKmsKey - This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates.this@Stability(value=Stable) public UserPoolProps.Builder deviceTracking(DeviceTracking deviceTracking)
UserPoolProps.getDeviceTracking()deviceTracking - Device tracking settings.this@Stability(value=Stable) public UserPoolProps.Builder email(UserPoolEmail email)
UserPoolProps.getEmail()email - Email settings for a user pool.this@Stability(value=Stable) public UserPoolProps.Builder enableSmsRole(Boolean enableSmsRole)
UserPoolProps.getEnableSmsRole()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.this@Stability(value=Stable) public UserPoolProps.Builder keepOriginal(KeepOriginalAttrs keepOriginal)
UserPoolProps.getKeepOriginal()keepOriginal - Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes.
EMAIL and PHONE are the only available options.this@Stability(value=Stable) public UserPoolProps.Builder lambdaTriggers(UserPoolTriggers lambdaTriggers)
UserPoolProps.getLambdaTriggers()lambdaTriggers - Lambda functions to use for supported Cognito triggers.this@Stability(value=Stable) public UserPoolProps.Builder mfa(Mfa mfa)
UserPoolProps.getMfa()mfa - Configure whether users of this user pool can or are required use MFA to sign in.this@Stability(value=Stable) public UserPoolProps.Builder mfaMessage(String mfaMessage)
UserPoolProps.getMfaMessage()mfaMessage - The SMS message template sent during MFA verification.
Use '{####}' in the template where Cognito should insert the verification code.this@Stability(value=Stable) public UserPoolProps.Builder mfaSecondFactor(MfaSecondFactor mfaSecondFactor)
UserPoolProps.getMfaSecondFactor()mfaSecondFactor - Configure the MFA types that users can use in this user pool.
Ignored if mfa is set to OFF.this@Stability(value=Stable) public UserPoolProps.Builder passwordPolicy(PasswordPolicy passwordPolicy)
UserPoolProps.getPasswordPolicy()passwordPolicy - Password policy for this user pool.this@Stability(value=Stable) public UserPoolProps.Builder removalPolicy(RemovalPolicy removalPolicy)
UserPoolProps.getRemovalPolicy()removalPolicy - Policy to apply when the user pool is removed from the stack.this@Stability(value=Stable) public UserPoolProps.Builder selfSignUpEnabled(Boolean selfSignUpEnabled)
UserPoolProps.getSelfSignUpEnabled()selfSignUpEnabled - Whether self sign up should be enabled.
This can be further configured via the selfSignUp property.this@Stability(value=Stable) public UserPoolProps.Builder signInAliases(SignInAliases signInAliases)
UserPoolProps.getSignInAliases()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 }.
this@Stability(value=Stable) public UserPoolProps.Builder signInCaseSensitive(Boolean signInCaseSensitive)
UserPoolProps.getSignInCaseSensitive()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.this@Stability(value=Stable) public UserPoolProps.Builder smsRole(IRole smsRole)
UserPoolProps.getSmsRole()smsRole - The IAM role that Cognito will assume while sending SMS messages.this@Stability(value=Stable) public UserPoolProps.Builder smsRoleExternalId(String smsRoleExternalId)
UserPoolProps.getSmsRoleExternalId()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.
this@Stability(value=Stable) public UserPoolProps.Builder snsRegion(String snsRegion)
UserPoolProps.getSnsRegion()snsRegion - The region to integrate with SNS to send SMS messages.
This property will do nothing if SMS configuration is not configuredthis@Stability(value=Stable) public UserPoolProps.Builder standardAttributes(StandardAttributes standardAttributes)
UserPoolProps.getStandardAttributes()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.htmlthis@Stability(value=Stable) public UserPoolProps.Builder userInvitation(UserInvitationConfig userInvitation)
UserPoolProps.getUserInvitation()userInvitation - Configuration around admins signing up users into a user pool.this@Stability(value=Stable) public UserPoolProps.Builder userPoolName(String userPoolName)
UserPoolProps.getUserPoolName()userPoolName - Name of the user pool.this@Stability(value=Stable) public UserPoolProps.Builder userVerification(UserVerificationConfig userVerification)
UserPoolProps.getUserVerification()userVerification - Configuration around users signing themselves up to the user pool.
Enable or disable self sign-up via the selfSignUpEnabled property.this@Stability(value=Stable) public UserPoolProps build()
build in interface software.amazon.jsii.Builder<UserPoolProps>UserPoolPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.