@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateUserPoolRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to update the user pool.
NOOP
Constructor and Description |
---|
UpdateUserPoolRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateUserPoolRequest |
addUserPoolTagsEntry(String key,
String value) |
UpdateUserPoolRequest |
clearUserPoolTagsEntries()
Removes all the entries added into UserPoolTags.
|
UpdateUserPoolRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
AdminCreateUserConfigType |
getAdminCreateUserConfig()
The configuration for
AdminCreateUser requests. |
List<String> |
getAutoVerifiedAttributes()
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
DeviceConfigurationType |
getDeviceConfiguration()
Device configuration.
|
EmailConfigurationType |
getEmailConfiguration()
Email configuration.
|
String |
getEmailVerificationMessage()
The contents of the email verification message.
|
String |
getEmailVerificationSubject()
The subject of the email verification message.
|
LambdaConfigType |
getLambdaConfig()
The AWS Lambda configuration information from the request to update the user pool.
|
String |
getMfaConfiguration()
Can be one of the following values:
|
UserPoolPolicyType |
getPolicies()
A container with the policies you wish to update in a user pool.
|
String |
getSmsAuthenticationMessage()
The contents of the SMS authentication message.
|
SmsConfigurationType |
getSmsConfiguration()
SMS configuration.
|
String |
getSmsVerificationMessage()
A container with information about the SMS verification message.
|
UserPoolAddOnsType |
getUserPoolAddOns()
Used to enable advanced security risk detection.
|
String |
getUserPoolId()
The user pool ID for the user pool you want to update.
|
Map<String,String> |
getUserPoolTags()
The tag keys and values to assign to the user pool.
|
VerificationMessageTemplateType |
getVerificationMessageTemplate()
The template for verification messages.
|
int |
hashCode() |
void |
setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
void |
setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
void |
setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
Device configuration.
|
void |
setEmailConfiguration(EmailConfigurationType emailConfiguration)
Email configuration.
|
void |
setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
|
void |
setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
|
void |
setLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
|
void |
setMfaConfiguration(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(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
void |
setSmsConfiguration(SmsConfigurationType smsConfiguration)
SMS configuration.
|
void |
setSmsVerificationMessage(String smsVerificationMessage)
A container with information about the SMS verification message.
|
void |
setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
Used to enable advanced security risk detection.
|
void |
setUserPoolId(String userPoolId)
The user pool ID for the user pool you want to update.
|
void |
setUserPoolTags(Map<String,String> userPoolTags)
The tag keys and values to assign to the user pool.
|
void |
setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
String |
toString()
Returns a string representation of this object.
|
UpdateUserPoolRequest |
withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
UpdateUserPoolRequest |
withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
pools.
|
UpdateUserPoolRequest |
withAutoVerifiedAttributes(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 |
withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
Device configuration.
|
UpdateUserPoolRequest |
withEmailConfiguration(EmailConfigurationType emailConfiguration)
Email configuration.
|
UpdateUserPoolRequest |
withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
|
UpdateUserPoolRequest |
withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
|
UpdateUserPoolRequest |
withLambdaConfig(LambdaConfigType lambdaConfig)
The AWS Lambda configuration information from the request to update the user pool.
|
UpdateUserPoolRequest |
withMfaConfiguration(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(String smsAuthenticationMessage)
The contents of the SMS authentication message.
|
UpdateUserPoolRequest |
withSmsConfiguration(SmsConfigurationType smsConfiguration)
SMS configuration.
|
UpdateUserPoolRequest |
withSmsVerificationMessage(String smsVerificationMessage)
A container with information about the SMS verification message.
|
UpdateUserPoolRequest |
withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
Used to enable advanced security risk detection.
|
UpdateUserPoolRequest |
withUserPoolId(String userPoolId)
The user pool ID for the user pool you want to update.
|
UpdateUserPoolRequest |
withUserPoolTags(Map<String,String> userPoolTags)
The tag keys and values to assign to the user pool.
|
UpdateUserPoolRequest |
withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setUserPoolId(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 String getUserPoolId()
The user pool ID for the user pool you want to update.
public UpdateUserPoolRequest withUserPoolId(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 List<String> getAutoVerifiedAttributes()
The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
VerifiedAttributeType
public void setAutoVerifiedAttributes(Collection<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(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(Collection<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(String smsVerificationMessage)
A container with information about the SMS verification message.
smsVerificationMessage
- A container with information about the SMS verification message.public String getSmsVerificationMessage()
A container with information about the SMS verification message.
public UpdateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
A container with information about the SMS verification message.
smsVerificationMessage
- A container with information about the SMS verification message.public void setEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public String getEmailVerificationMessage()
The contents of the email verification message.
public UpdateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
The contents of the email verification message.
emailVerificationMessage
- The contents of the email verification message.public void setEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public String getEmailVerificationSubject()
The subject of the email verification message.
public UpdateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
The subject of the email verification message.
emailVerificationSubject
- The subject of the email verification message.public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate
- The template for verification messages.public VerificationMessageTemplateType getVerificationMessageTemplate()
The template for verification messages.
public UpdateUserPoolRequest withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for verification messages.
verificationMessageTemplate
- The template for verification messages.public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public String getSmsAuthenticationMessage()
The contents of the SMS authentication message.
public UpdateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)
The contents of the SMS authentication message.
smsAuthenticationMessage
- The contents of the SMS authentication message.public void setMfaConfiguration(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 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(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 void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
Device configuration.
deviceConfiguration
- Device configuration.public DeviceConfigurationType getDeviceConfiguration()
Device configuration.
public UpdateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
Device configuration.
deviceConfiguration
- Device configuration.public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
Email configuration.
emailConfiguration
- Email configuration.public EmailConfigurationType getEmailConfiguration()
Email configuration.
public UpdateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
Email configuration.
emailConfiguration
- Email configuration.public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
SMS configuration.
smsConfiguration
- SMS configuration.public SmsConfigurationType getSmsConfiguration()
SMS configuration.
public UpdateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
SMS configuration.
smsConfiguration
- SMS configuration.public Map<String,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.
public void setUserPoolTags(Map<String,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(Map<String,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 addUserPoolTagsEntry(String key, String value)
public UpdateUserPoolRequest clearUserPoolTagsEntries()
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.public AdminCreateUserConfigType getAdminCreateUserConfig()
The configuration for AdminCreateUser
requests.
AdminCreateUser
requests.public UpdateUserPoolRequest withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.public void setUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode
to the value
"AUDIT".
userPoolAddOns
- Used to enable advanced security risk detection. Set the key AdvancedSecurityMode
to the
value "AUDIT".public UserPoolAddOnsType getUserPoolAddOns()
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode
to the value
"AUDIT".
AdvancedSecurityMode
to the
value "AUDIT".public UpdateUserPoolRequest withUserPoolAddOns(UserPoolAddOnsType userPoolAddOns)
Used to enable advanced security risk detection. Set the key AdvancedSecurityMode
to the value
"AUDIT".
userPoolAddOns
- Used to enable advanced security risk detection. Set the key AdvancedSecurityMode
to the
value "AUDIT".public String toString()
toString
in class Object
Object.toString()
public UpdateUserPoolRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.