| Package | Description |
|---|---|
| software.amazon.awscdk.services.cognito |
Amazon Cognito Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
UserPool.Builder |
UserPool.Builder.accountRecovery(AccountRecovery accountRecovery)
How will a user be able to recover their account?
|
UserPool.Builder |
UserPool.Builder.autoVerify(AutoVerifiedAttrs autoVerify)
Attributes which Cognito will look to verify automatically upon user sign up.
|
static UserPool.Builder |
UserPool.Builder.create(software.constructs.Construct scope,
String id) |
UserPool.Builder |
UserPool.Builder.customAttributes(Map<String,? extends ICustomAttribute> customAttributes)
Define a set of custom attributes that can be configured for each user in the user pool.
|
UserPool.Builder |
UserPool.Builder.customSenderKmsKey(IKey customSenderKmsKey)
This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates.
|
UserPool.Builder |
UserPool.Builder.deviceTracking(DeviceTracking deviceTracking)
Device tracking settings.
|
UserPool.Builder |
UserPool.Builder.email(UserPoolEmail email)
Email settings for a user pool.
|
UserPool.Builder |
UserPool.Builder.enableSmsRole(Boolean enableSmsRole)
Setting this would explicitly enable or disable SMS role creation.
|
UserPool.Builder |
UserPool.Builder.keepOriginal(KeepOriginalAttrs keepOriginal)
Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes.
|
UserPool.Builder |
UserPool.Builder.lambdaTriggers(UserPoolTriggers lambdaTriggers)
Lambda functions to use for supported Cognito triggers.
|
UserPool.Builder |
UserPool.Builder.mfa(Mfa mfa)
Configure whether users of this user pool can or are required use MFA to sign in.
|
UserPool.Builder |
UserPool.Builder.mfaMessage(String mfaMessage)
The SMS message template sent during MFA verification.
|
UserPool.Builder |
UserPool.Builder.mfaSecondFactor(MfaSecondFactor mfaSecondFactor)
Configure the MFA types that users can use in this user pool.
|
UserPool.Builder |
UserPool.Builder.passwordPolicy(PasswordPolicy passwordPolicy)
Password policy for this user pool.
|
UserPool.Builder |
UserPool.Builder.removalPolicy(RemovalPolicy removalPolicy)
Policy to apply when the user pool is removed from the stack.
|
UserPool.Builder |
UserPool.Builder.selfSignUpEnabled(Boolean selfSignUpEnabled)
Whether self sign up should be enabled.
|
UserPool.Builder |
UserPool.Builder.signInAliases(SignInAliases signInAliases)
Methods in which a user registers or signs in to a user pool.
|
UserPool.Builder |
UserPool.Builder.signInCaseSensitive(Boolean signInCaseSensitive)
Whether sign-in aliases should be evaluated with case sensitivity.
|
UserPool.Builder |
UserPool.Builder.smsRole(IRole smsRole)
The IAM role that Cognito will assume while sending SMS messages.
|
UserPool.Builder |
UserPool.Builder.smsRoleExternalId(String smsRoleExternalId)
The 'ExternalId' that Cognito service must using when assuming the `smsRole`, if the role is restricted with an 'sts:ExternalId' conditional.
|
UserPool.Builder |
UserPool.Builder.snsRegion(String snsRegion)
The region to integrate with SNS to send SMS messages.
|
UserPool.Builder |
UserPool.Builder.standardAttributes(StandardAttributes standardAttributes)
The set of attributes that are required for every user in the user pool.
|
UserPool.Builder |
UserPool.Builder.userInvitation(UserInvitationConfig userInvitation)
Configuration around admins signing up users into a user pool.
|
UserPool.Builder |
UserPool.Builder.userPoolName(String userPoolName)
Name of the user pool.
|
UserPool.Builder |
UserPool.Builder.userVerification(UserVerificationConfig userVerification)
Configuration around users signing themselves up to the user pool.
|
Copyright © 2022. All rights reserved.