software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminSetUserSettingsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminSetUserSettingsRequest.Builder,AdminSetUserSettingsRequest>

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

Represents the request to set user settings as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdminSetUserSettingsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AdminSetUserSettingsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<MFAOptionType>	mfaOptions() Specifies the options for MFA (e.g., email or phone number).
List<SdkField<?>>	sdkFields()
static Class<? extends AdminSetUserSettingsRequest.Builder>	serializableBuilderClass()
AdminSetUserSettingsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	username() The user name of the user for whom you wish to set user settings.
String	userPoolId() The user pool ID for the user pool where you want to set the user's settings, such as MFA options.

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 String userPoolId()

The user pool ID for the user pool where you want to set the user's settings, such as MFA options.

Returns:

The user pool ID for the user pool where you want to set the user's settings, such as MFA options.

username

public String username()

The user name of the user for whom you wish to set user settings.

Returns:

The user name of the user for whom you wish to set user settings.

mfaOptions

public List<MFAOptionType> mfaOptions()

Specifies the options for MFA (e.g., email or phone number).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Specifies the options for MFA (e.g., email or phone number).

toBuilder

public AdminSetUserSettingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminSetUserSettingsRequest.Builder,AdminSetUserSettingsRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminSetUserSettingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AdminSetUserSettingsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo