public class UpdateUserPoolRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Represents the request to update the user pool.
Modifier and Type | Field and Description |
---|---|
private java.util.List<java.lang.String> |
autoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
|
private java.lang.String |
emailVerificationMessage
The contents of the email verification message.
|
private java.lang.String |
emailVerificationSubject
The subject of the email verfication message
|
private LambdaConfigType |
lambdaConfig
The AWS Lambda configuration information from the request to update the
user pool.
|
private java.lang.String |
mfaConfiguration
Can be one of the following values:
|
private UserPoolPolicyType |
policies
A container with the policies you wish to update in a user pool.
|
private java.lang.String |
smsAuthenticationMessage
The contents of the SMS authentication message.
|
private java.lang.String |
smsVerificationMessage
A container with information about the SMS verification message.
|
private java.lang.String |
userPoolId
The user pool ID for the user pool you want to update.
|
NOOP
Constructor and Description |
---|
UpdateUserPoolRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateUserPoolRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getAutoVerifiedAttributes()
The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
|
java.lang.String |
getEmailVerificationMessage()
The contents of the email verification message.
|
java.lang.String |
getEmailVerificationSubject()
The subject of the email verfication message
|
LambdaConfigType |
getLambdaConfig()
The AWS Lambda configuration information from the request to update the
user pool.
|
java.lang.String |
getMfaConfiguration()
Can be one of the following values:
|
UserPoolPolicyType |
getPolicies()
A container with the policies you wish to update in a user pool.
|
java.lang.String |
getSmsAuthenticationMessage()
The contents of the SMS authentication message.
|
java.lang.String |
getSmsVerificationMessage()
A container with information about the SMS verification message.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool you want to update.
|
int |
hashCode() |
void |
setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
|
void |
setEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
|
void |
setEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verfication message
|
void |
setLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the
user pool.
|
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 |
setPolicies(UserPoolPolicyType policies)
A container with the policies you wish to update in a user pool.
|
void |
setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
void |
setSmsVerificationMessage(java.lang.String smsVerificationMessage)
A container with information about the SMS verification message.
|
void |
setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateUserPoolRequest |
withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
|
UpdateUserPoolRequest |
withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
|
UpdateUserPoolRequest |
withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito
service makes a request to update user pools.
|
UpdateUserPoolRequest |
withEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
|
UpdateUserPoolRequest |
withEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verfication message
|
UpdateUserPoolRequest |
withLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the
user pool.
|
UpdateUserPoolRequest |
withMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
|
UpdateUserPoolRequest |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
|
UpdateUserPoolRequest |
withPolicies(UserPoolPolicyType policies)
A container with the policies you wish to update in a user pool.
|
UpdateUserPoolRequest |
withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UpdateUserPoolRequest |
withSmsVerificationMessage(java.lang.String smsVerificationMessage)
A container with information about the SMS verification message.
|
UpdateUserPoolRequest |
withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
|
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
private java.lang.String userPoolId
The user pool ID for the user pool you want to update.
private UserPoolPolicyType policies
A container with the policies you wish to update in a user pool.
private LambdaConfigType lambdaConfig
The AWS Lambda configuration information from the request to update the user pool.
private java.util.List<java.lang.String> autoVerifiedAttributes
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
private java.lang.String smsVerificationMessage
A container with information about the SMS verification message.
private java.lang.String emailVerificationMessage
The contents of the email verification message.
private java.lang.String emailVerificationSubject
The subject of the email verfication message
private java.lang.String smsAuthenticationMessage
The contents of the SMS authentication message.
private java.lang.String mfaConfiguration
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool you want to update.
userPoolId
- The user pool ID for the user pool you want to update.public java.lang.String getUserPoolId()
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.
userPoolId
- The user pool ID for the user pool you want to update.public void setPolicies(UserPoolPolicyType policies)
A container with the policies you wish to update in a user pool.
policies
- A container with the policies you wish to update in a user pool.public UserPoolPolicyType getPolicies()
A container with the policies you wish to update in a user pool.
public UpdateUserPoolRequest withPolicies(UserPoolPolicyType policies)
A container with the policies you wish to update in a user pool.
policies
- A container with the policies you wish to update in a user pool.public void setLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
lambdaConfig
- The AWS Lambda configuration information from the request to
update the user pool.public LambdaConfigType getLambdaConfig()
The AWS Lambda configuration information from the request to update the user pool.
public UpdateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
lambdaConfig
- The AWS 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 the Amazon Cognito service makes a request to update user pools.
VerifiedAttributeType
public void setAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon
Cognito service makes a request to update user pools.VerifiedAttributeType
public UpdateUserPoolRequest withAutoVerifiedAttributes(java.lang.String... autoVerifiedAttributes)
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)
or
withAutoVerifiedAttributes(java.util.Collection)
if you want to
override the existing values.
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon
Cognito service makes a request to update user pools.VerifiedAttributeType
public UpdateUserPoolRequest withAutoVerifiedAttributes(java.util.Collection<java.lang.String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon
Cognito service makes a request to update user pools.VerifiedAttributeType
public UpdateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
autoVerifiedAttributes
- The attributes that are automatically verified when the Amazon
Cognito service makes a request to update user pools.VerifiedAttributeType
public void setSmsVerificationMessage(java.lang.String smsVerificationMessage)
A container with information about the SMS verification message.
smsVerificationMessage
- A container with information about the SMS verification message.public java.lang.String getSmsVerificationMessage()
A container with information about the SMS verification message.
public UpdateUserPoolRequest withSmsVerificationMessage(java.lang.String smsVerificationMessage)
A container with information about the SMS verification message.
smsVerificationMessage
- A container with information about the SMS verification message.public void setEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public java.lang.String getEmailVerificationMessage()
The contents of the email verification message.
public UpdateUserPoolRequest withEmailVerificationMessage(java.lang.String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public void setEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verfication message
emailVerificationSubject
- The subject of the email verfication messagepublic java.lang.String getEmailVerificationSubject()
The subject of the email verfication message
public UpdateUserPoolRequest withEmailVerificationSubject(java.lang.String emailVerificationSubject)
The subject of the email verfication message
emailVerificationSubject
- The subject of the email verfication messagepublic void setSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public java.lang.String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
public UpdateUserPoolRequest withSmsAuthenticationMessage(java.lang.String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public void setMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public java.lang.String getMfaConfiguration()
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when
registering to create an MFA token.UserPoolMfaType
public UpdateUserPoolRequest withMfaConfiguration(java.lang.String mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public UpdateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user registrations.
You can only specify required when you are initially creating a user
pool.OPTIONAL
- Users have the option when registering to
create an MFA token.mfaConfiguration
- Can be one of the following values:
OFF
- MFA tokens are not required and cannot be
specified during user registration.ON
- MFA tokens are required for all user
registrations. You can only specify required when you are
initially creating a user pool.OPTIONAL
- Users have the option when registering
to create an MFA token.UserPoolMfaType
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public UpdateUserPoolRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()