public class UpdateUserPoolRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.
If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
| Constructor and Description |
|---|
UpdateUserPoolRequest() |
| Modifier and Type | Method and Description |
|---|---|
UpdateUserPoolRequest |
addUserPoolTagsEntry(java.lang.String key,
java.lang.String value)
The tag keys and values to assign to the user pool.
|
UpdateUserPoolRequest |
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> |
getAutoVerifiedAttributes()
The attributes that are automatically verified when Amazon Cognito
requests to update user pools.
|
java.lang.String |
getDeletionProtection()
When active,
DeletionProtection prevents accidental deletion
of your user pool. |
DeviceConfigurationType |
getDeviceConfiguration()
The device-remembering configuration for a user pool.
|
EmailConfigurationType |
getEmailConfiguration()
The email configuration of your user pool.
|
java.lang.String |
getEmailVerificationMessage()
This parameter is no longer used.
|
java.lang.String |
getEmailVerificationSubject()
This parameter is no longer used.
|
LambdaConfigType |
getLambdaConfig()
The Lambda configuration information from the request to update the user
pool.
|
java.lang.String |
getMfaConfiguration()
Possible values include:
|
UserPoolPolicyType |
getPolicies()
A container with the policies you want to update in a 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 |
getSmsVerificationMessage()
This parameter is no longer used.
|
UserAttributeUpdateSettingsType |
getUserAttributeUpdateSettings()
The settings for updates to user attributes.
|
UserPoolAddOnsType |
getUserPoolAddOns()
User pool add-ons.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool you want to update.
|
java.util.Map<java.lang.String,java.lang.String> |
getUserPoolTags()
The tag keys and values to assign 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 |
setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when Amazon Cognito
requests to update user pools.
|
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 |
setEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration of your user pool.
|
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 |
setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda configuration information from the request to update the user
pool.
|
void |
setMfaConfiguration(java.lang.String mfaConfiguration)
Possible values include:
|
void |
setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Possible values include:
|
void |
setPolicies(UserPoolPolicyType policies)
A container with the policies you want to update in a 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 |
setSmsVerificationMessage(java.lang.String smsVerificationMessage)
This parameter is no longer used.
|
void |
setUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
void |
setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
User pool add-ons.
|
void |
setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
|
void |
setUserPoolTags(java.util.Map<java.lang.String,java.lang.String> userPoolTags)
The tag keys and values to assign 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.
|
UpdateUserPoolRequest |
withAccountRecoverySetting(AccountRecoverySettingType accountRecoverySetting)
The available verified method a user can use to recover their password
when they call
ForgotPassword. |
UpdateUserPoolRequest |
withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
UpdateUserPoolRequest |
withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when Amazon Cognito
requests to update user pools.
|
UpdateUserPoolRequest |
withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
The attributes that are automatically verified when Amazon Cognito
requests to update user pools.
|
UpdateUserPoolRequest |
withDeletionProtection(DeletionProtectionType deletionProtection)
When active,
DeletionProtection prevents accidental deletion
of your user pool. |
UpdateUserPoolRequest |
withDeletionProtection(java.lang.String deletionProtection)
When active,
DeletionProtection prevents accidental deletion
of your user pool. |
UpdateUserPoolRequest |
withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device-remembering configuration for a user pool.
|
UpdateUserPoolRequest |
withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration of your user pool.
|
UpdateUserPoolRequest |
withEmailVerificationMessage(java.lang.String emailVerificationMessage)
This parameter is no longer used.
|
UpdateUserPoolRequest |
withEmailVerificationSubject(java.lang.String emailVerificationSubject)
This parameter is no longer used.
|
UpdateUserPoolRequest |
withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda configuration information from the request to update the user
pool.
|
UpdateUserPoolRequest |
withMfaConfiguration(java.lang.String mfaConfiguration)
Possible values include:
|
UpdateUserPoolRequest |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Possible values include:
|
UpdateUserPoolRequest |
withPolicies(UserPoolPolicyType policies)
A container with the policies you want to update in a user pool.
|
UpdateUserPoolRequest |
withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UpdateUserPoolRequest |
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.
|
UpdateUserPoolRequest |
withSmsVerificationMessage(java.lang.String smsVerificationMessage)
This parameter is no longer used.
|
UpdateUserPoolRequest |
withUserAttributeUpdateSettings(UserAttributeUpdateSettingsType userAttributeUpdateSettings)
The settings for updates to user attributes.
|
UpdateUserPoolRequest |
withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
User pool add-ons.
|
UpdateUserPoolRequest |
withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
|
UpdateUserPoolRequest |
withUserPoolTags(java.util.Map<java.lang.String,java.lang.String> userPoolTags)
The tag keys and values to assign to the user pool.
|
UpdateUserPoolRequest |
withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getUserPoolId()
The user pool ID for the user pool you want to update.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The user pool ID for the user pool you want to update.
public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool you want to update.
public UpdateUserPoolRequest withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool you want to update.
public UserPoolPolicyType getPolicies()
A container with the policies you want to update in a user pool.
A container with the policies you want to update in a user pool.
public void setPolicies(UserPoolPolicyType policies)
A container with the policies you want to update in a user pool.
policies - A container with the policies you want to update in a user pool.
public UpdateUserPoolRequest withPolicies(UserPoolPolicyType policies)
A container with the policies you want to update in a user pool.
Returns a reference to this object so that method calls can be chained together.
policies - A container with the policies you want to update in a 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 configuration information from the request to update the user pool.
The Lambda configuration information from the request to update the user pool.
public void setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda configuration information from the request to update the user pool.
lambdaConfig - The Lambda configuration information from the request to update the user pool.
public UpdateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda configuration information from the request to update the user pool.
Returns a reference to this object so that method calls can be chained together.
lambdaConfig - The Lambda configuration information from the request to update the user pool.
public java.util.List<java.lang.String> getAutoVerifiedAttributes()
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
public void setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.
public UpdateUserPoolRequest withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
Returns a reference to this object so that method calls can be chained together.
autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.
public UpdateUserPoolRequest withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when Amazon Cognito requests to update user pools.
Returns a reference to this object so that method calls can be chained together.
autoVerifiedAttributes - The attributes that are automatically verified when Amazon Cognito requests to update user pools.
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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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()
Possible values include:
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 ON when you're initially creating a user pool. You can
use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing
user pools.
OPTIONAL - Users have the option when registering to create
an MFA token.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
Possible values include:
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 ON when you're initially
creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for
existing user pools.
OPTIONAL - Users have the option when registering to
create an MFA token.
UserPoolMfaTypepublic void setMfaConfiguration(java.lang.String mfaConfiguration)
Possible values include:
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 ON when you're initially creating a user pool. You can
use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing
user pools.
OPTIONAL - Users have the option when registering to create
an MFA token.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
mfaConfiguration - Possible values include:
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 ON when you're initially
creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for
existing user pools.
OPTIONAL - Users have the option when registering
to create an MFA token.
UserPoolMfaTypepublic UpdateUserPoolRequest withMfaConfiguration(java.lang.String mfaConfiguration)
Possible values include:
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 ON when you're initially creating a user pool. You can
use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing
user pools.
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 - Possible values include:
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 ON when you're initially
creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for
existing user pools.
OPTIONAL - Users have the option when registering
to create an MFA token.
UserPoolMfaTypepublic void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Possible values include:
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 ON when you're initially creating a user pool. You can
use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing
user pools.
OPTIONAL - Users have the option when registering to create
an MFA token.
Constraints:
Allowed Values: OFF, ON, OPTIONAL
mfaConfiguration - Possible values include:
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 ON when you're initially
creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for
existing user pools.
OPTIONAL - Users have the option when registering
to create an MFA token.
UserPoolMfaTypepublic UpdateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Possible values include:
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 ON when you're initially creating a user pool. You can
use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing
user pools.
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 - Possible values include:
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 ON when you're initially
creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for
existing user pools.
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 UpdateUserPoolRequest 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 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 email invitation and verification 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 email invitation and verification 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 email invitation and verification 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 email invitation and verification messages from your user pool.
public UpdateUserPoolRequest 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 email invitation and verification 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 email invitation and verification 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 UpdateUserPoolRequest 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 tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools 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 tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
userPoolTags - The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
public UpdateUserPoolRequest withUserPoolTags(java.util.Map<java.lang.String,java.lang.String> userPoolTags)
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools 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 tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
public UpdateUserPoolRequest addUserPoolTagsEntry(java.lang.String key, java.lang.String value)
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools 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 UpdateUserPoolRequest clearUserPoolTagsEntries()
Returns a reference to this object so that method calls can be chained together.
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 UpdateUserPoolRequest 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 UpdateUserPoolRequest 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 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 UpdateUserPoolRequest 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