Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminSetUserSettingsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.AdminSetUserSettingsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<AdminSetUserSettingsRequest.Builder,AdminSetUserSettingsRequest>

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

Represents the request to set user settings as an administrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdminSetUserSettingsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static AdminSetUserSettingsRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
List<MFAOptionType>	mfaOptions()	Specifies the options for MFA (e.g., email or phone number).
static Class<? extends AdminSetUserSettingsRequest.Builder>	serializableBuilderClass()
AdminSetUserSettingsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

Returns:

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

toBuilder

public AdminSetUserSettingsRequest.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<AdminSetUserSettingsRequest.Builder,AdminSetUserSettingsRequest>

Returns:

a builder for type T

builder

public static AdminSetUserSettingsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AdminSetUserSettingsRequest.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