UserPoolType (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<UserPoolType.Builder,UserPoolType>

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

A container for information about the user pool type.

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.
`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.
`DeviceConfigurationType`	`deviceConfiguration()` The device configuration.
`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)`
`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()` A container for the AWS Lambda triggers associated with a user pool.
`Instant`	`lastModifiedDate()` The date the user pool was last modified.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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()` A container for the policies associated with a user pool.
`List<SchemaAttributeType>`	`schemaAttributes()` A container with the schema attributes of a user pool.
`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()`
`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.
`Map<String,String>`	`userPoolTags()` The cost allocation tags for 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 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()
```
    A container for the policies associated with a user pool.
    
    Returns:
    
    A container for the policies associated with a user pool.
  - lambdaConfig
```
public LambdaConfigType lambdaConfig()
```
    A container for the AWS Lambda triggers associated with a user pool.
    
    Returns:
    
    A container for the AWS Lambda triggers associated with a 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 cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
  - 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.
  - adminCreateUserConfig
```
public AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

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

adminCreateUserConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall