Class UserPoolType
- All Implemented Interfaces:
Serializable
,Cloneable
A container with information about the user pool type.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Specifies the attributes that are aliased in a user pool.Specifies the attributes that are auto-verified in a user pool.The creation date of a user pool.The contents of the email verification message.The subject of the email verification message.A number estimating the size of the user pool.getId()
The ID of the user pool.A container describing the AWS Lambda triggers associated with a user pool.The last modified date of a user pool.Can be one of the following values:getName()
The name of the user pool.A container describing the policies associated with a user pool.A container with the schema attributes of a user pool.The contents of the SMS authentication message.The contents of the SMS verification message.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
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
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
The status of a user pool.toString()
Returns a string representation of this object; useful for testing and debugging.withAliasAttributes
(AliasAttributeType... aliasAttributes) Specifies the attributes that are aliased in a user pool.withAliasAttributes
(String... aliasAttributes) Specifies the attributes that are aliased in a user pool.withAliasAttributes
(Collection<String> aliasAttributes) Specifies the attributes that are aliased in a user pool.withAutoVerifiedAttributes
(VerifiedAttributeType... autoVerifiedAttributes) Specifies the attributes that are auto-verified in a user pool.withAutoVerifiedAttributes
(String... autoVerifiedAttributes) Specifies the attributes that are auto-verified in a user pool.withAutoVerifiedAttributes
(Collection<String> autoVerifiedAttributes) Specifies the attributes that are auto-verified in a user pool.withCreationDate
(Date creationDate) The creation date of a user pool.withEmailVerificationMessage
(String emailVerificationMessage) The contents of the email verification message.withEmailVerificationSubject
(String emailVerificationSubject) The subject of the email verification message.withEstimatedNumberOfUsers
(Integer estimatedNumberOfUsers) A number estimating the size of the user pool.The ID of the user pool.withLambdaConfig
(LambdaConfigType lambdaConfig) A container describing the AWS Lambda triggers associated with a user pool.withLastModifiedDate
(Date lastModifiedDate) The last modified date of a user pool.withMfaConfiguration
(UserPoolMfaType mfaConfiguration) Can be one of the following values:withMfaConfiguration
(String mfaConfiguration) Can be one of the following values:The name of the user pool.withPolicies
(UserPoolPolicyType policies) A container describing the policies associated with a user pool.withSchemaAttributes
(SchemaAttributeType... schemaAttributes) A container with the schema attributes of a user pool.withSchemaAttributes
(Collection<SchemaAttributeType> schemaAttributes) A container with the schema attributes of a user pool.withSmsAuthenticationMessage
(String smsAuthenticationMessage) The contents of the SMS authentication message.withSmsVerificationMessage
(String smsVerificationMessage) The contents of the SMS verification message.withStatus
(StatusType status) The status of a user pool.withStatus
(String status) The status of a user pool.
-
Constructor Details
-
UserPoolType
public UserPoolType()
-
-
Method Details
-
setId
The ID of the user pool.
- Parameters:
id
- The ID of the user pool.
-
getId
The ID of the user pool.
- Returns:
- The ID of the user pool.
-
withId
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
The name of the user pool.
- Parameters:
name
- The name of the user pool.
-
getName
The name of the user pool.
- Returns:
- The name of the user pool.
-
withName
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
A container describing the policies associated with a user pool.
- Parameters:
policies
- A container describing the policies associated with a user pool.
-
getPolicies
A container describing the policies associated with a user pool.
- Returns:
- A container describing the policies associated with a user pool.
-
withPolicies
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
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
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
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
The status of a user pool.
- Parameters:
status
- The status of a user pool.- See Also:
-
getStatus
The status of a user pool.
- Returns:
- The status of a user pool.
- See Also:
-
withStatus
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:
-
setStatus
The status of a user pool.
- Parameters:
status
- The status of a user pool.- See Also:
-
withStatus
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:
-
setLastModifiedDate
The last modified date of a user pool.
- Parameters:
lastModifiedDate
- The last modified date of a user pool.
-
getLastModifiedDate
The last modified date of a user pool.
- Returns:
- The last modified date of a user pool.
-
withLastModifiedDate
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
The creation date of a user pool.
- Parameters:
creationDate
- The creation date of a user pool.
-
getCreationDate
The creation date of a user pool.
- Returns:
- The creation date of a user pool.
-
withCreationDate
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
A container with the schema attributes of a user pool.
- Returns:
- A container with the schema attributes of a user pool.
-
setSchemaAttributes
A container with the schema attributes of a user pool.
- Parameters:
schemaAttributes
- A container with the schema attributes of a user pool.
-
withSchemaAttributes
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
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
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:
-
setAutoVerifiedAttributes
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:
-
withAutoVerifiedAttributes
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:
-
withAutoVerifiedAttributes
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:
-
withAutoVerifiedAttributes
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:
-
getAliasAttributes
Specifies the attributes that are aliased in a user pool.
- Returns:
- Specifies the attributes that are aliased in a user pool.
- See Also:
-
setAliasAttributes
Specifies the attributes that are aliased in a user pool.
- Parameters:
aliasAttributes
- Specifies the attributes that are aliased in a user pool.- See Also:
-
withAliasAttributes
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:
-
withAliasAttributes
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:
-
withAliasAttributes
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:
-
setSmsVerificationMessage
The contents of the SMS verification message.
- Parameters:
smsVerificationMessage
- The contents of the SMS verification message.
-
getSmsVerificationMessage
The contents of the SMS verification message.
- Returns:
- The contents of the SMS verification message.
-
withSmsVerificationMessage
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
The contents of the email verification message.
- Parameters:
emailVerificationMessage
- The contents of the email verification message.
-
getEmailVerificationMessage
The contents of the email verification message.
- Returns:
- The contents of the email verification message.
-
withEmailVerificationMessage
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
The subject of the email verification message.
- Parameters:
emailVerificationSubject
- The subject of the email verification message.
-
getEmailVerificationSubject
The subject of the email verification message.
- Returns:
- The subject of the email verification message.
-
withEmailVerificationSubject
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
The contents of the SMS authentication message.
- Parameters:
smsAuthenticationMessage
- The contents of the SMS authentication message.
-
getSmsAuthenticationMessage
The contents of the SMS authentication message.
- Returns:
- The contents of the SMS authentication message.
-
withSmsAuthenticationMessage
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
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:
-
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:
-
withMfaConfiguration
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:
-
setMfaConfiguration
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:
-
withMfaConfiguration
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:
-
setEstimatedNumberOfUsers
A number estimating the size of the user pool.
- Parameters:
estimatedNumberOfUsers
- A number estimating the size of the user pool.
-
getEstimatedNumberOfUsers
A number estimating the size of the user pool.
- Returns:
- A number estimating the size of the user pool.
-
withEstimatedNumberOfUsers
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-