com.amazonaws.services.cognitoidentityprovider.model

Class AdminSetUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserSettingsRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminSetUserSettingsRequest
extends AmazonWebServiceRequest
implements Serializable

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminSetUserSettingsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<MFAOptionType>	getMFAOptions() You can use this parameter only to set an SMS configuration that uses SMS for delivery.
String	getUsername() The user name of the user that you are setting options for.
String	getUserPoolId() The ID of the user pool that contains the user that you are setting options for.
int	hashCode()
void	setMFAOptions(Collection<MFAOptionType> mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
void	setUsername(String username) The user name of the user that you are setting options for.
void	setUserPoolId(String userPoolId) The ID of the user pool that contains the user that you are setting options for.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminSetUserSettingsRequest	withMFAOptions(Collection<MFAOptionType> mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest	withMFAOptions(MFAOptionType... mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest	withUsername(String username) The user name of the user that you are setting options for.
AdminSetUserSettingsRequest	withUserPoolId(String userPoolId) The ID of the user pool that contains the user that you are setting options for.

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

AdminSetUserSettingsRequest

public AdminSetUserSettingsRequest()

Method Detail

getUserPoolId

public String getUserPoolId()

The ID of the user pool that contains the user that you are setting options for.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The ID of the user pool that contains the user that you are setting options for.

setUserPoolId

public void setUserPoolId(String userPoolId)

The ID of the user pool that contains the user that you are setting options for.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The ID of the user pool that contains the user that you are setting options for.

withUserPoolId

public AdminSetUserSettingsRequest withUserPoolId(String userPoolId)

The ID of the user pool that contains the user that you are setting options for.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The ID of the user pool that contains the user that you are setting options for.

Returns:

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

getUsername

public String getUsername()

The user name of the user that you are setting options for.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name of the user that you are setting options for.

setUsername

public void setUsername(String username)

The user name of the user that you are setting options for.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user that you are setting options for.

withUsername

public AdminSetUserSettingsRequest withUsername(String username)

The user name of the user that you are setting options for.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user that you are setting options for.

Returns:

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

getMFAOptions

public List<MFAOptionType> getMFAOptions()

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

setMFAOptions

public void setMFAOptions(Collection<MFAOptionType> mFAOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Parameters:

mFAOptions -

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

withMFAOptions

public AdminSetUserSettingsRequest withMFAOptions(MFAOptionType... mFAOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

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

Parameters:

mFAOptions -

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

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

withMFAOptions

public AdminSetUserSettingsRequest withMFAOptions(Collection<MFAOptionType> mFAOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

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

Parameters:

mFAOptions -

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

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