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

Interface CreateUserPoolRequest.Builder

    • Method Detail

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

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

        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.

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

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

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

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

        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.

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

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

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

        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.

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