public class UserPoolType
extends java.lang.Object
implements java.io.Serializable
A container for information about the user pool.
| Constructor and Description |
|---|
UserPoolType() |
| Modifier and Type | Method and Description |
|---|---|
UserPoolType |
addUserPoolTagsEntry(java.lang.String key,
java.lang.String value)
The tags that are assigned to the user pool.
|
UserPoolType |
clearUserPoolTagsEntries()
Removes all the entries added into UserPoolTags.
|
boolean |
equals(java.lang.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. |
java.util.List<java.lang.String> |
getAliasAttributes()
The attributes that are aliased in a user pool.
|
java.lang.String |
getArn()
The Amazon Resource Name (ARN) for the user pool.
|
java.util.List<java.lang.String> |
getAutoVerifiedAttributes()
The attributes that are auto-verified in a user pool.
|
java.util.Date |
getCreationDate()
The date and time, in ISO
8601 format, when the item was created.
|
java.lang.String |
getCustomDomain()
A custom domain name that you provide to Amazon Cognito.
|
java.lang.String |
getDeletionProtection()
When active,
DeletionProtection prevents accidental deletion
of your user pool. |
DeviceConfigurationType |
getDeviceConfiguration()
The device-remembering configuration for a user pool.
|
java.lang.String |
getDomain()
The domain prefix, if the user pool has a domain associated with it.
|
EmailConfigurationType |
getEmailConfiguration()
The email configuration of your user pool.
|
java.lang.String |
getEmailConfigurationFailure()
Deprecated.
|
java.lang.String |
getEmailVerificationMessage()
This parameter is no longer used.
|
java.lang.String |
getEmailVerificationSubject()
This parameter is no longer used.
|
java.lang.Integer |
getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
|
java.lang.String |
getId()
The ID of the user pool.
|
LambdaConfigType |
getLambdaConfig()
The Lambda triggers associated with the user pool.
|
java.util.Date |
getLastModifiedDate()
The date and time, in ISO
8601 format, when the item was modified.
|
java.lang.String |
getMfaConfiguration()
Can be one of the following values:
|
java.lang.String |
getName()
The name of the user pool.
|
UserPoolPolicyType |
getPolicies()
The policies associated with the user pool.
|
java.util.List<SchemaAttributeType> |
getSchemaAttributes()
A list of the user attributes and their properties in your user pool.
|
java.lang.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.
|
java.lang.String |
getSmsConfigurationFailure()
The reason why the SMS configuration can't send the messages to your
users.
|
java.lang.String |
getSmsVerificationMessage()
This parameter is no longer used.
|
java.lang.String |
getStatus()
The status of a user pool.
|
UserAttributeUpdateSettingsType |
getUserAttributeUpdateSettings()
The settings for updates to user attributes.
|
java.util.List<java.lang.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.
|
java.util.Map<java.lang.String,java.lang.String> |
getUserPoolTags()
The tags that are assigned to the user pool.
|
VerificationMessageTemplateType |
getVerificationMessageTemplate()
The template for verification messages.
|
int |
hashCode() |
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(java.util.Collection<java.lang.String> aliasAttributes)
The attributes that are aliased in a user pool.
|
void |
setArn(java.lang.String arn)
The Amazon Resource Name (ARN) for the user pool.
|
void |
setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
void |
setCreationDate(java.util.Date creationDate)
The date and time, in ISO
8601 format, when the item was created.
|
void |
setCustomDomain(java.lang.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(java.lang.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(java.lang.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(java.lang.String emailConfigurationFailure)
Deprecated.
|
void |
setEmailVerificationMessage(java.lang.String emailVerificationMessage)
This parameter is no longer used.
|
void |
setEmailVerificationSubject(java.lang.String emailVerificationSubject)
This parameter is no longer used.
|
void |
setEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
void |
setId(java.lang.String id)
The ID of the user pool.
|
void |
setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
|
void |
setLastModifiedDate(java.util.Date lastModifiedDate)
The date and time, in ISO
8601 format, when the item was modified.
|
void |
setMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
|
void |
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
void |
setName(java.lang.String name)
The name of the user pool.
|
void |
setPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
|
void |
setSchemaAttributes(java.util.Collection<SchemaAttributeType> schemaAttributes)
A list of the user attributes and their properties in your user pool.
|
void |
setSmsAuthenticationMessage(java.lang.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(java.lang.String smsConfigurationFailure)
The reason why the SMS configuration can't send the messages to your
users.
|
void |
setSmsVerificationMessage(java.lang.String smsVerificationMessage)
This parameter is no longer used.
|
void |
setStatus(StatusType status)
The status of a user pool.
|
void |
setStatus(java.lang.String status)
The status of a user pool.
|
void |
setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
void |
setUsernameAttributes(java.util.Collection<java.lang.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(java.util.Map<java.lang.String,java.lang.String> userPoolTags)
The tags that are assigned to the user pool.
|
void |
setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
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(java.util.Collection<java.lang.String> aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType |
withAliasAttributes(java.lang.String... aliasAttributes)
The attributes that are aliased in a user pool.
|
UserPoolType |
withArn(java.lang.String arn)
The Amazon Resource Name (ARN) for the user pool.
|
UserPoolType |
withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType |
withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
|
UserPoolType |
withCreationDate(java.util.Date creationDate)
The date and time, in ISO
8601 format, when the item was created.
|
UserPoolType |
withCustomDomain(java.lang.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(java.lang.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(java.lang.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(java.lang.String emailConfigurationFailure)
Deprecated.
|
UserPoolType |
withEmailVerificationMessage(java.lang.String emailVerificationMessage)
This parameter is no longer used.
|
UserPoolType |
withEmailVerificationSubject(java.lang.String emailVerificationSubject)
This parameter is no longer used.
|
UserPoolType |
withEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
|
UserPoolType |
withId(java.lang.String id)
The ID of the user pool.
|
UserPoolType |
withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
|
UserPoolType |
withLastModifiedDate(java.util.Date lastModifiedDate)
The date and time, in ISO
8601 format, when the item was modified.
|
UserPoolType |
withMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UserPoolType |
withName(java.lang.String name)
The name of the user pool.
|
UserPoolType |
withPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
|
UserPoolType |
withSchemaAttributes(java.util.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(java.lang.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(java.lang.String smsConfigurationFailure)
The reason why the SMS configuration can't send the messages to your
users.
|
UserPoolType |
withSmsVerificationMessage(java.lang.String smsVerificationMessage)
This parameter is no longer used.
|
UserPoolType |
withStatus(StatusType status)
The status of a user pool.
|
UserPoolType |
withStatus(java.lang.String status)
The status of a user pool.
|
UserPoolType |
withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
UserPoolType |
withUsernameAttributes(java.util.Collection<java.lang.String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a
username when they sign up.
|
UserPoolType |
withUsernameAttributes(java.lang.String... 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(java.util.Map<java.lang.String,java.lang.String> userPoolTags)
The tags that are assigned to the user pool.
|
UserPoolType |
withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
public java.lang.String getId()
The ID of the user pool.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The ID of the user pool.
public void setId(java.lang.String id)
The ID of the user pool.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
id - The ID of the user pool.
public UserPoolType withId(java.lang.String id)
The ID of the user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
id - The ID of the user pool.
public java.lang.String getName()
The name of the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
The name of the user pool.
public void setName(java.lang.String name)
The name of the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
name - The name of the user pool.
public UserPoolType withName(java.lang.String name)
The name of the user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
name - The name of the user pool.
public UserPoolPolicyType getPolicies()
The policies associated with the user pool.
The policies associated with the user pool.
public void setPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
policies - The policies associated with the user pool.
public UserPoolType withPolicies(UserPoolPolicyType policies)
The policies associated with the user pool.
Returns a reference to this object so that method calls can be chained together.
policies - The policies associated with the user pool.
public java.lang.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.
Constraints:
Allowed Values: ACTIVE, INACTIVE
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.
DeletionProtectionTypepublic void setDeletionProtection(java.lang.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.
Constraints:
Allowed Values: ACTIVE, INACTIVE
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.
DeletionProtectionTypepublic UserPoolType withDeletionProtection(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ACTIVE, INACTIVE
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.
DeletionProtectionTypepublic 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.
Constraints:
Allowed Values: ACTIVE, INACTIVE
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.
DeletionProtectionTypepublic 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: ACTIVE, INACTIVE
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.
DeletionProtectionTypepublic LambdaConfigType getLambdaConfig()
The Lambda triggers associated with the user pool.
The Lambda triggers associated with the user pool.
public void setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
lambdaConfig - The Lambda triggers associated with the user pool.
public UserPoolType withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda triggers associated with the user pool.
Returns a reference to this object so that method calls can be chained together.
lambdaConfig - The Lambda triggers associated with the user pool.
public java.lang.String getStatus()
The status of a user pool.
Constraints:
Allowed Values: Enabled, Disabled
The status of a user pool.
StatusTypepublic void setStatus(java.lang.String status)
The status of a user pool.
Constraints:
Allowed Values: Enabled, Disabled
status - The status of a user pool.
StatusTypepublic UserPoolType withStatus(java.lang.String status)
The status of a user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Enabled, Disabled
status - The status of a user pool.
StatusTypepublic void setStatus(StatusType status)
The status of a user pool.
Constraints:
Allowed Values: Enabled, Disabled
status - The status of a user pool.
StatusTypepublic UserPoolType withStatus(StatusType status)
The status of a user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Enabled, Disabled
status - The status of a user pool.
StatusTypepublic java.util.Date getLastModifiedDate()
The date and time, in ISO 8601 format, when the item was modified.
The date and time, in ISO 8601 format, when the item was modified.
public void setLastModifiedDate(java.util.Date lastModifiedDate)
The date and time, in ISO 8601 format, when the item was modified.
lastModifiedDate - The date and time, in ISO 8601 format, when the item was modified.
public UserPoolType withLastModifiedDate(java.util.Date lastModifiedDate)
The date and time, in ISO 8601 format, when the item was modified.
Returns a reference to this object so that method calls can be chained together.
lastModifiedDate - The date and time, in ISO 8601 format, when the item was modified.
public java.util.Date getCreationDate()
The date and time, in ISO 8601 format, when the item was created.
The date and time, in ISO 8601 format, when the item was created.
public void setCreationDate(java.util.Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
creationDate - The date and time, in ISO 8601 format, when the item was created.
public UserPoolType withCreationDate(java.util.Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
Returns a reference to this object so that method calls can be chained together.
creationDate - The date and time, in ISO 8601 format, when the item was created.
public java.util.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.
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 void setSchemaAttributes(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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(java.util.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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.List<java.lang.String> getAutoVerifiedAttributes()
The attributes that are auto-verified in a user pool.
The attributes that are auto-verified in a user pool.
public void setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
public UserPoolType withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
Returns a reference to this object so that method calls can be chained together.
autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
public UserPoolType withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are auto-verified in a user pool.
Returns a reference to this object so that method calls can be chained together.
autoVerifiedAttributes - The attributes that are auto-verified in a user pool.
public java.util.List<java.lang.String> getAliasAttributes()
The attributes that are aliased in a user pool.
The attributes that are aliased in a user pool.
public void setAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
The attributes that are aliased in a user pool.
aliasAttributes - The attributes that are aliased in a user pool.
public UserPoolType withAliasAttributes(java.lang.String... aliasAttributes)
The attributes that are aliased in a user pool.
Returns a reference to this object so that method calls can be chained together.
aliasAttributes - The attributes that are aliased in a user pool.
public UserPoolType withAliasAttributes(java.util.Collection<java.lang.String> aliasAttributes)
The attributes that are aliased in a user pool.
Returns a reference to this object so that method calls can be chained together.
aliasAttributes - The attributes that are aliased in a user pool.
public java.util.List<java.lang.String> getUsernameAttributes()
Specifies whether a user can use an email address or phone number as a username when they sign up.
Specifies whether a user can use an email address or phone number as a username when they sign up.
public void setUsernameAttributes(java.util.Collection<java.lang.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.
public UserPoolType withUsernameAttributes(java.lang.String... usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
Returns a reference to this object so that method calls can be chained together.
usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.
public UserPoolType withUsernameAttributes(java.util.Collection<java.lang.String> usernameAttributes)
Specifies whether a user can use an email address or phone number as a username when they sign up.
Returns a reference to this object so that method calls can be chained together.
usernameAttributes - Specifies whether a user can use an email address or phone number as a username when they sign up.
public java.lang.String getSmsVerificationMessage()
This parameter is no longer used. See VerificationMessageTemplateType.
Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*
This parameter is no longer used. See VerificationMessageTemplateType.
public void setSmsVerificationMessage(java.lang.String smsVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*
smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
public UserPoolType withSmsVerificationMessage(java.lang.String smsVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*
smsVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
public java.lang.String getEmailVerificationMessage()
This parameter is no longer used. See VerificationMessageTemplateType.
Constraints:
Length: 6 - 20000
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{
N}\p{P}\s*]*
This parameter is no longer used. See VerificationMessageTemplateType.
public void setEmailVerificationMessage(java.lang.String emailVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
Constraints:
Length: 6 - 20000
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{
N}\p{P}\s*]*
emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
public UserPoolType withEmailVerificationMessage(java.lang.String emailVerificationMessage)
This parameter is no longer used. See VerificationMessageTemplateType.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 6 - 20000
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{
N}\p{P}\s*]*
emailVerificationMessage - This parameter is no longer used. See VerificationMessageTemplateType.
public java.lang.String getEmailVerificationSubject()
This parameter is no longer used. See VerificationMessageTemplateType.
Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
This parameter is no longer used. See VerificationMessageTemplateType.
public void setEmailVerificationSubject(java.lang.String emailVerificationSubject)
This parameter is no longer used. See VerificationMessageTemplateType.
Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
public UserPoolType withEmailVerificationSubject(java.lang.String emailVerificationSubject)
This parameter is no longer used. See VerificationMessageTemplateType.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 140
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+
emailVerificationSubject - This parameter is no longer used. See VerificationMessageTemplateType.
public VerificationMessageTemplateType getVerificationMessageTemplate()
The template for verification messages.
The template for verification messages.
public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate - The template for verification messages.
public UserPoolType withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
Returns a reference to this object so that method calls can be chained together.
verificationMessageTemplate - The template for verification messages.
public java.lang.String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*
The contents of the SMS authentication message.
public void setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*
smsAuthenticationMessage - The contents of the SMS authentication message.
public UserPoolType withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 6 - 140
Pattern: .*\{####\}.*
smsAuthenticationMessage - The contents of the SMS authentication message.
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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.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.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
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.
UserPoolMfaTypepublic void setMfaConfiguration(java.lang.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.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
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.
UserPoolMfaTypepublic UserPoolType withMfaConfiguration(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
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.
UserPoolMfaTypepublic 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.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
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.
UserPoolMfaTypepublic 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
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.
UserPoolMfaTypepublic 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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.Integer getEstimatedNumberOfUsers()
A number estimating the size of the user pool.
A number estimating the size of the user pool.
public void setEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
estimatedNumberOfUsers - A number estimating the size of the user pool.
public UserPoolType withEstimatedNumberOfUsers(java.lang.Integer estimatedNumberOfUsers)
A number estimating the size of the user pool.
Returns a reference to this object so that method calls can be chained together.
estimatedNumberOfUsers - A number estimating the size of the 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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 java.util.Map<java.lang.String,java.lang.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.
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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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(java.lang.String key, java.lang.String value)
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.
The method adds a new key-value pair into UserPoolTags parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into UserPoolTags.value - The corresponding value of the entry to be added into
UserPoolTags.public UserPoolType clearUserPoolTagsEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.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.
Constraints:
Length: 0 - 131072
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 setSmsConfigurationFailure(java.lang.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.
Constraints:
Length: 0 - 131072
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 UserPoolType withSmsConfigurationFailure(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 131072
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 java.lang.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.
Constraints:
Length: 0 - 131072
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 setEmailConfigurationFailure(java.lang.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.
Constraints:
Length: 0 - 131072
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 UserPoolType withEmailConfigurationFailure(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 131072
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 java.lang.String getDomain()
The domain prefix, if the user pool has a domain associated with it.
Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
The domain prefix, if the user pool has a domain associated with it.
public void setDomain(java.lang.String domain)
The domain prefix, if the user pool has a domain associated with it.
Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
domain - The domain prefix, if the user pool has a domain associated with it.
public UserPoolType withDomain(java.lang.String domain)
The domain prefix, if the user pool has a domain associated with it.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
domain - The domain prefix, if the user pool has a domain associated with it.
public java.lang.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.
Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
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 setCustomDomain(java.lang.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.
Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
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 UserPoolType withCustomDomain(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 63
Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
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 AdminCreateUserConfigType getAdminCreateUserConfig()
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser requests.
adminCreateUserConfig -
The configuration for AdminCreateUser requests.
public UserPoolType withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser requests.
Returns a reference to this object so that method calls can be chained together.
adminCreateUserConfig -
The configuration for AdminCreateUser requests.
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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String getArn()
The Amazon Resource Name (ARN) for the user pool.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
The Amazon Resource Name (ARN) for the user pool.
public void setArn(java.lang.String arn)
The Amazon Resource Name (ARN) for the user pool.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
arn - The Amazon Resource Name (ARN) for the user pool.
public UserPoolType withArn(java.lang.String arn)
The Amazon Resource Name (ARN) for the user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
arn - The Amazon Resource Name (ARN) for the user pool.
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.
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 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 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.
Returns a reference to this object so that method calls can be chained together.
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 java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object