UserPoolType (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.17.241 API)

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()` The available verified method a user can use to recover their password when they call `ForgotPassword` .
`AdminCreateUserConfigType`	`adminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<AliasAttributeType>`	`aliasAttributes()` The attributes that are aliased in a user pool.
`List<String>`	`aliasAttributesAsStrings()` The attributes that are aliased in a user pool.
`String`	`arn()` The Amazon Resource Name (ARN) for the user pool.
`List<VerifiedAttributeType>`	`autoVerifiedAttributes()` The attributes that are auto-verified in a user pool.
`List<String>`	`autoVerifiedAttributesAsStrings()` 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()` The domain prefix, if the user pool has a domain associated with it.
`EmailConfigurationType`	`emailConfiguration()` The email configuration of your user pool.
`String`	`emailConfigurationFailure()` Deprecated.
`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)`
`Integer`	`estimatedNumberOfUsers()` A number estimating the size of the user pool.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAliasAttributes()` For responses, this returns true if the service returned a value for the AliasAttributes property.
`boolean`	`hasAutoVerifiedAttributes()` For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property.
`int`	`hashCode()`
`boolean`	`hasSchemaAttributes()` For responses, this returns true if the service returned a value for the SchemaAttributes property.
`boolean`	`hasUsernameAttributes()` For responses, this returns true if the service returned a value for the UsernameAttributes property.
`boolean`	`hasUserPoolTags()` For responses, this returns true if the service returned a value for the UserPoolTags property.
`String`	`id()` The ID of the user pool.
`LambdaConfigType`	`lambdaConfig()` The 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 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.
`String`	`smsConfigurationFailure()` The reason why the SMS configuration can't 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()`
`String`	`toString()` Returns a string representation of this object.
`UserAttributeUpdateSettingsType`	`userAttributeUpdateSettings()` The settings for updates to user attributes.
`List<UsernameAttributeType>`	`usernameAttributes()` Specifies whether a user can use an email address or phone number as a username when they sign up.
`List<String>`	`usernameAttributesAsStrings()` Specifies whether a user can use an email address or phone number as a username when they sign up.
`UsernameConfigurationType`	`usernameConfiguration()` Case sensitivity of 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
clone, finalize, 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 Lambda triggers associated with the user pool.
    
    Returns:
    
    The 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()
```
    For responses, this returns true if the service returned a value for the SchemaAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSchemaAttributes() method.
    
    Returns:
    
    A container with the schema attributes of a user pool.
  - autoVerifiedAttributes
```
public final List<VerifiedAttributeType> autoVerifiedAttributes()
```
    The attributes that are auto-verified in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoVerifiedAttributes() method.
    
    Returns:
    
    The attributes that are auto-verified in a user pool.
  - hasAutoVerifiedAttributes
```
public final boolean hasAutoVerifiedAttributes()
```
    For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - autoVerifiedAttributesAsStrings
```
public final List<String> autoVerifiedAttributesAsStrings()
```
    The attributes that are auto-verified in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoVerifiedAttributes() method.
    
    Returns:
    
    The attributes that are auto-verified in a user pool.
  - aliasAttributes
```
public final List<AliasAttributeType> aliasAttributes()
```
    The attributes that are aliased in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAliasAttributes() method.
    
    Returns:
    
    The attributes that are aliased in a user pool.
  - hasAliasAttributes
```
public final boolean hasAliasAttributes()
```
    For responses, this returns true if the service returned a value for the AliasAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - aliasAttributesAsStrings
```
public final List<String> aliasAttributesAsStrings()
```
    The attributes that are aliased in a user pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAliasAttributes() method.
    
    Returns:
    
    The attributes that are aliased in a user pool.
  - usernameAttributes
```
public final List<UsernameAttributeType> usernameAttributes()
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsernameAttributes() method.
    
    Returns:
    
    Specifies whether a user can use an email address or phone number as a username when they sign up.
  - hasUsernameAttributes
```
public final boolean hasUsernameAttributes()
```
    For responses, this returns true if the service returned a value for the UsernameAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - usernameAttributesAsStrings
```
public final List<String> usernameAttributesAsStrings()
```
    Specifies whether a user can use an email address or phone number as a username when they sign up.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsernameAttributes() method.
    
    Returns:
    
    Specifies whether a user can use an email address or phone number as a username when they sign 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.
  - userAttributeUpdateSettings
```
public final 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 to email addresses and phone numbers.
    
    Returns:
    
    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 to email addresses and phone numbers.
  - mfaConfiguration
```
public final 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.
    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 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.
    See Also:
    
    UserPoolMfaType
  - mfaConfigurationAsString
```
public final String mfaConfigurationAsString()
```
    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.
    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 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.
    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 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:
    
    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.
  - smsConfiguration
```
public final 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.
    
    Returns:
    
    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.
  - hasUserPoolTags
```
public final boolean hasUserPoolTags()
```
    For responses, this returns true if the service returned a value for the UserPoolTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserPoolTags() method.
    
    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 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:
    
    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.
  - emailConfigurationFailure
```
public final 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.
    
    Returns:
    
    Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.
  - domain
```
public final String domain()
```
    The domain prefix, if the user pool has a domain associated with it.
    
    Returns:
    
    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. 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:
    
    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.
  - 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()
```
    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:
    
    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.
  - 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()
```
    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:
    
    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.
  - toBuilder
```
public UserPoolType.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserPoolType.Builder,UserPoolType>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

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

userAttributeUpdateSettings

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