com.amazonaws.services.cognitoidp.model

Class AdminSetUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminSetUserSettingsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AdminSetUserSettingsRequest()

Method Summary

Modifier and Type	Method and Description
AdminSetUserSettingsRequest	clone()
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 username of the user that you want to query or modify.
String	getUserPoolId() The ID of the user pool that contains the user whose options you're setting.
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 username of the user that you want to query or modify.
void	setUserPoolId(String userPoolId) The ID of the user pool that contains the user whose options you're setting.
String	toString() Returns a string representation of this object.
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 username of the user that you want to query or modify.
AdminSetUserSettingsRequest	withUserPoolId(String userPoolId) The ID of the user pool that contains the user whose options you're setting.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminSetUserSettingsRequest

public AdminSetUserSettingsRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The ID of the user pool that contains the user whose options you're setting.

Parameters:

userPoolId - The ID of the user pool that contains the user whose options you're setting.

getUserPoolId

public String getUserPoolId()

The ID of the user pool that contains the user whose options you're setting.

Returns:

The ID of the user pool that contains the user whose options you're setting.

withUserPoolId

public AdminSetUserSettingsRequest withUserPoolId(String userPoolId)

The ID of the user pool that contains the user whose options you're setting.

Parameters:

userPoolId - The ID of the user pool that contains the user whose options you're setting.

Returns:

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

setUsername

public void setUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

getUsername

public String getUsername()

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Returns:

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

withUsername

public AdminSetUserSettingsRequest withUsername(String username)

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Parameters:

username - The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, you can also use their sub in this request.

Returns:

Returns a reference to this 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.

NOTE: This method appends the values to the existing list (if any). Use setMFAOptions(java.util.Collection) or withMFAOptions(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this 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.

Parameters:

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

Returns:

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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdminSetUserSettingsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest