@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UserPoolType extends Object implements Serializable, Cloneable, StructuredPojo
A container for information about the user pool.
Constructor and Description |
---|
UserPoolType() |
Modifier and Type | Method and Description |
---|---|
UserPoolType |
addUserPoolTagsEntry(String key,
String value)
Add a single UserPoolTags entry
|
UserPoolType |
clearUserPoolTagsEntries()
Removes all the entries added into UserPoolTags.
|
UserPoolType |
clone() |
boolean |
equals(Object obj) |
AccountRecoverySettingType |
getAccountRecoverySetting()
Use this setting to define which verified available method a user can use to recover their password when they
call
ForgotPassword . |
AdminCreateUserConfigType |
getAdminCreateUserConfig()
The configuration for
AdminCreateUser requests. |
List<String> |
getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
|
String |
getArn()
The Amazon Resource Name (ARN) for the user pool.
|
List<String> |
getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
|
Date |
getCreationDate()
The date the user pool was created.
|
String |
getCustomDomain()
A custom domain name that you provide to Amazon Cognito.
|
DeviceConfigurationType |
getDeviceConfiguration()
The device configuration.
|
String |
getDomain()
Holds the domain prefix if the user pool has a domain associated with it.
|
EmailConfigurationType |
getEmailConfiguration()
The email configuration.
|
String |
getEmailConfigurationFailure()
The reason why the email configuration cannot send the messages to your users.
|
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()
The AWS Lambda triggers associated with the user pool.
|
Date |
getLastModifiedDate()
The date the user pool was last modified.
|
String |
getMfaConfiguration()
Can be one of the following values:
|
String |
getName()
The name of the user pool.
|
UserPoolPolicyType |
getPolicies()
The policies associated with the user pool.
|
List<SchemaAttributeType> |
getSchemaAttributes()
A container with the schema attributes of a user pool.
|
String |
getSmsAuthenticationMessage()
The contents of the SMS authentication message.
|
SmsConfigurationType |
getSmsConfiguration()
The SMS configuration.
|
String |
getSmsConfigurationFailure()
The reason why the SMS configuration cannot send the messages to your users.
|
String |
getSmsVerificationMessage()
The contents of the SMS verification message.
|
String |
getStatus()
The status of a user pool.
|
List<String> |
getUsernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UsernameConfigurationType |
getUsernameConfiguration()
You can choose to enable case sensitivity on the username input for the selected sign-in option.
|
UserPoolAddOnsType |
getUserPoolAddOns()
The user pool add-ons.
|
Map<String,String> |
getUserPoolTags()
The tags that are assigned to the user pool.
|
VerificationMessageTemplateType |
getVerificationMessageTemplate()
The template for verification messages.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller) |
void |
setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
Use this setting to define which verified available method a user can use to recover their password when they
call
ForgotPassword . |
void |
setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
void |
setAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) for the user pool.
|
void |
setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
void |
setCreationDate(Date creationDate)
The date the user pool was created.
|
void |
setCustomDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito.
|
void |
setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
|
void |
setDomain(String domain)
Holds the domain prefix if the user pool has a domain associated with it.
|
void |
setEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
|
void |
setEmailConfigurationFailure(String emailConfigurationFailure)
The reason why the email configuration cannot send the messages to your users.
|
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)
The AWS Lambda triggers associated with the user pool.
|
void |
setLastModifiedDate(Date lastModifiedDate)
The date the user pool was last modified.
|
void |
setMfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
void |
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
void |
setName(String name)
The name of the user pool.
|
void |
setPolicies(UserPoolPolicyType policies)
The policies associated with the 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 |
setSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
|
void |
setSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration cannot send the messages to your users.
|
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.
|
void |
setUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
void |
setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
You can choose to enable case sensitivity on the username input for the selected sign-in option.
|
void |
setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
|
void |
setUserPoolTags(Map<String,String> userPoolTags)
The tags that are assigned to the user pool.
|
void |
setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
String |
toString()
Returns a string representation of this object.
|
UserPoolType |
withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
Use this setting to define which verified available method a user can use to recover their password when they
call
ForgotPassword . |
UserPoolType |
withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
UserPoolType |
withAliasAttributes(AliasAttributeType... 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 |
withAliasAttributes(String... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
|
UserPoolType |
withArn(String arn)
The Amazon Resource Name (ARN) for the user pool.
|
UserPoolType |
withAutoVerifiedAttributes(Collection<String> 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(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
|
UserPoolType |
withCreationDate(Date creationDate)
The date the user pool was created.
|
UserPoolType |
withCustomDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito.
|
UserPoolType |
withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
|
UserPoolType |
withDomain(String domain)
Holds the domain prefix if the user pool has a domain associated with it.
|
UserPoolType |
withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
|
UserPoolType |
withEmailConfigurationFailure(String emailConfigurationFailure)
The reason why the email configuration cannot send the messages to your users.
|
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)
The AWS Lambda triggers associated with the user pool.
|
UserPoolType |
withLastModifiedDate(Date lastModifiedDate)
The date the user pool was last modified.
|
UserPoolType |
withMfaConfiguration(String mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withName(String name)
The name of the user pool.
|
UserPoolType |
withPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
|
UserPoolType |
withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType |
withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A container with the schema attributes of a user pool.
|
UserPoolType |
withSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UserPoolType |
withSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
|
UserPoolType |
withSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration cannot send the messages to your users.
|
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.
|
UserPoolType |
withUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UserPoolType |
withUsernameAttributes(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UserPoolType |
withUsernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
UserPoolType |
withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
You can choose to enable case sensitivity on the username input for the selected sign-in option.
|
UserPoolType |
withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
|
UserPoolType |
withUserPoolTags(Map<String,String> userPoolTags)
The tags that are assigned to the user pool.
|
UserPoolType |
withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
public void setId(String id)
The ID of the user pool.
id
- The ID of the user pool.public String getId()
The ID of the user pool.
public UserPoolType withId(String id)
The ID of the user pool.
id
- The ID of the user pool.public void setName(String name)
The name of the user pool.
name
- The name of the user pool.public String getName()
The name of the user pool.
public UserPoolType withName(String name)
The name of the user pool.
name
- The name of the user pool.public void setPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
policies
- The policies associated with the user pool.public UserPoolPolicyType getPolicies()
The policies associated with the user pool.
public UserPoolType withPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
policies
- The policies associated with the user pool.public void setLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda triggers associated with the user pool.
lambdaConfig
- The AWS Lambda triggers associated with the user pool.public LambdaConfigType getLambdaConfig()
The AWS Lambda triggers associated with the user pool.
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda triggers associated with the user pool.
lambdaConfig
- The AWS Lambda triggers associated with the user pool.public void setStatus(String status)
The status of a user pool.
status
- The status of a user pool.StatusType
public String getStatus()
The status of a user pool.
StatusType
public UserPoolType withStatus(String status)
The status of a user pool.
status
- The status of a user pool.StatusType
public void setStatus(StatusType status)
The status of a user pool.
status
- The status of a user pool.StatusType
public UserPoolType withStatus(StatusType status)
The status of a user pool.
status
- The status of a user pool.StatusType
public void setLastModifiedDate(Date lastModifiedDate)
The date the user pool was last modified.
lastModifiedDate
- The date the user pool was last modified.public Date getLastModifiedDate()
The date the user pool was last modified.
public UserPoolType withLastModifiedDate(Date lastModifiedDate)
The date the user pool was last modified.
lastModifiedDate
- The date the user pool was last modified.public void setCreationDate(Date creationDate)
The date the user pool was created.
creationDate
- The date the user pool was created.public Date getCreationDate()
The date the user pool was created.
public UserPoolType withCreationDate(Date creationDate)
The date the user pool was created.
creationDate
- The date the user pool was created.public List<SchemaAttributeType> getSchemaAttributes()
A container with the schema attributes of a user pool.
public void setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
schemaAttributes
- A container with the schema attributes of a user pool.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)
or withSchemaAttributes(java.util.Collection)
if you
want to override the existing values.
schemaAttributes
- A container with the schema attributes of a user pool.public UserPoolType withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A container with the schema attributes of a user pool.
schemaAttributes
- A container with the schema attributes of a user pool.public List<String> getAutoVerifiedAttributes()
Specifies the attributes that are auto-verified in a user pool.
VerifiedAttributeType
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
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)
or
withAutoVerifiedAttributes(java.util.Collection)
if you want to override the existing values.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
Specifies the attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- Specifies the attributes that are auto-verified in a user pool.VerifiedAttributeType
public List<String> getAliasAttributes()
Specifies the attributes that are aliased in a user pool.
AliasAttributeType
public void setAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
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)
or withAliasAttributes(java.util.Collection)
if you
want to override the existing values.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(Collection<String> aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(AliasAttributeType... aliasAttributes)
Specifies the attributes that are aliased in a user pool.
aliasAttributes
- Specifies the attributes that are aliased in a user pool.AliasAttributeType
public List<String> getUsernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
UsernameAttributeType
public void setUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public UserPoolType withUsernameAttributes(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
NOTE: This method appends the values to the existing list (if any). Use
setUsernameAttributes(java.util.Collection)
or withUsernameAttributes(java.util.Collection)
if
you want to override the existing values.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public UserPoolType withUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public UserPoolType withUsernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public void setSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage
- The contents of the SMS verification message.public String getSmsVerificationMessage()
The contents of the SMS verification message.
public UserPoolType withSmsVerificationMessage(String smsVerificationMessage)
The contents of the SMS verification message.
smsVerificationMessage
- The contents of the SMS verification message.public void setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public String getEmailVerificationMessage()
The contents of the email verification message.
public UserPoolType withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public void setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public String getEmailVerificationSubject()
The subject of the email verification message.
public UserPoolType withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate
- The template for verification messages.public VerificationMessageTemplateType getVerificationMessageTemplate()
The template for verification messages.
public UserPoolType withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate
- The template for verification messages.public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
public UserPoolType withSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.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.
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.
UserPoolMfaType
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.
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.
UserPoolMfaType
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.
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.
UserPoolMfaType
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.
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.
UserPoolMfaType
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.
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.
UserPoolMfaType
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
deviceConfiguration
- The device configuration.public DeviceConfigurationType getDeviceConfiguration()
The device configuration.
public UserPoolType withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
deviceConfiguration
- The device configuration.public void setEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers
- A number estimating the size of the user pool.public Integer getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
public UserPoolType withEstimatedNumberOfUsers(Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers
- A number estimating the size of the user pool.public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
emailConfiguration
- The email configuration.public EmailConfigurationType getEmailConfiguration()
The email configuration.
public UserPoolType withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
emailConfiguration
- The email configuration.public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
smsConfiguration
- The SMS configuration.public SmsConfigurationType getSmsConfiguration()
The SMS configuration.
public UserPoolType withSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
smsConfiguration
- The SMS configuration.public Map<String,String> getUserPoolTags()
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.
public void setUserPoolTags(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.
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.public UserPoolType withUserPoolTags(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.
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.public UserPoolType addUserPoolTagsEntry(String key, String value)
public UserPoolType clearUserPoolTagsEntries()
public void setSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration cannot send the messages to your users.
smsConfigurationFailure
- The reason why the SMS configuration cannot send the messages to your users.public String getSmsConfigurationFailure()
The reason why the SMS configuration cannot send the messages to your users.
public UserPoolType withSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration cannot send the messages to your users.
smsConfigurationFailure
- The reason why the SMS configuration cannot send the messages to your users.public void setEmailConfigurationFailure(String emailConfigurationFailure)
The reason why the email configuration cannot send the messages to your users.
emailConfigurationFailure
- The reason why the email configuration cannot send the messages to your users.public String getEmailConfigurationFailure()
The reason why the email configuration cannot send the messages to your users.
public UserPoolType withEmailConfigurationFailure(String emailConfigurationFailure)
The reason why the email configuration cannot send the messages to your users.
emailConfigurationFailure
- The reason why the email configuration cannot send the messages to your users.public void setDomain(String domain)
Holds the domain prefix if the user pool has a domain associated with it.
domain
- Holds the domain prefix if the user pool has a domain associated with it.public String getDomain()
Holds the domain prefix if the user pool has a domain associated with it.
public UserPoolType withDomain(String domain)
Holds the domain prefix if the user pool has a domain associated with it.
domain
- Holds the domain prefix if the user pool has a domain associated with it.public void setCustomDomain(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.
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.
public String getCustomDomain()
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.
auth.example.com
.
For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
public UserPoolType withCustomDomain(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.
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.
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.public AdminCreateUserConfigType getAdminCreateUserConfig()
The configuration for AdminCreateUser
requests.
AdminCreateUser
requests.public UserPoolType withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
userPoolAddOns
- The user pool add-ons.public UserPoolAddOnsType getUserPoolAddOns()
The user pool add-ons.
public UserPoolType withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
The user pool add-ons.
userPoolAddOns
- The user pool add-ons.public void setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
You can choose to enable case sensitivity on the username input for the selected sign-in option. For example,
when this is set to False
, users will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
usernameConfiguration
- You can choose to enable case sensitivity on the username input for the selected sign-in option. For
example, when this is set to False
, users will be able to sign in using either "username" or
"Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.public UsernameConfigurationType getUsernameConfiguration()
You can choose to enable case sensitivity on the username input for the selected sign-in option. For example,
when this is set to False
, users will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
False
, users will be able to sign in using either "username" or
"Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.public UserPoolType withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
You can choose to enable case sensitivity on the username input for the selected sign-in option. For example,
when this is set to False
, users will be able to sign in using either "username" or "Username". This
configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
usernameConfiguration
- You can choose to enable case sensitivity on the username input for the selected sign-in option. For
example, when this is set to False
, users will be able to sign in using either "username" or
"Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.public void setArn(String arn)
The Amazon Resource Name (ARN) for the user pool.
arn
- The Amazon Resource Name (ARN) for the user pool.public String getArn()
The Amazon Resource Name (ARN) for the user pool.
public UserPoolType withArn(String arn)
The Amazon Resource Name (ARN) for the user pool.
arn
- The Amazon Resource Name (ARN) for the user pool.public void setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
Use this setting to define which verified available method a user can use to recover their password when they
call ForgotPassword
. It allows you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
method where SMS is preferred over email.
accountRecoverySetting
- Use this setting to define which verified available method a user can use to recover their password when
they call ForgotPassword
. It allows you to define a preferred method when a user has more
than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism
if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred over email.public AccountRecoverySettingType getAccountRecoverySetting()
Use this setting to define which verified available method a user can use to recover their password when they
call ForgotPassword
. It allows you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
method where SMS is preferred over email.
ForgotPassword
. It allows you to define a preferred method when a user has more
than one method available. With this setting, SMS does not qualify for a valid password recovery
mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy
behavior to determine the recovery method where SMS is preferred over email.public UserPoolType withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
Use this setting to define which verified available method a user can use to recover their password when they
call ForgotPassword
. It allows you to define a preferred method when a user has more than one method
available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
method where SMS is preferred over email.
accountRecoverySetting
- Use this setting to define which verified available method a user can use to recover their password when
they call ForgotPassword
. It allows you to define a preferred method when a user has more
than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism
if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred over email.public String toString()
toString
in class Object
Object.toString()
public UserPoolType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
marshall
in interface StructuredPojo
Copyright © 2020. All rights reserved.