UserPoolType (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.9.6 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
`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)`
`Integer`	`estimatedNumberOfUsers()` A number estimating the size of the user pool.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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()`
`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.
`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 String id()
```
    The ID of the user pool.
    
    Returns:
    
    The ID of the user pool.
  - name
```
public String name()
```
    The name of the user pool.
    
    Returns:
    
    The name of the user pool.
  - policies
```
public UserPoolPolicyType policies()
```
    The policies associated with the user pool.
    
    Returns:
    
    The policies associated with the user pool.
  - lambdaConfig
```
public LambdaConfigType lambdaConfig()
```
    The AWS Lambda triggers associated with the user pool.
    
    Returns:
    
    The AWS Lambda triggers associated with the user pool.
  - status
```
public 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 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 Instant lastModifiedDate()
```
    The date the user pool was last modified.
    
    Returns:
    
    The date the user pool was last modified.
  - creationDate
```
public Instant creationDate()
```
    The date the user pool was created.
    
    Returns:
    
    The date the user pool was created.
  - schemaAttributes
```
public 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.
    
    Returns:
    
    A container with the schema attributes of a user pool.
  - autoVerifiedAttributes
```
public 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.
    
    Returns:
    
    Specifies the attributes that are auto-verified in a user pool.
  - autoVerifiedAttributesAsStrings
```
public 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.
    
    Returns:
    
    Specifies the attributes that are auto-verified in a user pool.
  - aliasAttributes
```
public 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.
    
    Returns:
    
    Specifies the attributes that are aliased in a user pool.
  - aliasAttributesAsStrings
```
public 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.
    
    Returns:
    
    Specifies the attributes that are aliased in a user pool.
  - usernameAttributes
```
public 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.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - usernameAttributesAsStrings
```
public 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.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - smsVerificationMessage
```
public String smsVerificationMessage()
```
    The contents of the SMS verification message.
    
    Returns:
    
    The contents of the SMS verification message.
  - emailVerificationMessage
```
public String emailVerificationMessage()
```
    The contents of the email verification message.
    
    Returns:
    
    The contents of the email verification message.
  - emailVerificationSubject
```
public String emailVerificationSubject()
```
    The subject of the email verification message.
    
    Returns:
    
    The subject of the email verification message.
  - verificationMessageTemplate
```
public VerificationMessageTemplateType verificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - smsAuthenticationMessage
```
public String smsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Returns:
    
    The contents of the SMS authentication message.
  - mfaConfiguration
```
public 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 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 DeviceConfigurationType deviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - estimatedNumberOfUsers
```
public Integer estimatedNumberOfUsers()
```
    A number estimating the size of the user pool.
    
    Returns:
    
    A number estimating the size of the user pool.
  - emailConfiguration
```
public EmailConfigurationType emailConfiguration()
```
    The email configuration.
    
    Returns:
    
    The email configuration.
  - smsConfiguration
```
public SmsConfigurationType smsConfiguration()
```
    The SMS configuration.
    
    Returns:
    
    The SMS configuration.
  - userPoolTags
```
public 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.
    
    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 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 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 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 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 AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - userPoolAddOns
```
public UserPoolAddOnsType userPoolAddOns()
```
    The user pool add-ons.
    
    Returns:
    
    The user pool add-ons.
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) for the user pool.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the user pool.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

schemaAttributes

autoVerifiedAttributes

autoVerifiedAttributesAsStrings

aliasAttributes

aliasAttributesAsStrings

usernameAttributes

usernameAttributesAsStrings

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

smsAuthenticationMessage

mfaConfiguration

mfaConfigurationAsString

deviceConfiguration

estimatedNumberOfUsers

emailConfiguration

smsConfiguration

userPoolTags

smsConfigurationFailure

emailConfigurationFailure

domain

customDomain

adminCreateUserConfig

userPoolAddOns

arn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields