UserPoolType (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.UserPoolType

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<UserPoolType.Builder,UserPoolType>

@Generated(value="software.amazon.awssdk:codegen")
public final class UserPoolType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserPoolType.Builder,UserPoolType>

A container for information about the user pool.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserPoolType.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserPoolType.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountRecoverySettingType`	`accountRecoverySetting()` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`AdminCreateUserConfigType`	`adminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<AliasAttributeType>`	`aliasAttributes()` Specifies the attributes that are aliased in a user pool.
`List<String>`	`aliasAttributesAsStrings()` Specifies the attributes that are aliased in a user pool.
`String`	`arn()` The Amazon Resource Name (ARN) for the user pool.
`List<VerifiedAttributeType>`	`autoVerifiedAttributes()` Specifies the attributes that are auto-verified in a user pool.
`List<String>`	`autoVerifiedAttributesAsStrings()` Specifies the attributes that are auto-verified in a user pool.
`static UserPoolType.Builder`	`builder()`
`Instant`	`creationDate()` The date the user pool was created.
`String`	`customDomain()` A custom domain name that you provide to Amazon Cognito.
`DeviceConfigurationType`	`deviceConfiguration()` The device configuration.
`String`	`domain()` Holds the domain prefix if the user pool has a domain associated with it.
`EmailConfigurationType`	`emailConfiguration()` The email configuration.
`String`	`emailConfigurationFailure()` The reason why the email configuration cannot send the messages to your users.
`String`	`emailVerificationMessage()` The contents of the email verification message.
`String`	`emailVerificationSubject()` The subject of the email verification message.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`Integer`	`estimatedNumberOfUsers()` A number estimating the size of the user pool.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAliasAttributes()` Returns true if the AliasAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAutoVerifiedAttributes()` Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSchemaAttributes()` Returns true if the SchemaAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUsernameAttributes()` Returns true if the UsernameAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserPoolTags()` Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`id()` The ID of the user pool.
`LambdaConfigType`	`lambdaConfig()` The AWS Lambda triggers associated with the user pool.
`Instant`	`lastModifiedDate()` The date the user pool was last modified.
`UserPoolMfaType`	`mfaConfiguration()` Can be one of the following values:
`String`	`mfaConfigurationAsString()` Can be one of the following values:
`String`	`name()` The name of the user pool.
`UserPoolPolicyType`	`policies()` The policies associated with the user pool.
`List<SchemaAttributeType>`	`schemaAttributes()` A container with the schema attributes of a user pool.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserPoolType.Builder>`	`serializableBuilderClass()`
`String`	`smsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`smsConfiguration()` The SMS configuration.
`String`	`smsConfigurationFailure()` The reason why the SMS configuration cannot send the messages to your users.
`String`	`smsVerificationMessage()` The contents of the SMS verification message.
`StatusType`	`status()` The status of a user pool.
`String`	`statusAsString()` The status of a user pool.
`UserPoolType.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`List<UsernameAttributeType>`	`usernameAttributes()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`List<String>`	`usernameAttributesAsStrings()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UsernameConfigurationType`	`usernameConfiguration()` You can choose to enable case sensitivity on the username input for the selected sign-in option.
`UserPoolAddOnsType`	`userPoolAddOns()` The user pool add-ons.
`Map<String,String>`	`userPoolTags()` The tags that are assigned to the user pool.
`VerificationMessageTemplateType`	`verificationMessageTemplate()` The template for verification messages.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - id
```
public final String id()
```
    The ID of the user pool.
    
    Returns:
    
    The ID of the user pool.
  - name
```
public final String name()
```
    The name of the user pool.
    
    Returns:
    
    The name of the user pool.
  - policies
```
public final UserPoolPolicyType policies()
```
    The policies associated with the user pool.
    
    Returns:
    
    The policies associated with the user pool.
  - lambdaConfig
```
public final LambdaConfigType lambdaConfig()
```
    The AWS Lambda triggers associated with the user pool.
    
    Returns:
    
    The AWS Lambda triggers associated with the user pool.
  - status
```
public final StatusType status()
```
    The status of a user pool.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a user pool.
    
    See Also:
    
    StatusType
  - statusAsString
```
public final String statusAsString()
```
    The status of a user pool.
    
    If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a user pool.
    
    See Also:
    
    StatusType
  - lastModifiedDate
```
public final Instant lastModifiedDate()
```
    The date the user pool was last modified.
    
    Returns:
    
    The date the user pool was last modified.
  - creationDate
```
public final Instant creationDate()
```
    The date the user pool was created.
    
    Returns:
    
    The date the user pool was created.
  - hasSchemaAttributes
```
public final boolean hasSchemaAttributes()
```
    Returns true if the SchemaAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - schemaAttributes
```
public final List<SchemaAttributeType> schemaAttributes()
```
    A container with the schema attributes of a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSchemaAttributes() to see if a value was sent in this field.
    
    Returns:
    
    A container with the schema attributes of a user pool.
  - autoVerifiedAttributes
```
public final List<VerifiedAttributeType> autoVerifiedAttributes()
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAutoVerifiedAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the attributes that are auto-verified in a user pool.
  - hasAutoVerifiedAttributes
```
public final boolean hasAutoVerifiedAttributes()
```
    Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - autoVerifiedAttributesAsStrings
```
public final List<String> autoVerifiedAttributesAsStrings()
```
    Specifies the attributes that are auto-verified in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAutoVerifiedAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the attributes that are auto-verified in a user pool.
  - aliasAttributes
```
public final List<AliasAttributeType> aliasAttributes()
```
    Specifies the attributes that are aliased in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAliasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the attributes that are aliased in a user pool.
  - hasAliasAttributes
```
public final boolean hasAliasAttributes()
```
    Returns true if the AliasAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - aliasAttributesAsStrings
```
public final List<String> aliasAttributesAsStrings()
```
    Specifies the attributes that are aliased in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAliasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies the attributes that are aliased in a user pool.
  - usernameAttributes
```
public final List<UsernameAttributeType> usernameAttributes()
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUsernameAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - hasUsernameAttributes
```
public final boolean hasUsernameAttributes()
```
    Returns true if the UsernameAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - usernameAttributesAsStrings
```
public final List<String> usernameAttributesAsStrings()
```
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUsernameAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - smsVerificationMessage
```
public final String smsVerificationMessage()
```
    The contents of the SMS verification message.
    
    Returns:
    
    The contents of the SMS verification message.
  - emailVerificationMessage
```
public final String emailVerificationMessage()
```
    The contents of the email verification message.
    
    Returns:
    
    The contents of the email verification message.
  - emailVerificationSubject
```
public final String emailVerificationSubject()
```
    The subject of the email verification message.
    
    Returns:
    
    The subject of the email verification message.
  - verificationMessageTemplate
```
public final VerificationMessageTemplateType verificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - smsAuthenticationMessage
```
public final String smsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Returns:
    
    The contents of the SMS authentication message.
  - mfaConfiguration
```
public final UserPoolMfaType mfaConfiguration()
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().
    Returns:
    Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - mfaConfigurationAsString
```
public final String mfaConfigurationAsString()
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().
    Returns:
    Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - deviceConfiguration
```
public final DeviceConfigurationType deviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - estimatedNumberOfUsers
```
public final Integer estimatedNumberOfUsers()
```
    A number estimating the size of the user pool.
    
    Returns:
    
    A number estimating the size of the user pool.
  - emailConfiguration
```
public final EmailConfigurationType emailConfiguration()
```
    The email configuration.
    
    Returns:
    
    The email configuration.
  - smsConfiguration
```
public final SmsConfigurationType smsConfiguration()
```
    The SMS configuration.
    
    Returns:
    
    The SMS configuration.
  - hasUserPoolTags
```
public final boolean hasUserPoolTags()
```
    Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userPoolTags
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserPoolTags() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - smsConfigurationFailure
```
public final String smsConfigurationFailure()
```
    The reason why the SMS configuration cannot send the messages to your users.
    
    Returns:
    
    The reason why the SMS configuration cannot send the messages to your users.
  - emailConfigurationFailure
```
public final String emailConfigurationFailure()
```
    The reason why the email configuration cannot send the messages to your users.
    
    Returns:
    
    The reason why the email configuration cannot send the messages to your users.
  - domain
```
public final String domain()
```
    Holds the domain prefix if the user pool has a domain associated with it.
    
    Returns:
    
    Holds the domain prefix if the user pool has a domain associated with it.
  - customDomain
```
public final 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. For example: 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:
    
    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. For example: auth.example.com.
    
    For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
  - adminCreateUserConfig
```
public final AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - userPoolAddOns
```
public final UserPoolAddOnsType userPoolAddOns()
```
    The user pool add-ons.
    
    Returns:
    
    The user pool add-ons.
  - usernameConfiguration
```
public final UsernameConfigurationType usernameConfiguration()
```
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
    
    Returns:
    
    You can choose to enable case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) for the user pool.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the user pool.
  - accountRecoverySetting
```
public final AccountRecoverySettingType accountRecoverySetting()
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns:
    
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - toBuilder
```
public UserPoolType.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserPoolType.Builder,UserPoolType>
    
    Returns:
    
    a builder for type T
  - builder
```
public static UserPoolType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserPoolType.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.62

Class UserPoolType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

name

policies

lambdaConfig

status

statusAsString

lastModifiedDate

creationDate

hasSchemaAttributes

schemaAttributes

autoVerifiedAttributes

hasAutoVerifiedAttributes

autoVerifiedAttributesAsStrings

aliasAttributes

hasAliasAttributes

aliasAttributesAsStrings

usernameAttributes

hasUsernameAttributes

usernameAttributesAsStrings

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

smsAuthenticationMessage

mfaConfiguration

mfaConfigurationAsString

deviceConfiguration

estimatedNumberOfUsers

emailConfiguration

smsConfiguration

hasUserPoolTags

userPoolTags

smsConfigurationFailure

emailConfigurationFailure

domain

customDomain

adminCreateUserConfig

userPoolAddOns

usernameConfiguration

arn

accountRecoverySetting

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields