Class UserPoolType
- java.lang.Object
-
- com.amazonaws.services.cognitoidp.model.UserPoolType
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class UserPoolType extends Object implements Serializable, Cloneable
A container with information about the user pool type.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description UserPoolType()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UserPoolType
clone()
boolean
equals(Object obj)
List<String>
getAliasAttributes()
Specifies the attributes that are aliased in a user pool.List<String>
getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.Date
getCreationDate()
The creation date of a user pool.String
getEmailVerificationMessage()
The contents of the email verification message.String
getEmailVerificationSubject()
The subject of the email verification message.Integer
getEstimatedNumberOfUsers()
A number estimating the size of the user pool.String
getId()
The ID of the user pool.LambdaConfigType
getLambdaConfig()
A container describing the AWS Lambda triggers associated with a user pool.Date
getLastModifiedDate()
The last modified date of a user pool.String
getMfaConfiguration()
Can be one of the following values:String
getName()
The name of the user pool.UserPoolPolicyType
getPolicies()
A container describing the policies associated with a user pool.List<SchemaAttributeType>
getSchemaAttributes()
A container with the schema attributes of a user pool.String
getSmsAuthenticationMessage()
The contents of the SMS authentication message.String
getSmsVerificationMessage()
The contents of the SMS verification message.String
getStatus()
The status of a user pool.int
hashCode()
void
setAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.void
setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.void
setCreationDate(Date creationDate)
The creation date of a user pool.void
setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.void
setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.void
setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.void
setId(String id)
The ID of the user pool.void
setLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user pool.void
setLastModifiedDate(Date lastModifiedDate)
The last modified date of a user pool.void
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:void
setMfaConfiguration(String mfaConfiguration)
Can be one of the following values:void
setName(String name)
The name of the user pool.void
setPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.void
setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.void
setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.void
setSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.void
setStatus(StatusType status)
The status of a user pool.void
setStatus(String status)
The status of a user pool.String
toString()
Returns a string representation of this object; useful for testing and debugging.UserPoolType
withAliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.UserPoolType
withAliasAttributes(String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.UserPoolType
withAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.UserPoolType
withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.UserPoolType
withAutoVerifiedAttributes(String... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.UserPoolType
withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.UserPoolType
withCreationDate(Date creationDate)
The creation date of a user pool.UserPoolType
withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.UserPoolType
withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.UserPoolType
withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.UserPoolType
withId(String id)
The ID of the user pool.UserPoolType
withLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user pool.UserPoolType
withLastModifiedDate(Date lastModifiedDate)
The last modified date of a user pool.UserPoolType
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:UserPoolType
withMfaConfiguration(String mfaConfiguration)
Can be one of the following values:UserPoolType
withName(String name)
The name of the user pool.UserPoolType
withPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.UserPoolType
withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.UserPoolType
withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.UserPoolType
withSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.UserPoolType
withSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.UserPoolType
withStatus(StatusType status)
The status of a user pool.UserPoolType
withStatus(String status)
The status of a user pool.
-
-
-
Method Detail
-
setId
public void setId(String id)
The ID of the user pool.
- Parameters:
id
- The ID of the user pool.
-
getId
public String getId()
The ID of the user pool.
- Returns:
- The ID of the user pool.
-
withId
public UserPoolType withId(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.
-
setName
public void setName(String name)
The name of the user pool.
- Parameters:
name
- The name of the user pool.
-
getName
public String getName()
The name of the user pool.
- Returns:
- The name of the user pool.
-
withName
public UserPoolType withName(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.
-
setPolicies
public void setPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
- Parameters:
policies
- A container describing the policies associated with a user pool.
-
getPolicies
public UserPoolPolicyType getPolicies()
A container describing the policies associated with a user pool.
- Returns:
- A container describing the policies associated with a user pool.
-
withPolicies
public UserPoolType withPolicies(UserPoolPolicyType policies)
A container describing the policies associated with a user pool.
- Parameters:
policies
- A container describing the policies associated with a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLambdaConfig
public void setLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user pool.
- Parameters:
lambdaConfig
- A container describing the AWS Lambda triggers associated with a user pool.
-
getLambdaConfig
public LambdaConfigType getLambdaConfig()
A container describing the AWS Lambda triggers associated with a user pool.
- Returns:
- A container describing the AWS Lambda triggers associated with a user pool.
-
withLambdaConfig
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
A container describing the AWS Lambda triggers associated with a user pool.
- Parameters:
lambdaConfig
- A container describing the AWS Lambda triggers associated with a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
public void setStatus(String status)
The status of a user pool.
- Parameters:
status
- The status of a user pool.- See Also:
StatusType
-
getStatus
public String getStatus()
The status of a user pool.
- Returns:
- The status of a user pool.
- See Also:
StatusType
-
withStatus
public UserPoolType withStatus(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
-
setStatus
public void setStatus(StatusType status)
The status of a user pool.
- Parameters:
status
- The status of a user pool.- See Also:
StatusType
-
withStatus
public UserPoolType withStatus(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
-
setLastModifiedDate
public void setLastModifiedDate(Date lastModifiedDate)
The last modified date of a user pool.
- Parameters:
lastModifiedDate
- The last modified date of a user pool.
-
getLastModifiedDate
public Date getLastModifiedDate()
The last modified date of a user pool.
- Returns:
- The last modified date of a user pool.
-
withLastModifiedDate
public UserPoolType withLastModifiedDate(Date lastModifiedDate)
The last modified date of a user pool.
- Parameters:
lastModifiedDate
- The last modified date of a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCreationDate
public void setCreationDate(Date creationDate)
The creation date of a user pool.
- Parameters:
creationDate
- The creation date of a user pool.
-
getCreationDate
public Date getCreationDate()
The creation date of a user pool.
- Returns:
- The creation date of a user pool.
-
withCreationDate
public UserPoolType withCreationDate(Date creationDate)
The creation date of a user pool.
- Parameters:
creationDate
- The creation date of a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getSchemaAttributes
public List<SchemaAttributeType> getSchemaAttributes()
A container with the schema attributes of a user pool.
- Returns:
- A container with the schema attributes of a user pool.
-
setSchemaAttributes
public void setSchemaAttributes(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.
-
withSchemaAttributes
public UserPoolType withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
NOTE: This method appends the values to the existing list (if any). Use
setSchemaAttributes(java.util.Collection)
orwithSchemaAttributes(java.util.Collection)
if you want to override the existing values.- 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.
-
withSchemaAttributes
public UserPoolType withSchemaAttributes(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.
-
getAutoVerifiedAttributes
public List<String> getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
- Returns:
- Specifies the attributes that are auto-verified in a user pool.
- See Also:
VerifiedAttributeType
-
setAutoVerifiedAttributes
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
- Parameters:
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.- See Also:
VerifiedAttributeType
-
withAutoVerifiedAttributes
public UserPoolType withAutoVerifiedAttributes(String... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
NOTE: This method appends the values to the existing list (if any). Use
setAutoVerifiedAttributes(java.util.Collection)
orwithAutoVerifiedAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
autoVerifiedAttributes
- Specifies 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.
- See Also:
VerifiedAttributeType
-
withAutoVerifiedAttributes
public UserPoolType withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
- Parameters:
autoVerifiedAttributes
- Specifies 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.
- See Also:
VerifiedAttributeType
-
withAutoVerifiedAttributes
public UserPoolType withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
- Parameters:
autoVerifiedAttributes
- Specifies 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.
- See Also:
VerifiedAttributeType
-
getAliasAttributes
public List<String> getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
- Returns:
- Specifies the attributes that are aliased in a user pool.
- See Also:
AliasAttributeType
-
setAliasAttributes
public void setAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
- Parameters:
aliasAttributes
- Specifies the attributes that are aliased in a user pool.- See Also:
AliasAttributeType
-
withAliasAttributes
public UserPoolType withAliasAttributes(String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
NOTE: This method appends the values to the existing list (if any). Use
setAliasAttributes(java.util.Collection)
orwithAliasAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
aliasAttributes
- Specifies the attributes that are aliased in a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AliasAttributeType
-
withAliasAttributes
public UserPoolType withAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
- Parameters:
aliasAttributes
- Specifies the attributes that are aliased in a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AliasAttributeType
-
withAliasAttributes
public UserPoolType withAliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
- Parameters:
aliasAttributes
- Specifies the attributes that are aliased in a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AliasAttributeType
-
setSmsVerificationMessage
public void setSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
- Parameters:
smsVerificationMessage
- The contents of the SMS verification message.
-
getSmsVerificationMessage
public String getSmsVerificationMessage()
The contents of the SMS verification message.
- Returns:
- The contents of the SMS verification message.
-
withSmsVerificationMessage
public UserPoolType withSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
- Parameters:
smsVerificationMessage
- The contents of the SMS verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEmailVerificationMessage
public void setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
- Parameters:
emailVerificationMessage
- The contents of the email verification message.
-
getEmailVerificationMessage
public String getEmailVerificationMessage()
The contents of the email verification message.
- Returns:
- The contents of the email verification message.
-
withEmailVerificationMessage
public UserPoolType withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
- Parameters:
emailVerificationMessage
- The contents of the email verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEmailVerificationSubject
public void setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
- Parameters:
emailVerificationSubject
- The subject of the email verification message.
-
getEmailVerificationSubject
public String getEmailVerificationSubject()
The subject of the email verification message.
- Returns:
- The subject of the email verification message.
-
withEmailVerificationSubject
public UserPoolType withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
- Parameters:
emailVerificationSubject
- The subject of the email verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSmsAuthenticationMessage
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
- Parameters:
smsAuthenticationMessage
- The contents of the SMS authentication message.
-
getSmsAuthenticationMessage
public String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
- Returns:
- The contents of the SMS authentication message.
-
withSmsAuthenticationMessage
public UserPoolType withSmsAuthenticationMessage(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.
-
setMfaConfiguration
public void setMfaConfiguration(String 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.
- Parameters:
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.
- See Also:
UserPoolMfaType
-
getMfaConfiguration
public String getMfaConfiguration()
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.
- 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
-
withMfaConfiguration
public UserPoolType withMfaConfiguration(String 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
UserPoolMfaType
-
setMfaConfiguration
public void setMfaConfiguration(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.
- Parameters:
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.
- See Also:
UserPoolMfaType
-
withMfaConfiguration
public UserPoolType withMfaConfiguration(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
UserPoolMfaType
-
setEstimatedNumberOfUsers
public void setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
- Parameters:
estimatedNumberOfUsers
- A number estimating the size of the user pool.
-
getEstimatedNumberOfUsers
public Integer getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
- Returns:
- A number estimating the size of the user pool.
-
withEstimatedNumberOfUsers
public UserPoolType withEstimatedNumberOfUsers(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.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public UserPoolType clone()
-
-