Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface CreateUserPoolRequest.Builder

    • Method Detail

      • poolName

        CreateUserPoolRequest.Builder poolName​(String poolName)

        A friendlhy name for your user pool.

        Parameters:
        poolName - A friendlhy 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.

      • 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:
        DeletionProtectionType, DeletionProtectionType

      • 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:
        DeletionProtectionType, DeletionProtectionType

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

      • autoVerifiedAttributesWithStrings

        CreateUserPoolRequest.Builder autoVerifiedAttributesWithStrings​(String... autoVerifiedAttributes)

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

        Parameters:
        autoVerifiedAttributes - The attributes that you want your user pool to automatically verify. Possible values: email, phone_number. 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. Possible values: phone_number, email, or preferred_username. For more information about alias attributes, see Customizing sign-in attributes.

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

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

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

        Parameters:
        aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username. 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​(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.

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

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

        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.

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

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

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

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

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

        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 infor

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

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

      • 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. For more information see SMS message settings.

        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. For more information see SMS message settings.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • 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. 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 AdminCreateUser requests. 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.

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

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

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

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

      • 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:
        UserPoolTierType, UserPoolTierType

      • 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:
        UserPoolTierType, UserPoolTierType