@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()
The available verified method a user can use to recover their password when they call
ForgotPassword
. |
AdminCreateUserConfigType |
getAdminCreateUserConfig()
The configuration for
AdminCreateUser requests. |
List<String> |
getAliasAttributes()
The attributes that are aliased in a user pool.
|
String |
getArn()
The Amazon Resource Name (ARN) for the user pool.
|
List<String> |
getAutoVerifiedAttributes()
The attributes that are auto-verified in a user pool.
|
Date |
getCreationDate()
The date and time when the item was created.
|
String |
getCustomDomain()
A custom domain name that you provide to Amazon Cognito.
|
String |
getDeletionProtection()
When active,
DeletionProtection prevents accidental deletion of your user pool. |
DeviceConfigurationType |
getDeviceConfiguration()
The device-remembering configuration for a user pool.
|
String |
getDomain()
The domain prefix, if the user pool has a domain associated with it.
|
EmailConfigurationType |
getEmailConfiguration()
The email configuration of your user pool.
|
String |
getEmailConfigurationFailure()
Deprecated.
|
String |
getEmailVerificationMessage()
This parameter is no longer used.
|
String |
getEmailVerificationSubject()
This parameter is no longer used.
|
Integer |
getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
|
String |
getId()
The ID of the user pool.
|
LambdaConfigType |
getLambdaConfig()
The Lambda triggers associated with the user pool.
|
Date |
getLastModifiedDate()
The date and time when the item was 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 list of the user attributes and their properties in your user pool.
|
String |
getSmsAuthenticationMessage()
The contents of the SMS authentication message.
|
SmsConfigurationType |
getSmsConfiguration()
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from
your Amazon Web Services account through Amazon Simple Notification Service.
|
String |
getSmsConfigurationFailure()
The reason why the SMS configuration can't send the messages to your users.
|
String |
getSmsVerificationMessage()
This parameter is no longer used.
|
String |
getStatus()
Deprecated.
|
UserAttributeUpdateSettingsType |
getUserAttributeUpdateSettings()
The settings for updates to user attributes.
|
List<String> |
getUsernameAttributes()
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UsernameConfigurationType |
getUsernameConfiguration()
Case sensitivity of the username input for the selected sign-in option.
|
UserPoolAddOnsType |
getUserPoolAddOns()
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
The available verified 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)
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)
The attributes that are auto-verified in a user pool.
|
void |
setCreationDate(Date creationDate)
The date and time when the item was created.
|
void |
setCustomDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito.
|
void |
setDeletionProtection(DeletionProtectionType deletionProtection)
When active,
DeletionProtection prevents accidental deletion of your user pool. |
void |
setDeletionProtection(String deletionProtection)
When active,
DeletionProtection prevents accidental deletion of your user pool. |
void |
setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device-remembering configuration for a user pool.
|
void |
setDomain(String domain)
The domain prefix, if the user pool has a domain associated with it.
|
void |
setEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration of your user pool.
|
void |
setEmailConfigurationFailure(String emailConfigurationFailure)
Deprecated.
|
void |
setEmailVerificationMessage(String emailVerificationMessage)
This parameter is no longer used.
|
void |
setEmailVerificationSubject(String emailVerificationSubject)
This parameter is no longer used.
|
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 Lambda triggers associated with the user pool.
|
void |
setLastModifiedDate(Date lastModifiedDate)
The date and time when the item was 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 list of the user attributes and their properties in your user pool.
|
void |
setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
void |
setSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from
your Amazon Web Services account through Amazon Simple Notification Service.
|
void |
setSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration can't send the messages to your users.
|
void |
setSmsVerificationMessage(String smsVerificationMessage)
This parameter is no longer used.
|
void |
setStatus(StatusType status)
Deprecated.
|
void |
setStatus(String status)
Deprecated.
|
void |
setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
void |
setUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
void |
setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
Case sensitivity of the username input for the selected sign-in option.
|
void |
setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
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)
The available verified 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)
The attributes that are aliased in a user pool.
|
UserPoolType |
withAliasAttributes(Collection<String> aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType |
withAliasAttributes(String... aliasAttributes)
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)
The attributes that are auto-verified in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(String... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType |
withCreationDate(Date creationDate)
The date and time when the item was created.
|
UserPoolType |
withCustomDomain(String customDomain)
A custom domain name that you provide to Amazon Cognito.
|
UserPoolType |
withDeletionProtection(DeletionProtectionType deletionProtection)
When active,
DeletionProtection prevents accidental deletion of your user pool. |
UserPoolType |
withDeletionProtection(String deletionProtection)
When active,
DeletionProtection prevents accidental deletion of your user pool. |
UserPoolType |
withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device-remembering configuration for a user pool.
|
UserPoolType |
withDomain(String domain)
The domain prefix, if the user pool has a domain associated with it.
|
UserPoolType |
withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration of your user pool.
|
UserPoolType |
withEmailConfigurationFailure(String emailConfigurationFailure)
Deprecated.
|
UserPoolType |
withEmailVerificationMessage(String emailVerificationMessage)
This parameter is no longer used.
|
UserPoolType |
withEmailVerificationSubject(String emailVerificationSubject)
This parameter is no longer used.
|
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 Lambda triggers associated with the user pool.
|
UserPoolType |
withLastModifiedDate(Date lastModifiedDate)
The date and time when the item was 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 list of the user attributes and their properties in your user pool.
|
UserPoolType |
withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A list of the user attributes and their properties in your user pool.
|
UserPoolType |
withSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UserPoolType |
withSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from
your Amazon Web Services account through Amazon Simple Notification Service.
|
UserPoolType |
withSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration can't send the messages to your users.
|
UserPoolType |
withSmsVerificationMessage(String smsVerificationMessage)
This parameter is no longer used.
|
UserPoolType |
withStatus(StatusType status)
Deprecated.
|
UserPoolType |
withStatus(String status)
Deprecated.
|
UserPoolType |
withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
UserPoolType |
withUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UserPoolType |
withUsernameAttributes(String... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UserPoolType |
withUsernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
|
UserPoolType |
withUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
Case sensitivity of the username input for the selected sign-in option.
|
UserPoolType |
withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
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 setDeletionProtection(String deletionProtection)
When active, DeletionProtection
prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito returns
an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an UpdateUserPool
API request.
deletionProtection
- When active, DeletionProtection
prevents accidental deletion of your user pool. Before you
can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito
returns an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an
UpdateUserPool
API request.
DeletionProtectionType
public String getDeletionProtection()
When active, DeletionProtection
prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito returns
an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an UpdateUserPool
API request.
DeletionProtection
prevents accidental deletion of your user pool. Before you
can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito
returns an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an
UpdateUserPool
API request.
DeletionProtectionType
public UserPoolType withDeletionProtection(String deletionProtection)
When active, DeletionProtection
prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito returns
an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an UpdateUserPool
API request.
deletionProtection
- When active, DeletionProtection
prevents accidental deletion of your user pool. Before you
can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito
returns an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an
UpdateUserPool
API request.
DeletionProtectionType
public void setDeletionProtection(DeletionProtectionType deletionProtection)
When active, DeletionProtection
prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito returns
an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an UpdateUserPool
API request.
deletionProtection
- When active, DeletionProtection
prevents accidental deletion of your user pool. Before you
can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito
returns an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an
UpdateUserPool
API request.
DeletionProtectionType
public UserPoolType withDeletionProtection(DeletionProtectionType deletionProtection)
When active, DeletionProtection
prevents accidental deletion of your user pool. Before you can
delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito returns
an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an UpdateUserPool
API request.
deletionProtection
- When active, DeletionProtection
prevents accidental deletion of your user pool. Before you
can delete a user pool that you have protected against deletion, you must deactivate this feature.
When you try to delete a protected user pool in a DeleteUserPool
API request, Amazon Cognito
returns an InvalidParameterException
error. To delete a protected user pool, send a new
DeleteUserPool
request after you deactivate deletion protection in an
UpdateUserPool
API request.
DeletionProtectionType
public void setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
lambdaConfig
- The Lambda triggers associated with the user pool.public LambdaConfigType getLambdaConfig()
The Lambda triggers associated with the user pool.
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
lambdaConfig
- The Lambda triggers associated with the user pool.@Deprecated public void setStatus(String status)
This parameter is no longer used.
status
- This parameter is no longer used.StatusType
@Deprecated public String getStatus()
This parameter is no longer used.
StatusType
@Deprecated public UserPoolType withStatus(String status)
This parameter is no longer used.
status
- This parameter is no longer used.StatusType
@Deprecated public void setStatus(StatusType status)
This parameter is no longer used.
status
- This parameter is no longer used.StatusType
@Deprecated public UserPoolType withStatus(StatusType status)
This parameter is no longer used.
status
- This parameter is no longer used.StatusType
public void setLastModifiedDate(Date lastModifiedDate)
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
lastModifiedDate
- The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.public Date getLastModifiedDate()
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
Date
object.public UserPoolType withLastModifiedDate(Date lastModifiedDate)
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
lastModifiedDate
- The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.public void setCreationDate(Date creationDate)
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
creationDate
- The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.public Date getCreationDate()
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
Date
object.public UserPoolType withCreationDate(Date creationDate)
The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format.
Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date
object.
creationDate
- The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time
format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Date
object.public List<SchemaAttributeType> getSchemaAttributes()
A list of the user attributes and their properties in your user pool. The attribute schema contains standard
attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User pool
attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
custom:
prefix, and developer attributes with
a dev:
prefix. For more information, see User
pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
public void setSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A list of the user attributes and their properties in your user pool. The attribute schema contains standard
attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User pool
attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
schemaAttributes
- A list of the user attributes and their properties in your user pool. The attribute schema contains
standard attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User
pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
public UserPoolType withSchemaAttributes(SchemaAttributeType... schemaAttributes)
A list of the user attributes and their properties in your user pool. The attribute schema contains standard
attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User pool
attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
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 list of the user attributes and their properties in your user pool. The attribute schema contains
standard attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User
pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
public UserPoolType withSchemaAttributes(Collection<SchemaAttributeType> schemaAttributes)
A list of the user attributes and their properties in your user pool. The attribute schema contains standard
attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User pool
attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
schemaAttributes
- A list of the user attributes and their properties in your user pool. The attribute schema contains
standard attributes, custom attributes with a custom:
prefix, and developer attributes with a
dev:
prefix. For more information, see User
pool attributes.
Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
public List<String> getAutoVerifiedAttributes()
The attributes that are auto-verified in a user pool.
VerifiedAttributeType
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- The attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(String... autoVerifiedAttributes)
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
- The attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- The attributes that are auto-verified in a user pool.VerifiedAttributeType
public UserPoolType withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
autoVerifiedAttributes
- The attributes that are auto-verified in a user pool.VerifiedAttributeType
public List<String> getAliasAttributes()
The attributes that are aliased in a user pool.
AliasAttributeType
public void setAliasAttributes(Collection<String> aliasAttributes)
The attributes that are aliased in a user pool.
aliasAttributes
- The attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(String... aliasAttributes)
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
- The attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(Collection<String> aliasAttributes)
The attributes that are aliased in a user pool.
aliasAttributes
- The attributes that are aliased in a user pool.AliasAttributeType
public UserPoolType withAliasAttributes(AliasAttributeType... aliasAttributes)
The attributes that are aliased in a user pool.
aliasAttributes
- The attributes that are aliased in a user pool.AliasAttributeType
public List<String> getUsernameAttributes()
Specifies whether a user can use an email address or phone number as a username when they sign up.
UsernameAttributeType
public void setUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
usernameAttributes
- Specifies whether a user can use an email address or phone number as a username when they sign up.UsernameAttributeType
public UserPoolType withUsernameAttributes(String... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign 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 a user can use an email address or phone number as a username when they sign up.UsernameAttributeType
public UserPoolType withUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
usernameAttributes
- Specifies whether a user can use an email address or phone number as a username when they sign up.UsernameAttributeType
public UserPoolType withUsernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
usernameAttributes
- Specifies whether a user can use an email address or phone number as a username when they sign up.UsernameAttributeType
public void setSmsVerificationMessage(String smsVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
smsVerificationMessage
- This parameter is no longer used. See VerificationMessageTemplateType.public String getSmsVerificationMessage()
This parameter is no longer used. See VerificationMessageTemplateType.
public UserPoolType withSmsVerificationMessage(String smsVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
smsVerificationMessage
- This parameter is no longer used. See VerificationMessageTemplateType.public void setEmailVerificationMessage(String emailVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
emailVerificationMessage
- This parameter is no longer used. See VerificationMessageTemplateType.public String getEmailVerificationMessage()
This parameter is no longer used. See VerificationMessageTemplateType.
public UserPoolType withEmailVerificationMessage(String emailVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
emailVerificationMessage
- This parameter is no longer used. See VerificationMessageTemplateType.public void setEmailVerificationSubject(String emailVerificationSubject)
This parameter is no longer used. See VerificationMessageTemplateType.
emailVerificationSubject
- This parameter is no longer used. See VerificationMessageTemplateType.public String getEmailVerificationSubject()
This parameter is no longer used. See VerificationMessageTemplateType.
public UserPoolType withEmailVerificationSubject(String emailVerificationSubject)
This parameter is no longer used. See VerificationMessageTemplateType.
emailVerificationSubject
- This parameter is no longer used. See VerificationMessageTemplateType.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 setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how to
handle changes to the value of your users' email address and phone number attributes. For more information, see
Verifying updates to email addresses and phone numbers.
userAttributeUpdateSettings
- The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how
to handle changes to the value of your users' email address and phone number attributes. For more
information, see Verifying updates to email addresses and phone numbers.public UserAttributeUpdateSettingsType getUserAttributeUpdateSettings()
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how to
handle changes to the value of your users' email address and phone number attributes. For more information, see
Verifying updates to email addresses and phone numbers.
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how
to handle changes to the value of your users' email address and phone number attributes. For more
information, see Verifying updates to email addresses and phone numbers.public UserPoolType withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how to
handle changes to the value of your users' email address and phone number attributes. For more information, see
Verifying updates to email addresses and phone numbers.
userAttributeUpdateSettings
- The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how
to handle changes to the value of your users' email address and phone number attributes. For more
information, see Verifying updates to email addresses and phone numbers.public void setMfaConfiguration(String mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when you're
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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when
you're 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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when you're
initially creating a user pool.
OPTIONAL
- Users have the option when registering to create an MFA token.
OFF
- MFA tokens aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when
you're 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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when you're
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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when
you're 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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when you're
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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when
you're 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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when you're
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 aren't required and can't be specified during user registration.
ON
- MFA tokens are required for all user registrations. You can only specify required when
you're 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-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration
field, you activate the Amazon Cognito
device-remembering feature.
deviceConfiguration
- The device-remembering configuration for a user pool. A null value indicates that you have deactivated
device remembering in your user pool.
When you provide a value for any DeviceConfiguration
field, you activate the Amazon Cognito
device-remembering feature.
public DeviceConfigurationType getDeviceConfiguration()
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration
field, you activate the Amazon Cognito
device-remembering feature.
When you provide a value for any DeviceConfiguration
field, you activate the Amazon Cognito
device-remembering feature.
public UserPoolType withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any DeviceConfiguration
field, you activate the Amazon Cognito
device-remembering feature.
deviceConfiguration
- The device-remembering configuration for a user pool. A null value indicates that you have deactivated
device remembering in your user pool.
When you provide a value for any DeviceConfiguration
field, you activate the Amazon Cognito
device-remembering feature.
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 of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
emailConfiguration
- The email configuration of your user pool. The email configuration type sets your preferred sending
method, Amazon Web Services Region, and sender for messages from your user pool.public EmailConfigurationType getEmailConfiguration()
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
public UserPoolType withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
emailConfiguration
- The email configuration of your user pool. The email configuration type sets your preferred sending
method, Amazon Web Services Region, and sender for messages from your user pool.public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
smsConfiguration
- The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message
from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
Identity and Access Management (IAM) role in your Amazon Web Services account.public SmsConfigurationType getSmsConfiguration()
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
public UserPoolType withSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
smsConfiguration
- The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message
from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages
with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an
Identity and Access Management (IAM) role in your Amazon Web Services account.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 can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
smsConfigurationFailure
- The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
public String getSmsConfigurationFailure()
The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
public UserPoolType withSmsConfigurationFailure(String smsConfigurationFailure)
The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
smsConfigurationFailure
- The reason why the SMS configuration can't send the messages to your users.
This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.
The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.
The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.
public void setEmailConfigurationFailure(String emailConfigurationFailure)
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com
in
CloudTrail for information about problems with user pool email configuration.
emailConfigurationFailure
- Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com
in CloudTrail for information about problems with user pool email configuration.public String getEmailConfigurationFailure()
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com
in
CloudTrail for information about problems with user pool email configuration.
EventSource:cognito-idp.amazonaws.com
in CloudTrail for information about problems with user pool email configuration.public UserPoolType withEmailConfigurationFailure(String emailConfigurationFailure)
Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com
in
CloudTrail for information about problems with user pool email configuration.
emailConfigurationFailure
- Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com
in CloudTrail for information about problems with user pool email configuration.public void setDomain(String domain)
The domain prefix, if the user pool has a domain associated with it.
domain
- The domain prefix, if the user pool has a domain associated with it.public String getDomain()
The domain prefix, if the user pool has a domain associated with it.
public UserPoolType withDomain(String domain)
The domain prefix, if the user pool has a domain associated with it.
domain
- 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. An example of a custom domain name might be
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. An example of a custom domain name
might be 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. An example of a custom domain name might be
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. An example of a custom domain name might be
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. An example of a custom domain name
might be 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)
User pool add-ons. Contains settings for activation of advanced security features. To log user security
information but take no action, set to AUDIT
. To configure automatic security responses to risky
traffic to your user pool, set to ENFORCED
.
For more information, see Adding advanced security to a user pool.
userPoolAddOns
- User pool add-ons. Contains settings for activation of advanced security features. To log user security
information but take no action, set to AUDIT
. To configure automatic security responses to
risky traffic to your user pool, set to ENFORCED
.
For more information, see Adding advanced security to a user pool.
public UserPoolAddOnsType getUserPoolAddOns()
User pool add-ons. Contains settings for activation of advanced security features. To log user security
information but take no action, set to AUDIT
. To configure automatic security responses to risky
traffic to your user pool, set to ENFORCED
.
For more information, see Adding advanced security to a user pool.
AUDIT
. To configure automatic security responses to
risky traffic to your user pool, set to ENFORCED
.
For more information, see Adding advanced security to a user pool.
public UserPoolType withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
User pool add-ons. Contains settings for activation of advanced security features. To log user security
information but take no action, set to AUDIT
. To configure automatic security responses to risky
traffic to your user pool, set to ENFORCED
.
For more information, see Adding advanced security to a user pool.
userPoolAddOns
- User pool add-ons. Contains settings for activation of advanced security features. To log user security
information but take no action, set to AUDIT
. To configure automatic security responses to
risky traffic to your user pool, set to ENFORCED
.
For more information, see Adding advanced security to a user pool.
public void setUsernameConfiguration(UsernameConfigurationType usernameConfiguration)
Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set
to False
, users can sign in using either "username" or "Username". This configuration is immutable
once it has been set. For more information, see UsernameConfigurationType.
usernameConfiguration
- Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity
is set to False
, users can sign in using either "username" or "Username". This configuration
is immutable once it has been set. For more information, see UsernameConfigurationType.public UsernameConfigurationType getUsernameConfiguration()
Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set
to False
, users can sign in using either "username" or "Username". This configuration is immutable
once it has been set. For more information, see UsernameConfigurationType.
False
, users can 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)
Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set
to False
, users can sign in using either "username" or "Username". This configuration is immutable
once it has been set. For more information, see UsernameConfigurationType.
usernameConfiguration
- Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity
is set to False
, users can 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)
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this
setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred through email.
accountRecoverySetting
- The available verified method a user can use to recover their password when they call
ForgotPassword
. You can use this setting to define a preferred method when a user has more
than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism
if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting,
Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through
email.public AccountRecoverySettingType getAccountRecoverySetting()
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this
setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred through email.
ForgotPassword
. You can use this setting to define a preferred method when a user has more
than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism
if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting,
Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through
email.public UserPoolType withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
The available verified method a user can use to recover their password when they call ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this
setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor
authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to
determine the recovery method where SMS is preferred through email.
accountRecoverySetting
- The available verified method a user can use to recover their password when they call
ForgotPassword
. You can use this setting to define a preferred method when a user has more
than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism
if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting,
Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through
email.public String toString()
toString
in class Object
Object.toString()
public UserPoolType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.