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 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

    • advancedSecurityMode

      @Stability(Deprecated) @Deprecated public UserPoolProps.Builder advancedSecurityMode(AdvancedSecurityMode advancedSecurityMode)
      Deprecated.
      Advanced Security Mode is deprecated due to user pool feature plans. Use StandardThreatProtectionMode and CustomThreatProtectionMode to set Thread Protection level.
      Sets the value of UserPoolProps.getAdvancedSecurityMode()
      Parameters:
      advancedSecurityMode - The user pool's Advanced Security Mode.
      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(IKeyRef 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

    • customThreatProtectionMode

      @Stability(Stable) public UserPoolProps.Builder customThreatProtectionMode(CustomThreatProtectionMode customThreatProtectionMode)
      Sets the value of UserPoolProps.getCustomThreatProtectionMode()
      Parameters:
      customThreatProtectionMode - The Type of Threat Protection Enabled for Custom Authentication. This feature only functions if your FeaturePlan is set to FeaturePlan.PLUS
      Returns:
      this

    • deletionProtection

      @Stability(Stable) public UserPoolProps.Builder deletionProtection(Boolean deletionProtection)
      Sets the value of UserPoolProps.getDeletionProtection()
      Parameters:
      deletionProtection - Indicates whether the user pool should have deletion protection enabled.
      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

    • 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

    • featurePlan

      @Stability(Stable) public UserPoolProps.Builder featurePlan(FeaturePlan featurePlan)
      Sets the value of UserPoolProps.getFeaturePlan()
      Parameters:
      featurePlan - 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.
      Returns:
      this

    • keepOriginal

      @Stability(Stable) public UserPoolProps.Builder keepOriginal(KeepOriginalAttrs keepOriginal)
      Sets the value of UserPoolProps.getKeepOriginal()
      Parameters:
      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.
      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

    • passkeyRelyingPartyId

      @Stability(Stable) public UserPoolProps.Builder passkeyRelyingPartyId(String passkeyRelyingPartyId)
      Sets the value of UserPoolProps.getPasskeyRelyingPartyId()
      Parameters:
      passkeyRelyingPartyId - The authentication 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.
      Returns:
      this

    • passkeyUserVerification

      @Stability(Stable) public UserPoolProps.Builder passkeyUserVerification(PasskeyUserVerification passkeyUserVerification)
      Sets the value of UserPoolProps.getPasskeyUserVerification()
      Parameters:
      passkeyUserVerification - Your user-pool treatment for MFA with a passkey. You can override other MFA options and require passkey MFA, or you can set it as preferred. When passkey MFA is preferred, the hosted UI encourages users to register a passkey at sign-in.
      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. To configure self sign-up configuration use the userVerification 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

    • signInPolicy

      @Stability(Stable) public UserPoolProps.Builder signInPolicy(SignInPolicy signInPolicy)
      Sets the value of UserPoolProps.getSignInPolicy()
      Parameters:
      signInPolicy - Sign-in policy for this user pool.
      Returns:
      this

    • smsRole

      @Stability(Stable) public UserPoolProps.Builder smsRole(IRoleRef 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 be 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

    • standardThreatProtectionMode

      @Stability(Stable) public UserPoolProps.Builder standardThreatProtectionMode(StandardThreatProtectionMode standardThreatProtectionMode)
      Sets the value of UserPoolProps.getStandardThreatProtectionMode()
      Parameters:
      standardThreatProtectionMode - The Type of Threat Protection Enabled for Standard Authentication. This feature only functions if your FeaturePlan is set to FeaturePlan.PLUS
      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