UpdateUserPoolRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.18.39 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()` The available verified 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 Amazon Cognito requests to update user pools.
`List<String>`	`autoVerifiedAttributesAsStrings()` The attributes that are automatically verified when Amazon Cognito requests to update user pools.
`static UpdateUserPoolRequest.Builder`	`builder()`
`DeletionProtectionType`	`deletionProtection()` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`String`	`deletionProtectionAsString()` When active, `DeletionProtection` prevents accidental deletion of your user pool.
`DeviceConfigurationType`	`deviceConfiguration()` The device-remembering configuration for a user pool.
`EmailConfigurationType`	`emailConfiguration()` The email configuration of your user pool.
`String`	`emailVerificationMessage()` This parameter is no longer used.
`String`	`emailVerificationSubject()` This parameter is no longer used.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAutoVerifiedAttributes()` For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property.
`int`	`hashCode()`
`boolean`	`hasUserPoolTags()` For responses, this returns true if the service returned a value for the UserPoolTags property.
`LambdaConfigType`	`lambdaConfig()` The Lambda configuration information from the request to update the user pool.
`UserPoolMfaType`	`mfaConfiguration()` Possible values include:
`String`	`mfaConfigurationAsString()` Possible values include:
`UserPoolPolicyType`	`policies()` A container with the policies you want 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()` The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.
`String`	`smsVerificationMessage()` This parameter is no longer used.
`UpdateUserPoolRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UserAttributeUpdateSettingsType`	`userAttributeUpdateSettings()` The settings for updates to user attributes.
`UserPoolAddOnsType`	`userPoolAddOns()` Enables 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 want to update in a user pool.
    
    Returns:
    
    A container with the policies you want to update in a user pool.
  - deletionProtection
```
public final DeletionProtectionType deletionProtection()
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    If the service returns an enum value that is not available in the current SDK version, deletionProtection will return DeletionProtectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deletionProtectionAsString().
    
    Returns:
    
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    See Also:
    
    DeletionProtectionType
  - deletionProtectionAsString
```
public final String deletionProtectionAsString()
```
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    If the service returns an enum value that is not available in the current SDK version, deletionProtection will return DeletionProtectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deletionProtectionAsString().
    
    Returns:
    
    When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.
    
    When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.
    
    See Also:
    
    DeletionProtectionType
  - lambdaConfig
```
public final LambdaConfigType lambdaConfig()
```
    The Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    The Lambda configuration information from the request to update the user pool.
  - autoVerifiedAttributes
```
public final List<VerifiedAttributeType> autoVerifiedAttributes()
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoVerifiedAttributes() method.
    
    Returns:
    
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
  - hasAutoVerifiedAttributes
```
public final boolean hasAutoVerifiedAttributes()
```
    For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - autoVerifiedAttributesAsStrings
```
public final List<String> autoVerifiedAttributesAsStrings()
```
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAutoVerifiedAttributes() method.
    
    Returns:
    
    The attributes that are automatically verified when Amazon Cognito requests to update user pools.
  - smsVerificationMessage
```
public final String smsVerificationMessage()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - emailVerificationMessage
```
public final String emailVerificationMessage()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - emailVerificationSubject
```
public final String emailVerificationSubject()
```
    This parameter is no longer used. See VerificationMessageTemplateType.
    
    Returns:
    
    This parameter is no longer used. See VerificationMessageTemplateType.
  - 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.
  - userAttributeUpdateSettings
```
public final UserAttributeUpdateSettingsType userAttributeUpdateSettings()
```
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
    
    Returns:
    
    The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
  - mfaConfiguration
```
public final UserPoolMfaType mfaConfiguration()
```
    Possible values include:
    - OFF - MFA tokens aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - 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:
    Possible values include:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - mfaConfigurationAsString
```
public final String mfaConfigurationAsString()
```
    Possible values include:
    - OFF - MFA tokens aren't required and can't be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    - 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:
    Possible values include:
    
    OFF - MFA tokens aren't required and can't be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - deviceConfiguration
```
public final DeviceConfigurationType deviceConfiguration()
```
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
    
    Returns:
    
    The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
    
    When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
  - emailConfiguration
```
public final EmailConfigurationType emailConfiguration()
```
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
    
    Returns:
    
    The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool.
  - smsConfiguration
```
public final SmsConfigurationType smsConfiguration()
```
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
    
    Returns:
    
    The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
  - hasUserPoolTags
```
public final boolean hasUserPoolTags()
```
    For responses, this returns true if the service returned a value for the UserPoolTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserPoolTags() method.
    
    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()
```
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - accountRecoverySetting
```
public final AccountRecoverySettingType accountRecoverySetting()
```
    The available verified method a user can use to recover their password when they call ForgotPassword . You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
    
    Returns:
    
    The available verified method a user can use to recover their password when they call ForgotPassword. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through 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

deletionProtection

deletionProtectionAsString

lambdaConfig

autoVerifiedAttributes

hasAutoVerifiedAttributes

autoVerifiedAttributesAsStrings

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

smsAuthenticationMessage

userAttributeUpdateSettings

mfaConfiguration

mfaConfigurationAsString

deviceConfiguration

emailConfiguration

smsConfiguration

hasUserPoolTags

userPoolTags

adminCreateUserConfig

userPoolAddOns

accountRecoverySetting

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields