UpdateUserPoolRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.16.44 API)

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
`AccountRecoverySettingType`	`accountRecoverySetting()` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAutoVerifiedAttributes()` Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasUserPoolTags()` Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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()`
`String`	`toString()` Returns a string representation of this object.
`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 tag keys and values to assign to 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - userPoolId
```
public final 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 final 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 final 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 final 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.
    
    You can use hasAutoVerifiedAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
  - hasAutoVerifiedAttributes
```
public final boolean hasAutoVerifiedAttributes()
```
    Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - autoVerifiedAttributesAsStrings
```
public final 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.
    
    You can use hasAutoVerifiedAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
  - smsVerificationMessage
```
public final String smsVerificationMessage()
```
    A container with information about the SMS verification message.
    
    Returns:
    
    A container with information about the SMS verification message.
  - emailVerificationMessage
```
public final String emailVerificationMessage()
```
    The contents of the email verification message.
    
    Returns:
    
    The contents of the email verification message.
  - emailVerificationSubject
```
public final String emailVerificationSubject()
```
    The subject of the email verification message.
    
    Returns:
    
    The subject of the email verification message.
  - verificationMessageTemplate
```
public final VerificationMessageTemplateType verificationMessageTemplate()
```
    The template for verification messages.
    
    Returns:
    
    The template for verification messages.
  - smsAuthenticationMessage
```
public final String smsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Returns:
    
    The contents of the SMS authentication message.
  - mfaConfiguration
```
public final 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 final 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 final DeviceConfigurationType deviceConfiguration()
```
    Device configuration.
    
    Returns:
    
    Device configuration.
  - emailConfiguration
```
public final EmailConfigurationType emailConfiguration()
```
    Email configuration.
    
    Returns:
    
    Email configuration.
  - smsConfiguration
```
public final SmsConfigurationType smsConfiguration()
```
    SMS configuration.
    
    Returns:
    
    SMS configuration.
  - hasUserPoolTags
```
public final boolean hasUserPoolTags()
```
    Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userPoolTags
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserPoolTags() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - adminCreateUserConfig
```
public final AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - userPoolAddOns
```
public final 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".
  - accountRecoverySetting
```
public final AccountRecoverySettingType accountRecoverySetting()
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns:
    
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - toBuilder
```
public UpdateUserPoolRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static UpdateUserPoolRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateUserPoolRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

hasAutoVerifiedAttributes

autoVerifiedAttributesAsStrings

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

smsAuthenticationMessage

mfaConfiguration

mfaConfigurationAsString

deviceConfiguration

emailConfiguration

smsConfiguration

hasUserPoolTags

userPoolTags

adminCreateUserConfig

userPoolAddOns

accountRecoverySetting

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields