com.amazonaws.services.cognitoidentityprovider.model

Class SetUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.SetUserSettingsRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SetUserSettingsRequest
extends AmazonWebServiceRequest
implements Serializable

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetUserSettingsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAccessToken() The access token for the set user settings request.
List<MFAOptionType>	getMFAOptions() Specifies the options for MFA (e.g., email or phone number).
int	hashCode()
void	setAccessToken(String accessToken) The access token for the set user settings request.
void	setMFAOptions(Collection<MFAOptionType> mFAOptions) Specifies the options for MFA (e.g., email or phone number).
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetUserSettingsRequest	withAccessToken(String accessToken) The access token for the set user settings request.
SetUserSettingsRequest	withMFAOptions(Collection<MFAOptionType> mFAOptions) Specifies the options for MFA (e.g., email or phone number).
SetUserSettingsRequest	withMFAOptions(MFAOptionType... mFAOptions) Specifies the options for MFA (e.g., email or phone number).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetUserSettingsRequest

public SetUserSettingsRequest()

Method Detail

getAccessToken

public String getAccessToken()

The access token for the set user settings request.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

The access token for the set user settings request.

setAccessToken

public void setAccessToken(String accessToken)

The access token for the set user settings request.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token for the set user settings request.

withAccessToken

public SetUserSettingsRequest withAccessToken(String accessToken)

The access token for the set user settings request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

The access token for the set user settings request.

Returns:

A reference to this updated object so that method calls can be chained together.

getMFAOptions

public List<MFAOptionType> getMFAOptions()

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

Returns:

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

setMFAOptions

public void setMFAOptions(Collection<MFAOptionType> mFAOptions)

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

Parameters:

mFAOptions -

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

withMFAOptions

public SetUserSettingsRequest withMFAOptions(MFAOptionType... mFAOptions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

mFAOptions -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withMFAOptions

public SetUserSettingsRequest withMFAOptions(Collection<MFAOptionType> mFAOptions)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

mFAOptions -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object