Class UpdateUserPoolRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to update the user pool.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.The contents of the email verification message.The subject of the email verfication messageThe AWS Lambda configuration information from the request to update the user pool.Can be one of the following values:A container with the policies you wish to update in a user pool.The contents of the SMS authentication message.A container with information about the SMS verification message.The user pool ID for the user pool you want to update.int
hashCode()
void
setAutoVerifiedAttributes
(Collection<String> autoVerifiedAttributes) The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.void
setEmailVerificationMessage
(String emailVerificationMessage) The contents of the email verification message.void
setEmailVerificationSubject
(String emailVerificationSubject) The subject of the email verfication messagevoid
setLambdaConfig
(LambdaConfigType lambdaConfig) The AWS Lambda configuration information from the request to update the user pool.void
setMfaConfiguration
(UserPoolMfaType mfaConfiguration) Can be one of the following values:void
setMfaConfiguration
(String mfaConfiguration) Can be one of the following values:void
setPolicies
(UserPoolPolicyType policies) A container with the policies you wish to update in a user pool.void
setSmsAuthenticationMessage
(String smsAuthenticationMessage) The contents of the SMS authentication message.void
setSmsVerificationMessage
(String smsVerificationMessage) A container with information about the SMS verification message.void
setUserPoolId
(String userPoolId) The user pool ID for the user pool you want to update.toString()
Returns a string representation of this object; useful for testing and debugging.withAutoVerifiedAttributes
(VerifiedAttributeType... autoVerifiedAttributes) The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.withAutoVerifiedAttributes
(String... autoVerifiedAttributes) The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.withAutoVerifiedAttributes
(Collection<String> autoVerifiedAttributes) The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.withEmailVerificationMessage
(String emailVerificationMessage) The contents of the email verification message.withEmailVerificationSubject
(String emailVerificationSubject) The subject of the email verfication messagewithLambdaConfig
(LambdaConfigType lambdaConfig) The AWS Lambda configuration information from the request to update the user pool.withMfaConfiguration
(UserPoolMfaType mfaConfiguration) Can be one of the following values:withMfaConfiguration
(String mfaConfiguration) Can be one of the following values:withPolicies
(UserPoolPolicyType policies) A container with the policies you wish to update in a user pool.withSmsAuthenticationMessage
(String smsAuthenticationMessage) The contents of the SMS authentication message.withSmsVerificationMessage
(String smsVerificationMessage) A container with information about the SMS verification message.withUserPoolId
(String userPoolId) The user pool ID for the user pool you want to update.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
UpdateUserPoolRequest
public UpdateUserPoolRequest()
-
-
Method Details
-
setUserPoolId
The user pool ID for the user pool you want to update.
- Parameters:
userPoolId
- The user pool ID for the user pool you want to update.
-
getUserPoolId
The user pool ID for the user pool you want to update.
- Returns:
- The user pool ID for the user pool you want to update.
-
withUserPoolId
The user pool ID for the user pool you want to update.
- Parameters:
userPoolId
- The user pool ID for the user pool you want to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPolicies
A container with the policies you wish to update in a user pool.
- Parameters:
policies
- A container with the policies you wish to update in a user pool.
-
getPolicies
A container with the policies you wish to update in a user pool.
- Returns:
- A container with the policies you wish to update in a user pool.
-
withPolicies
A container with the policies you wish to update in a user pool.
- Parameters:
policies
- A container with the policies you wish to update in a user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLambdaConfig
The AWS Lambda configuration information from the request to update the user pool.
- Parameters:
lambdaConfig
- The AWS Lambda configuration information from the request to update the user pool.
-
getLambdaConfig
The AWS Lambda configuration information from the request to update the user pool.
- Returns:
- The AWS Lambda configuration information from the request to update the user pool.
-
withLambdaConfig
The AWS Lambda configuration information from the request to update the user pool.
- Parameters:
lambdaConfig
- The AWS Lambda configuration information from the request to update the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAutoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
- Returns:
- The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
- See Also:
-
setAutoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
- Parameters:
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.- See Also:
-
withAutoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
NOTE: This method appends the values to the existing list (if any). Use
setAutoVerifiedAttributes(java.util.Collection)
orwithAutoVerifiedAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withAutoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
- Parameters:
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withAutoVerifiedAttributes
public UpdateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes) The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
- Parameters:
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setSmsVerificationMessage
A container with information about the SMS verification message.
- Parameters:
smsVerificationMessage
- A container with information about the SMS verification message.
-
getSmsVerificationMessage
A container with information about the SMS verification message.
- Returns:
- A container with information about the SMS verification message.
-
withSmsVerificationMessage
A container with information about the SMS verification message.
- Parameters:
smsVerificationMessage
- A container with information about the SMS verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEmailVerificationMessage
The contents of the email verification message.
- Parameters:
emailVerificationMessage
- The contents of the email verification message.
-
getEmailVerificationMessage
The contents of the email verification message.
- Returns:
- The contents of the email verification message.
-
withEmailVerificationMessage
The contents of the email verification message.
- Parameters:
emailVerificationMessage
- The contents of the email verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEmailVerificationSubject
The subject of the email verfication message
- Parameters:
emailVerificationSubject
- The subject of the email verfication message
-
getEmailVerificationSubject
The subject of the email verfication message
- Returns:
- The subject of the email verfication message
-
withEmailVerificationSubject
The subject of the email verfication message
- Parameters:
emailVerificationSubject
- The subject of the email verfication message- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSmsAuthenticationMessage
The contents of the SMS authentication message.
- Parameters:
smsAuthenticationMessage
- The contents of the SMS authentication message.
-
getSmsAuthenticationMessage
The contents of the SMS authentication message.
- Returns:
- The contents of the SMS authentication message.
-
withSmsAuthenticationMessage
The contents of the SMS authentication message.
- Parameters:
smsAuthenticationMessage
- The contents of the SMS authentication message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Parameters:
mfaConfiguration
- Can be one of the following values:OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- See Also:
-
getMfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Returns:
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- See Also:
-
withMfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Parameters:
mfaConfiguration
- Can be one of the following values:OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setMfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Parameters:
mfaConfiguration
- Can be one of the following values:OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- See Also:
-
withMfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Parameters:
mfaConfiguration
- Can be one of the following values:OFF
- MFA tokens are not required and cannot be specified during user registration.ON
- MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.OPTIONAL
- Users have the option when registering to create an MFA token.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-