UpdateUserPoolRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateUserPoolRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateUserPoolRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>

Represents the request to update the user pool.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateUserPoolRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateUserPoolRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminCreateUserConfigType`	`adminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<VerifiedAttributeType>`	`autoVerifiedAttributes()` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`List<String>`	`autoVerifiedAttributesAsStrings()` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`static UpdateUserPoolRequest.Builder`	`builder()`
`DeviceConfigurationType`	`deviceConfiguration()` Device configuration.
`EmailConfigurationType`	`emailConfiguration()` Email configuration.
`String`	`emailVerificationMessage()` The contents of the email verification message.
`String`	`emailVerificationSubject()` The subject of the email verification message.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`LambdaConfigType`	`lambdaConfig()` The AWS Lambda configuration information from the request to update the user pool.
`UserPoolMfaType`	`mfaConfiguration()` Can be one of the following values:
`String`	`mfaConfigurationAsString()` Can be one of the following values:
`UserPoolPolicyType`	`policies()` A container with the policies you wish to update in a user pool.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateUserPoolRequest.Builder>`	`serializableBuilderClass()`
`String`	`smsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`smsConfiguration()` SMS configuration.
`String`	`smsVerificationMessage()` A container with information about the SMS verification message.
`UpdateUserPoolRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`UserPoolAddOnsType`	`userPoolAddOns()` Used to enable advanced security risk detection.
`String`	`userPoolId()` The user pool ID for the user pool you want to update.
`Map<String,String>`	`userPoolTags()` The cost allocation tags for the user pool.
`VerificationMessageTemplateType`	`verificationMessageTemplate()` The template for verification messages.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - userPoolId
```
public String userPoolId()
```
    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.
  - policies
```
public UserPoolPolicyType policies()
```
    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.
  - lambdaConfig
```
public LambdaConfigType lambdaConfig()
```
    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.
  - autoVerifiedAttributes
```
public List<VerifiedAttributeType> autoVerifiedAttributes()
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
  - autoVerifiedAttributesAsStrings
```
public List<String> autoVerifiedAttributesAsStrings()
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
  - smsVerificationMessage
```
public String smsVerificationMessage()
```
    A container with information about the SMS verification message.
    
    Returns:
    
    A container with information about the SMS verification message.
  - emailVerificationMessage
```
public String emailVerificationMessage()
```
    The contents of the email verification message.
    
    Returns:
    
    The contents of the email verification message.
  - emailVerificationSubject
```
public String emailVerificationSubject()
```
    The subject of the email verification message.
    
    Returns:
    
    The subject of the email verification message.
  - verificationMessageTemplate
```
public VerificationMessageTemplateType verificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - smsAuthenticationMessage
```
public String smsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Returns:
    
    The contents of the SMS authentication message.
  - mfaConfiguration
```
public 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.
    If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().
    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:
    
    UserPoolMfaType
  - mfaConfigurationAsString
```
public String mfaConfigurationAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().
    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:
    
    UserPoolMfaType
  - deviceConfiguration
```
public DeviceConfigurationType deviceConfiguration()
```
    Device configuration.
    
    Returns:
    
    Device configuration.
  - emailConfiguration
```
public EmailConfigurationType emailConfiguration()
```
    Email configuration.
    
    Returns:
    
    Email configuration.
  - smsConfiguration
```
public SmsConfigurationType smsConfiguration()
```
    SMS configuration.
    
    Returns:
    
    SMS configuration.
  - userPoolTags
```
public Map<String,String> userPoolTags()
```
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
  - adminCreateUserConfig
```
public AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - userPoolAddOns
```
public UserPoolAddOnsType userPoolAddOns()
```
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - toBuilder
```
public UpdateUserPoolRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static UpdateUserPoolRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateUserPoolRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class UpdateUserPoolRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

userPoolId

policies

lambdaConfig

autoVerifiedAttributes

autoVerifiedAttributesAsStrings

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

smsAuthenticationMessage

mfaConfiguration

mfaConfigurationAsString

deviceConfiguration

emailConfiguration

smsConfiguration

userPoolTags

adminCreateUserConfig

userPoolAddOns

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields