Interface CreateUserPoolRequest.Builder

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

  • Method Details

    • poolName

      CreateUserPoolRequest.Builder poolName(String poolName)

      A friendly name for your user pool.

      Parameters:
      poolName - A friendly name for your user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policies

      CreateUserPoolRequest.Builder policies(UserPoolPolicyType policies)

      The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.

      Parameters:
      policies - The password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.
      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 password policy and sign-in policy in the user pool. The password policy sets options like password complexity requirements and password history. The sign-in policy sets the options available to applications in choice-based authentication.

      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)

      A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

      Parameters:
      lambdaConfig - A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lambdaConfig

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

      A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of authentication operations. Triggers can modify the outcome of the operations that invoked them.

      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 that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.

      Parameters:
      autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoVerifiedAttributesWithStrings

      CreateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)

      The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.

      Parameters:
      autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoVerifiedAttributes

      CreateUserPoolRequest.Builder autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)

      The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.

      Parameters:
      autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoVerifiedAttributes

      CreateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)

      The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.

      Parameters:
      autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. For more information, see Verifying contact information at sign-up.
      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. For more information about alias attributes, see Customizing sign-in attributes.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. For more information about alias attributes, see Customizing sign-in attributes.
      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. For more information about alias attributes, see Customizing sign-in attributes.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. For more information about alias attributes, see Customizing sign-in attributes.
      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. For more information about alias attributes, see Customizing sign-in attributes.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. For more information about alias attributes, see Customizing sign-in attributes.
      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. For more information about alias attributes, see Customizing sign-in attributes.

      Parameters:
      aliasAttributes - Attributes supported as an alias for this user pool. For more information about alias attributes, see Customizing sign-in attributes.
      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. For more information, see Customizing sign-in attributes.

      Parameters:
      usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up. For more information, see Customizing sign-in attributes.
      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. For more information, see Customizing sign-in attributes.

      Parameters:
      usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up. For more information, see Customizing sign-in attributes.
      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. For more information, see Customizing sign-in attributes.

      Parameters:
      usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up. For more information, see Customizing sign-in attributes.
      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. For more information, see Customizing sign-in attributes.

      Parameters:
      usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up. For more information, see Customizing sign-in attributes.
      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.

      Parameters:
      smsVerificationMessage - This parameter is no longer used.
      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.

      Parameters:
      emailVerificationMessage - This parameter is no longer used.
      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.

      Parameters:
      emailVerificationSubject - This parameter is no longer used.
      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 your user pool delivers to users who set an email address or phone number attribute.

      Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

      Parameters:
      verificationMessageTemplate - The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

      Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

      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 your user pool delivers to users who set an email address or phone number attribute.

      Set the email message type that corresponds to your DefaultEmailOption selection. For CONFIRM_WITH_LINK, specify an EmailMessageByLink and leave EmailMessage blank. For CONFIRM_WITH_CODE, specify an EmailMessage and leave EmailMessageByLink blank. When you supply both parameters with either choice, Amazon Cognito returns an error.

      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)

      The contents of the SMS message that your user pool sends to users in SMS OTP and MFA authentication.

      Parameters:
      smsAuthenticationMessage - The contents of the SMS message that your user pool sends to users in SMS OTP and MFA authentication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • mfaConfiguration

      CreateUserPoolRequest.Builder mfaConfiguration(String mfaConfiguration)

      Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.

      When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

      Parameters:
      mfaConfiguration - Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.

      When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

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

    • mfaConfiguration

      CreateUserPoolRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

      Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.

      When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

      Parameters:
      mfaConfiguration - Sets multi-factor authentication (MFA) to be on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.

      When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.

      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. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your 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. For more information, see Working with devices.

      Parameters:
      deviceConfiguration - The device-remembering configuration for a user pool. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your 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. For more information, see Working with devices.

      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. Device remembering or device tracking is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your 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. For more information, see Working with devices.

      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 settings for your Amazon Cognito user pool to send SMS messages with 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. For more information see SMS message settings.

      Parameters:
      smsConfiguration - The settings for your Amazon Cognito user pool to send SMS messages with 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. For more information see SMS message settings.
      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 settings for your Amazon Cognito user pool to send SMS messages with 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. For more information see SMS message settings.

      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 administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.

      Parameters:
      adminCreateUserConfig - The configuration for administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.
      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 administrative creation of users. Includes the template for the invitation message for new users, the duration of temporary passwords, and permitting self-service sign-up.

      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 attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes.

      Parameters:
      schema - An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user 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 attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user attributes.

      Parameters:
      schema - An array of attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user 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 attributes for the new user pool. You can add custom attributes and modify the properties of default attributes. The specifications in this parameter set the required attributes in your user pool. For more information, see Working with user 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)

      Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.

      Parameters:
      userPoolAddOns - Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.

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

    • userPoolAddOns

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

      Contains settings for activation of threat protection, including the operating mode and additional authentication types. To log user security information but take no action, set to AUDIT. To configure automatic security responses to potentially unwanted traffic to your user pool, set to ENFORCED.

      For more information, see Adding advanced security to a user pool. To activate this setting, your user pool must be on the Plus tier.

      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)

      Sets the case sensitivity option for sign-in usernames. When CaseSensitive is 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 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.

      When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

      This configuration is immutable after you set it.

      Parameters:
      usernameConfiguration - Sets the case sensitivity option for sign-in usernames. When CaseSensitive is 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 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.

      When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

      This configuration is immutable after you set it.

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

    • usernameConfiguration

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

      Sets the case sensitivity option for sign-in usernames. When CaseSensitive is 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 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.

      When CaseSensitive is true (case sensitive), Amazon Cognito interprets USERNAME and UserName as distinct users.

      This configuration is immutable after you set it.

      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. Email MFA is also disqualifying for account recovery with email. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

      As a best practice, configure both verified_email and verified_phone_number, with one having a higher priority than the other.

      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. Email MFA is also disqualifying for account recovery with email. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

      As a best practice, configure both verified_email and verified_phone_number, with one having a higher priority than the other.

      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. Email MFA is also disqualifying for account recovery with email. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

      As a best practice, configure both verified_email and verified_phone_number, with one having a higher priority than the other.

      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:

    • userPoolTier

      CreateUserPoolRequest.Builder userPoolTier(String userPoolTier)

      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. Defaults to ESSENTIALS.

      Parameters:
      userPoolTier - 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. Defaults to ESSENTIALS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userPoolTier

      CreateUserPoolRequest.Builder userPoolTier(UserPoolTierType userPoolTier)

      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. Defaults to ESSENTIALS.

      Parameters:
      userPoolTier - 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. Defaults to ESSENTIALS.
      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.