Interface CreateUserPoolRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>, SdkBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateUserPoolRequest
public static interface CreateUserPoolRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>

  • Method Details

    • poolName

      CreateUserPoolRequest.Builder poolName(String poolName)

      A string used to name the user pool.

      Parameters:
      poolName - A string used to name the user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policies

      CreateUserPoolRequest.Builder policies(UserPoolPolicyType policies)

      The policies associated with the new user pool.

      Parameters:
      policies - The policies associated with the new user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policies

      default CreateUserPoolRequest.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)

      The policies associated with the new user pool.

      This is a convenience method that creates an instance of the UserPoolPolicyType.Builder avoiding the need to create one manually via UserPoolPolicyType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policies(UserPoolPolicyType).

      Parameters:
      policies - a consumer that will call methods on UserPoolPolicyType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deletionProtection

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deletionProtection

      CreateUserPoolRequest.Builder deletionProtection(DeletionProtectionType 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. 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • lambdaConfig

      CreateUserPoolRequest.Builder lambdaConfig(LambdaConfigType lambdaConfig)

      The Lambda trigger configuration information for the new user pool.

      In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

      For more information on using the Lambda API to add permission, see AddPermission .

      For adding permission using the CLI, see add-permission .

      Parameters:
      lambdaConfig - The Lambda trigger configuration information for the new user pool.

      In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

      For more information on using the Lambda API to add permission, see AddPermission .

      For adding permission using the CLI, see add-permission .

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lambdaConfig

      default CreateUserPoolRequest.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)

      The Lambda trigger configuration information for the new user pool.

      In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.

      For more information on using the Lambda API to add permission, see AddPermission .

      For adding permission using the CLI, see add-permission .

      This is a convenience method that creates an instance of the LambdaConfigType.Builder avoiding the need to create one manually via LambdaConfigType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaConfig(LambdaConfigType).

      Parameters:
      lambdaConfig - a consumer that will call methods on LambdaConfigType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoVerifiedAttributesWithStrings

      CreateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)

      The attributes to be auto-verified. Possible values: email, phone_number.

      Parameters:
      autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoVerifiedAttributesWithStrings

      CreateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)

      The attributes to be auto-verified. Possible values: email, phone_number.

      Parameters:
      autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoVerifiedAttributes

      CreateUserPoolRequest.Builder autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)

      The attributes to be auto-verified. Possible values: email, phone_number.

      Parameters:
      autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoVerifiedAttributes

      CreateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)

      The attributes to be auto-verified. Possible values: email, phone_number.

      Parameters:
      autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aliasAttributesWithStrings

      CreateUserPoolRequest.Builder aliasAttributesWithStrings(Collection<String> aliasAttributes)

      Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aliasAttributesWithStrings

      CreateUserPoolRequest.Builder aliasAttributesWithStrings(String... aliasAttributes)

      Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aliasAttributes

      CreateUserPoolRequest.Builder aliasAttributes(Collection<AliasAttributeType> aliasAttributes)

      Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • aliasAttributes

      CreateUserPoolRequest.Builder aliasAttributes(AliasAttributeType... aliasAttributes)

      Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameAttributesWithStrings

      CreateUserPoolRequest.Builder usernameAttributesWithStrings(Collection<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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameAttributesWithStrings

      CreateUserPoolRequest.Builder usernameAttributesWithStrings(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameAttributes

      CreateUserPoolRequest.Builder usernameAttributes(Collection<UsernameAttributeType> 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameAttributes

      CreateUserPoolRequest.Builder usernameAttributes(UsernameAttributeType... 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • smsVerificationMessage

      CreateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)

      This parameter is no longer used. See VerificationMessageTemplateType.

      Parameters:
      smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailVerificationMessage

      CreateUserPoolRequest.Builder emailVerificationMessage(String emailVerificationMessage)

      This parameter is no longer used. See VerificationMessageTemplateType.

      Parameters:
      emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailVerificationSubject

      CreateUserPoolRequest.Builder emailVerificationSubject(String emailVerificationSubject)

      This parameter is no longer used. See VerificationMessageTemplateType.

      Parameters:
      emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • verificationMessageTemplate

      CreateUserPoolRequest.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)

      The template for the verification message that the user sees when the app requests permission to access the user's information.

      Parameters:
      verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • verificationMessageTemplate

      default CreateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)

      The template for the verification message that the user sees when the app requests permission to access the user's information.

      This is a convenience method that creates an instance of the VerificationMessageTemplateType.Builder avoiding the need to create one manually via VerificationMessageTemplateType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationMessageTemplate(VerificationMessageTemplateType).

      Parameters:
      verificationMessageTemplate - a consumer that will call methods on VerificationMessageTemplateType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • smsAuthenticationMessage

      CreateUserPoolRequest.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

      A string representing the SMS authentication message.

      Parameters:
      smsAuthenticationMessage - A string representing the SMS authentication message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mfaConfiguration

      CreateUserPoolRequest.Builder mfaConfiguration(String mfaConfiguration)

      Specifies MFA configuration details.

      Parameters:
      mfaConfiguration - Specifies MFA configuration details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mfaConfiguration

      CreateUserPoolRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

      Specifies MFA configuration details.

      Parameters:
      mfaConfiguration - Specifies MFA configuration details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userAttributeUpdateSettings

      CreateUserPoolRequest.Builder userAttributeUpdateSettings(UserAttributeUpdateSettingsType 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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userAttributeUpdateSettings

      default CreateUserPoolRequest.Builder userAttributeUpdateSettings(Consumer<UserAttributeUpdateSettingsType.Builder> 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.

      This is a convenience method that creates an instance of the UserAttributeUpdateSettingsType.Builder avoiding the need to create one manually via UserAttributeUpdateSettingsType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userAttributeUpdateSettings(UserAttributeUpdateSettingsType).

      Parameters:
      userAttributeUpdateSettings - a consumer that will call methods on UserAttributeUpdateSettingsType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deviceConfiguration

      CreateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)

      The device-remembering configuration for a 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.

      Parameters:
      deviceConfiguration - The device-remembering configuration for a 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfiguration

      default CreateUserPoolRequest.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)

      The device-remembering configuration for a 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.

      This is a convenience method that creates an instance of the DeviceConfigurationType.Builder avoiding the need to create one manually via DeviceConfigurationType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfiguration(DeviceConfigurationType).

      Parameters:
      deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • emailConfiguration

      CreateUserPoolRequest.Builder emailConfiguration(EmailConfigurationType emailConfiguration)

      The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

      Parameters:
      emailConfiguration - The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emailConfiguration

      default CreateUserPoolRequest.Builder emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)

      The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.

      This is a convenience method that creates an instance of the EmailConfigurationType.Builder avoiding the need to create one manually via EmailConfigurationType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailConfiguration(EmailConfigurationType).

      Parameters:
      emailConfiguration - a consumer that will call methods on EmailConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • smsConfiguration

      CreateUserPoolRequest.Builder smsConfiguration(SmsConfigurationType smsConfiguration)

      The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

      Parameters:
      smsConfiguration - The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • smsConfiguration

      default CreateUserPoolRequest.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)

      The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

      This is a convenience method that creates an instance of the SmsConfigurationType.Builder avoiding the need to create one manually via SmsConfigurationType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsConfiguration(SmsConfigurationType).

      Parameters:
      smsConfiguration - a consumer that will call methods on SmsConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userPoolTags

      CreateUserPoolRequest.Builder userPoolTags(Map<String,String> 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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminCreateUserConfig

      CreateUserPoolRequest.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)

      The configuration for AdminCreateUser requests.

      Parameters:
      adminCreateUserConfig - The configuration for AdminCreateUser requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminCreateUserConfig

      default CreateUserPoolRequest.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)

      The configuration for AdminCreateUser requests.

      This is a convenience method that creates an instance of the AdminCreateUserConfigType.Builder avoiding the need to create one manually via AdminCreateUserConfigType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to adminCreateUserConfig(AdminCreateUserConfigType).

      Parameters:
      adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • schema

      CreateUserPoolRequest.Builder schema(Collection<SchemaAttributeType> schema)

      An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

      Parameters:
      schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schema

      CreateUserPoolRequest.Builder schema(SchemaAttributeType... schema)

      An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

      Parameters:
      schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schema

      CreateUserPoolRequest.Builder schema(Consumer<SchemaAttributeType.Builder>... schema)

      An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

      This is a convenience method that creates an instance of the SchemaAttributeType.Builder avoiding the need to create one manually via SchemaAttributeType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schema(List<SchemaAttributeType>).

      Parameters:
      schema - a consumer that will call methods on SchemaAttributeType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userPoolAddOns

      CreateUserPoolRequest.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)

      User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool.

      Parameters:
      userPoolAddOns - User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPoolAddOns

      default CreateUserPoolRequest.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)

      User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool.

      This is a convenience method that creates an instance of the UserPoolAddOnsType.Builder avoiding the need to create one manually via UserPoolAddOnsType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userPoolAddOns(UserPoolAddOnsType).

      Parameters:
      userPoolAddOns - a consumer that will call methods on UserPoolAddOnsType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • usernameConfiguration

      CreateUserPoolRequest.Builder usernameConfiguration(UsernameConfigurationType usernameConfiguration)

      Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to 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 (case insensitive) 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.

      This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

      Parameters:
      usernameConfiguration - Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to 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 (case insensitive) 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.

      This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usernameConfiguration

      default CreateUserPoolRequest.Builder usernameConfiguration(Consumer<UsernameConfigurationType.Builder> usernameConfiguration)

      Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to 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 (case insensitive) 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.

      This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

      This is a convenience method that creates an instance of the UsernameConfigurationType.Builder avoiding the need to create one manually via UsernameConfigurationType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to usernameConfiguration(UsernameConfigurationType).

      Parameters:
      usernameConfiguration - a consumer that will call methods on UsernameConfigurationType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • accountRecoverySetting

      CreateUserPoolRequest.Builder accountRecoverySetting(AccountRecoverySettingType 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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountRecoverySetting

      default CreateUserPoolRequest.Builder accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> 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.

      This is a convenience method that creates an instance of the AccountRecoverySettingType.Builder avoiding the need to create one manually via AccountRecoverySettingType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accountRecoverySetting(AccountRecoverySettingType).

      Parameters:
      accountRecoverySetting - a consumer that will call methods on AccountRecoverySettingType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateUserPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateUserPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.