UserPoolType.Builder (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.18.31 API)

All Superinterfaces:

Buildable, CopyableBuilder<UserPoolType.Builder,UserPoolType>, SdkBuilder<UserPoolType.Builder,UserPoolType>, SdkPojo

Enclosing class:

UserPoolType
```
public static interface UserPoolType.Builder
extends SdkPojo, CopyableBuilder<UserPoolType.Builder,UserPoolType>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`UserPoolType.Builder`	`accountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)` The available verified method a user can use to recover their password when they call `ForgotPassword`.
`default UserPoolType.Builder`	`accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> accountRecoverySetting)` The available verified method a user can use to recover their password when they call `ForgotPassword`.
`UserPoolType.Builder`	`adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`default UserPoolType.Builder`	`adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)` The configuration for `AdminCreateUser` requests.
`UserPoolType.Builder`	`aliasAttributes(AliasAttributeType... aliasAttributes)` The attributes that are aliased in a user pool.
`UserPoolType.Builder`	`aliasAttributes(Collection<AliasAttributeType> aliasAttributes)` The attributes that are aliased in a user pool.
`UserPoolType.Builder`	`aliasAttributesWithStrings(Collection<String> aliasAttributes)` The attributes that are aliased in a user pool.
`UserPoolType.Builder`	`aliasAttributesWithStrings(String... aliasAttributes)` The attributes that are aliased in a user pool.
`UserPoolType.Builder`	`arn(String arn)` The Amazon Resource Name (ARN) for the user pool.
`UserPoolType.Builder`	`autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes)` The attributes that are auto-verified in a user pool.
`UserPoolType.Builder`	`autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)` The attributes that are auto-verified in a user pool.
`UserPoolType.Builder`	`autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes)` The attributes that are auto-verified in a user pool.
`UserPoolType.Builder`	`autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes)` The attributes that are auto-verified in a user pool.
`UserPoolType.Builder`	`creationDate(Instant creationDate)` The date the user pool was created.
`UserPoolType.Builder`	`customDomain(String customDomain)` A custom domain name that you provide to Amazon Cognito.
`UserPoolType.Builder`	`deletionProtection(DeletionProtectionType deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`UserPoolType.Builder`	`deletionProtection(String deletionProtection)` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`default UserPoolType.Builder`	`deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)` The device-remembering configuration for a user pool.
`UserPoolType.Builder`	`deviceConfiguration(DeviceConfigurationType deviceConfiguration)` The device-remembering configuration for a user pool.
`UserPoolType.Builder`	`domain(String domain)` The domain prefix, if the user pool has a domain associated with it.
`default UserPoolType.Builder`	`emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)` The email configuration of your user pool.
`UserPoolType.Builder`	`emailConfiguration(EmailConfigurationType emailConfiguration)` The email configuration of your user pool.
`UserPoolType.Builder`	`emailConfigurationFailure(String emailConfigurationFailure)` Deprecated.
`UserPoolType.Builder`	`emailVerificationMessage(String emailVerificationMessage)` This parameter is no longer used.
`UserPoolType.Builder`	`emailVerificationSubject(String emailVerificationSubject)` This parameter is no longer used.
`UserPoolType.Builder`	`estimatedNumberOfUsers(Integer estimatedNumberOfUsers)` A number estimating the size of the user pool.
`UserPoolType.Builder`	`id(String id)` The ID of the user pool.
`default UserPoolType.Builder`	`lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)` The Lambda triggers associated with the user pool.
`UserPoolType.Builder`	`lambdaConfig(LambdaConfigType lambdaConfig)` The Lambda triggers associated with the user pool.
`UserPoolType.Builder`	`lastModifiedDate(Instant lastModifiedDate)` The date the user pool was last modified.
`UserPoolType.Builder`	`mfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`UserPoolType.Builder`	`mfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`UserPoolType.Builder`	`name(String name)` The name of the user pool.
`default UserPoolType.Builder`	`policies(Consumer<UserPoolPolicyType.Builder> policies)` The policies associated with the user pool.
`UserPoolType.Builder`	`policies(UserPoolPolicyType policies)` The policies associated with the user pool.
`UserPoolType.Builder`	`schemaAttributes(Collection<SchemaAttributeType> schemaAttributes)` A container with the schema attributes of a user pool.
`UserPoolType.Builder`	`schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes)` A container with the schema attributes of a user pool.
`UserPoolType.Builder`	`schemaAttributes(SchemaAttributeType... schemaAttributes)` A container with the schema attributes of a user pool.
`UserPoolType.Builder`	`smsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`default UserPoolType.Builder`	`smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`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.
`UserPoolType.Builder`	`smsConfigurationFailure(String smsConfigurationFailure)` The reason why the SMS configuration can't send the messages to your users.
`UserPoolType.Builder`	`smsVerificationMessage(String smsVerificationMessage)` This parameter is no longer used.
`UserPoolType.Builder`	`status(StatusType status)` The status of a user pool.
`UserPoolType.Builder`	`status(String status)` The status of a user pool.
`default UserPoolType.Builder`	`userAttributeUpdateSettings(Consumer<UserAttributeUpdateSettingsType.Builder> userAttributeUpdateSettings)` The settings for updates to user attributes.
`UserPoolType.Builder`	`userAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)` The settings for updates to user attributes.
`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.
`UserPoolType.Builder`	`usernameAttributes(UsernameAttributeType... usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`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.
`UserPoolType.Builder`	`usernameAttributesWithStrings(String... usernameAttributes)` Specifies whether a user can use an email address or phone number as a username when they sign up.
`default UserPoolType.Builder`	`usernameConfiguration(Consumer<UsernameConfigurationType.Builder> usernameConfiguration)` Case sensitivity of the username input for the selected sign-in option.
`UserPoolType.Builder`	`usernameConfiguration(UsernameConfigurationType usernameConfiguration)` Case sensitivity of the username input for the selected sign-in option.
`default UserPoolType.Builder`	`userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)` The user pool add-ons.
`UserPoolType.Builder`	`userPoolAddOns(UserPoolAddOnsType userPoolAddOns)` The user pool add-ons.
`UserPoolType.Builder`	`userPoolTags(Map<String,String> userPoolTags)` The tags that are assigned to the user pool.
`default UserPoolType.Builder`	`verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)` The template for verification messages.
`UserPoolType.Builder`	`verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)` The template for verification messages.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- 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.
  - policies
```
default UserPoolType.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)
```
    The policies associated with the user pool.
    This is a convenience method that creates an instance of the UserPoolPolicyType.Builder avoiding the need to create one manually via UserPoolPolicyType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policies(UserPoolPolicyType).
    
    Parameters:
    
    policies - a consumer that will call methods on UserPoolPolicyType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    policies(UserPoolPolicyType)
  - 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.
  - lambdaConfig
```
default UserPoolType.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)
```
    The Lambda triggers associated with the user pool.
    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:
    
    lambdaConfig(LambdaConfigType)
  - status
```
UserPoolType.Builder status(String status)
```
    The status of a user pool.
    
    Parameters:
    
    status - The status of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusType, StatusType
  - status
```
UserPoolType.Builder status(StatusType status)
```
    The status of a user pool.
    
    Parameters:
    
    status - The status of a user pool.
    
    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 the user pool was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the user pool was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - creationDate
```
UserPoolType.Builder creationDate(Instant creationDate)
```
    The date the user pool was created.
    
    Parameters:
    
    creationDate - The date the user pool was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schemaAttributes
```
UserPoolType.Builder schemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Parameters:
    
    schemaAttributes - A container with the schema attributes of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schemaAttributes
```
UserPoolType.Builder schemaAttributes(SchemaAttributeType... schemaAttributes)
```
    A container with the schema attributes of a user pool.
    
    Parameters:
    
    schemaAttributes - A container with the schema attributes of a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schemaAttributes
```
UserPoolType.Builder schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes)
```
    A container with the schema attributes of a user pool.
    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.
  - smsVerificationMessage
```
UserPoolType.Builder smsVerificationMessage(String smsVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - emailVerificationMessage
```
UserPoolType.Builder emailVerificationMessage(String emailVerificationMessage)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - emailVerificationSubject
```
UserPoolType.Builder emailVerificationSubject(String emailVerificationSubject)
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Parameters:
    
    emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - verificationMessageTemplate
```
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.
  - verificationMessageTemplate
```
default UserPoolType.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)
```
    The template for verification messages.
    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:
    
    verificationMessageTemplate(VerificationMessageTemplateType)
  - 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.
  - userAttributeUpdateSettings
```
default UserPoolType.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:
    
    userAttributeUpdateSettings(UserAttributeUpdateSettingsType)
  - 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.
  - deviceConfiguration
```
default UserPoolType.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)
```
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    This is a convenience method that creates an instance of the DeviceConfigurationType.Builder avoiding the need to create one manually via DeviceConfigurationType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfiguration(DeviceConfigurationType).
    
    Parameters:
    
    deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    deviceConfiguration(DeviceConfigurationType)
  - 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 tfrom 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 tfrom your user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - emailConfiguration
```
default UserPoolType.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 tfrom 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:
    
    emailConfiguration(EmailConfigurationType)
  - 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.
  - smsConfiguration
```
default UserPoolType.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    This is a convenience method that creates an instance of the SmsConfigurationType.Builder avoiding the need to create one manually via SmsConfigurationType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsConfiguration(SmsConfigurationType).
    
    Parameters:
    
    smsConfiguration - a consumer that will call methods on SmsConfigurationType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    smsConfiguration(SmsConfigurationType)
  - 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 IAM 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 IAM 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.
  - adminCreateUserConfig
```
default UserPoolType.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)
```
    The configuration for AdminCreateUser requests.
    This is a convenience method that creates an instance of the AdminCreateUserConfigType.Builder avoiding the need to create one manually via AdminCreateUserConfigType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to adminCreateUserConfig(AdminCreateUserConfigType).
    
    Parameters:
    
    adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    adminCreateUserConfig(AdminCreateUserConfigType)
  - userPoolAddOns
```
UserPoolType.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)
```
    The user pool add-ons.
    
    Parameters:
    
    userPoolAddOns - The user pool add-ons.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - userPoolAddOns
```
default UserPoolType.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)
```
    The user pool add-ons.
    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:
    
    userPoolAddOns(UserPoolAddOnsType)
  - 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.
  - usernameConfiguration
```
default UserPoolType.Builder usernameConfiguration(Consumer<UsernameConfigurationType.Builder> 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.
    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:
    
    usernameConfiguration(UsernameConfigurationType)
  - 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.
  - accountRecoverySetting
```
default UserPoolType.Builder accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> accountRecoverySetting)
```
    The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    This is a convenience method that creates an instance of the AccountRecoverySettingType.Builder avoiding the need to create one manually via AccountRecoverySettingType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accountRecoverySetting(AccountRecoverySettingType).
    
    Parameters:
    
    accountRecoverySetting - a consumer that will call methods on AccountRecoverySettingType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    accountRecoverySetting(AccountRecoverySettingType)

Interface UserPoolType.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

id

name

policies

policies

deletionProtection

deletionProtection

lambdaConfig

lambdaConfig

status

status

lastModifiedDate

creationDate

schemaAttributes

schemaAttributes

schemaAttributes

autoVerifiedAttributesWithStrings

autoVerifiedAttributesWithStrings

autoVerifiedAttributes

autoVerifiedAttributes

aliasAttributesWithStrings

aliasAttributesWithStrings

aliasAttributes

aliasAttributes

usernameAttributesWithStrings

usernameAttributesWithStrings

usernameAttributes

usernameAttributes

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

verificationMessageTemplate

smsAuthenticationMessage

userAttributeUpdateSettings

userAttributeUpdateSettings

mfaConfiguration

mfaConfiguration

deviceConfiguration

deviceConfiguration

estimatedNumberOfUsers

emailConfiguration

emailConfiguration

smsConfiguration

smsConfiguration

userPoolTags

smsConfigurationFailure

emailConfigurationFailure

domain

customDomain

adminCreateUserConfig

adminCreateUserConfig

userPoolAddOns

userPoolAddOns

usernameConfiguration

usernameConfiguration

arn

accountRecoverySetting

accountRecoverySetting