@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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateUserPoolRequest.Builder |
| 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() |
DeviceConfigurationType |
deviceConfiguration()
Device configuration.
|
EmailConfigurationType |
emailConfiguration()
The email configuration of your user pool.
|
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()
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()
Can be one of the following values:
|
String |
mfaConfigurationAsString()
Can be one of the following values:
|
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()
A container with information about the SMS verification message.
|
UpdateUserPoolRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String userPoolId()
The user pool ID for the user pool you want to update.
public final UserPoolPolicyType policies()
A container with the policies you want to update in a user pool.
public final LambdaConfigType lambdaConfig()
The Lambda configuration information from the request to update the user pool.
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.
public final boolean hasAutoVerifiedAttributes()
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.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.
public final String smsVerificationMessage()
A container with information about the SMS verification message.
public final String emailVerificationMessage()
The contents of the email verification message.
public final String emailVerificationSubject()
The subject of the email verification message.
public final VerificationMessageTemplateType verificationMessageTemplate()
The template for verification messages.
public final String smsAuthenticationMessage()
The contents of the SMS authentication message.
public final UserPoolMfaType mfaConfiguration()
Can be one of the following values:
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().
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.
UserPoolMfaTypepublic final String mfaConfigurationAsString()
Can be one of the following values:
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().
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.
UserPoolMfaTypepublic final DeviceConfigurationType deviceConfiguration()
Device configuration.
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.
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.
public final boolean hasUserPoolTags()
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.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.
public final AdminCreateUserConfigType adminCreateUserConfig()
The configuration for AdminCreateUser requests.
AdminCreateUser requests.public final UserPoolAddOnsType userPoolAddOns()
Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
AdvancedSecurityMode to the value
"AUDIT".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.
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.public UpdateUserPoolRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateUserPoolRequest.Builder,UpdateUserPoolRequest>toBuilder in class CognitoIdentityProviderRequestpublic static UpdateUserPoolRequest.Builder builder()
public static Class<? extends UpdateUserPoolRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.