Class UpdateUserPoolRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.cognitoidp.model.UpdateUserPoolRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class UpdateUserPoolRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the request to update the user pool.

See Also:
  • Constructor Details

    • UpdateUserPoolRequest

      public UpdateUserPoolRequest()
  • Method Details

    • setUserPoolId

      public void setUserPoolId(String userPoolId)

      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

      public String 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

      public UpdateUserPoolRequest withUserPoolId(String userPoolId)

      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

      public void setPolicies(UserPoolPolicyType policies)

      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

      public UserPoolPolicyType 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

      public UpdateUserPoolRequest withPolicies(UserPoolPolicyType policies)

      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

      public void setLambdaConfig(LambdaConfigType lambdaConfig)

      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

      public LambdaConfigType 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

      public UpdateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)

      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

      public List<String> 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

      public void setAutoVerifiedAttributes(Collection<String> 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.
      See Also:
    • withAutoVerifiedAttributes

      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.

      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(Collection<String> 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:
    • 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

      public void setSmsVerificationMessage(String smsVerificationMessage)

      A container with information about the SMS verification message.

      Parameters:
      smsVerificationMessage - A container with information about the SMS verification message.
    • getSmsVerificationMessage

      public String getSmsVerificationMessage()

      A container with information about the SMS verification message.

      Returns:
      A container with information about the SMS verification message.
    • withSmsVerificationMessage

      public UpdateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)

      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

      public void setEmailVerificationMessage(String emailVerificationMessage)

      The contents of the email verification message.

      Parameters:
      emailVerificationMessage - The contents of the email verification message.
    • getEmailVerificationMessage

      public String getEmailVerificationMessage()

      The contents of the email verification message.

      Returns:
      The contents of the email verification message.
    • withEmailVerificationMessage

      public UpdateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)

      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

      public void setEmailVerificationSubject(String emailVerificationSubject)

      The subject of the email verfication message

      Parameters:
      emailVerificationSubject - The subject of the email verfication message
    • getEmailVerificationSubject

      public String getEmailVerificationSubject()

      The subject of the email verfication message

      Returns:
      The subject of the email verfication message
    • withEmailVerificationSubject

      public UpdateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)

      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

      public void setSmsAuthenticationMessage(String smsAuthenticationMessage)

      The contents of the SMS authentication message.

      Parameters:
      smsAuthenticationMessage - The contents of the SMS authentication message.
    • getSmsAuthenticationMessage

      public String getSmsAuthenticationMessage()

      The contents of the SMS authentication message.

      Returns:
      The contents of the SMS authentication message.
    • withSmsAuthenticationMessage

      public UpdateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)

      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

      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.
      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

      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.
      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

      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.
      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

      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.
      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

      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.
      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

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public UpdateUserPoolRequest 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 class AmazonWebServiceRequest
      See Also: