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

Interface UserPoolType.Builder

    • Method Detail

      • id

        UserPoolType.Builder id​(String id)

        The ID of the user pool.

        Parameters:
        id - The ID of the user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        UserPoolType.Builder name​(String name)

        The name of the user pool.

        Parameters:
        name - The name of the user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • policies

        UserPoolType.Builder policies​(UserPoolPolicyType policies)

        The policies associated with the user pool.

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

      • deletionProtection

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

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

        UserPoolType.Builder lambdaConfig​(LambdaConfigType lambdaConfig)

        The Lambda triggers associated with the user pool.

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

      • status

        @Deprecated
UserPoolType.Builder status​(String status)
        Deprecated.
        This property is no longer available.

        This parameter is no longer used.

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

      • status

        @Deprecated
UserPoolType.Builder status​(StatusType status)
        Deprecated.
        This property is no longer available.

        This parameter is no longer used.

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

      • lastModifiedDate

        UserPoolType.Builder lastModifiedDate​(Instant lastModifiedDate)

        The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

        Parameters:
        lastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        UserPoolType.Builder creationDate​(Instant creationDate)

        The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

        Parameters:
        creationDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schemaAttributes

        UserPoolType.Builder schemaAttributes​(Collection<SchemaAttributeType> schemaAttributes)

        A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

        Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

        Parameters:
        schemaAttributes - A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

        Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

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

      • schemaAttributes

        UserPoolType.Builder schemaAttributes​(SchemaAttributeType... schemaAttributes)

        A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

        Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

        Parameters:
        schemaAttributes - A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

        Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

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

      • schemaAttributes

        UserPoolType.Builder schemaAttributes​(Consumer<SchemaAttributeType.Builder>... schemaAttributes)

        A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

        Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

        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 #schemaAttributes(List).

        Parameters:
        schemaAttributes - 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:
        #schemaAttributes(java.util.Collection)

      • autoVerifiedAttributesWithStrings

        UserPoolType.Builder autoVerifiedAttributesWithStrings​(Collection<String> autoVerifiedAttributes)

        The attributes that are auto-verified in a user pool.

        Parameters:
        autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoVerifiedAttributesWithStrings

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

        The attributes that are auto-verified in a user pool.

        Parameters:
        autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoVerifiedAttributes

        UserPoolType.Builder autoVerifiedAttributes​(Collection<VerifiedAttributeType> autoVerifiedAttributes)

        The attributes that are auto-verified in a user pool.

        Parameters:
        autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoVerifiedAttributes

        UserPoolType.Builder autoVerifiedAttributes​(VerifiedAttributeType... autoVerifiedAttributes)

        The attributes that are auto-verified in a user pool.

        Parameters:
        autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aliasAttributesWithStrings

        UserPoolType.Builder aliasAttributesWithStrings​(Collection<String> aliasAttributes)

        The attributes that are aliased in a user pool.

        Parameters:
        aliasAttributes - The attributes that are aliased in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aliasAttributesWithStrings

        UserPoolType.Builder aliasAttributesWithStrings​(String... aliasAttributes)

        The attributes that are aliased in a user pool.

        Parameters:
        aliasAttributes - The attributes that are aliased in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aliasAttributes

        UserPoolType.Builder aliasAttributes​(Collection<AliasAttributeType> aliasAttributes)

        The attributes that are aliased in a user pool.

        Parameters:
        aliasAttributes - The attributes that are aliased in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aliasAttributes

        UserPoolType.Builder aliasAttributes​(AliasAttributeType... aliasAttributes)

        The attributes that are aliased in a user pool.

        Parameters:
        aliasAttributes - The attributes that are aliased in a user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • usernameAttributesWithStrings

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

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

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

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

        UserPoolType.Builder verificationMessageTemplate​(VerificationMessageTemplateType verificationMessageTemplate)

        The template for verification messages.

        Parameters:
        verificationMessageTemplate - The template for verification messages.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • smsAuthenticationMessage

        UserPoolType.Builder smsAuthenticationMessage​(String smsAuthenticationMessage)

        The contents of the SMS authentication message.

        Parameters:
        smsAuthenticationMessage - The contents of the SMS authentication message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userAttributeUpdateSettings

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

      • mfaConfiguration

        UserPoolType.Builder mfaConfiguration​(String mfaConfiguration)

        Can be one of the following values:

        • OFF - MFA tokens aren't required and can't be specified during user registration.

        • ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

        • OPTIONAL - Users have the option when registering to create an MFA token.

        Parameters:
        mfaConfiguration - Can be one of the following values:

        • OFF - MFA tokens aren't required and can't be specified during user registration.

        • ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

        • OPTIONAL - Users have the option when registering to create an MFA token.

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

      • mfaConfiguration

        UserPoolType.Builder mfaConfiguration​(UserPoolMfaType mfaConfiguration)

        Can be one of the following values:

        • OFF - MFA tokens aren't required and can't be specified during user registration.

        • ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

        • OPTIONAL - Users have the option when registering to create an MFA token.

        Parameters:
        mfaConfiguration - Can be one of the following values:

        • OFF - MFA tokens aren't required and can't be specified during user registration.

        • ON - MFA tokens are required for all user registrations. You can only specify required when you're initially creating a user pool.

        • OPTIONAL - Users have the option when registering to create an MFA token.

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

      • deviceConfiguration

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

      • estimatedNumberOfUsers

        UserPoolType.Builder estimatedNumberOfUsers​(Integer estimatedNumberOfUsers)

        A number estimating the size of the user pool.

        Parameters:
        estimatedNumberOfUsers - A number estimating the size of the user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • emailConfiguration

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

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

        UserPoolType.Builder userPoolTags​(Map<String,​String> userPoolTags)

        The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

        Parameters:
        userPoolTags - The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them 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.

      • smsConfigurationFailure

        UserPoolType.Builder smsConfigurationFailure​(String smsConfigurationFailure)

        The reason why the SMS configuration can't send the messages to your users.

        This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

        InvalidSmsRoleAccessPolicyException

        The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

        SNSSandbox

        The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

        Parameters:
        smsConfigurationFailure - The reason why the SMS configuration can't send the messages to your users.

        This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

        InvalidSmsRoleAccessPolicyException

        The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

        SNSSandbox

        The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

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

      • emailConfigurationFailure

        UserPoolType.Builder emailConfigurationFailure​(String emailConfigurationFailure)

        Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

        Parameters:
        emailConfigurationFailure - Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domain

        UserPoolType.Builder domain​(String domain)

        The domain prefix, if the user pool has a domain associated with it.

        Parameters:
        domain - The domain prefix, if the user pool has a domain associated with it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDomain

        UserPoolType.Builder customDomain​(String customDomain)

        A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

        For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

        Parameters:
        customDomain - A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

        For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

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

      • adminCreateUserConfig

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

      • userPoolAddOns

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

        UserPoolType.Builder usernameConfiguration​(UsernameConfigurationType usernameConfiguration)

        Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

        Parameters:
        usernameConfiguration - Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • arn

        UserPoolType.Builder arn​(String arn)

        The Amazon Resource Name (ARN) for the user pool.

        Parameters:
        arn - The Amazon Resource Name (ARN) for the user pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accountRecoverySetting

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