com.amazonaws.services.cognitoidentityprovider.model

Class MFAOptionType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.MFAOptionType

All Implemented Interfaces:

Serializable

public class MFAOptionType
extends Object
implements Serializable

This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.

To set either type of MFA configuration, use the AdminSetUserMFAPreference or SetUserMFAPreference actions.

To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList or GetUserResponse$UserMFASettingList responses.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MFAOptionType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAttributeName() The attribute name of the MFA option type.
String	getDeliveryMedium() The delivery medium to send the MFA code.
int	hashCode()
void	setAttributeName(String attributeName) The attribute name of the MFA option type.
void	setDeliveryMedium(DeliveryMediumType deliveryMedium) The delivery medium to send the MFA code.
void	setDeliveryMedium(String deliveryMedium) The delivery medium to send the MFA code.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MFAOptionType	withAttributeName(String attributeName) The attribute name of the MFA option type.
MFAOptionType	withDeliveryMedium(DeliveryMediumType deliveryMedium) The delivery medium to send the MFA code.
MFAOptionType	withDeliveryMedium(String deliveryMedium) The delivery medium to send the MFA code.

Methods inherited from class java.lang.Object

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

Constructor Detail

MFAOptionType

public MFAOptionType()

Method Detail

getDeliveryMedium

public String getDeliveryMedium()

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Constraints:
Allowed Values: SMS, EMAIL

Returns:

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

See Also:

DeliveryMediumType

setDeliveryMedium

public void setDeliveryMedium(String deliveryMedium)

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Constraints:
Allowed Values: SMS, EMAIL

Parameters:

deliveryMedium -

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

See Also:

DeliveryMediumType

withDeliveryMedium

public MFAOptionType withDeliveryMedium(String deliveryMedium)

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

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

Constraints:
Allowed Values: SMS, EMAIL

Parameters:

deliveryMedium -

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Returns:

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

See Also:

DeliveryMediumType

setDeliveryMedium

public void setDeliveryMedium(DeliveryMediumType deliveryMedium)

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Constraints:
Allowed Values: SMS, EMAIL

Parameters:

deliveryMedium -

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

See Also:

DeliveryMediumType

withDeliveryMedium

public MFAOptionType withDeliveryMedium(DeliveryMediumType deliveryMedium)

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

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

Constraints:
Allowed Values: SMS, EMAIL

Parameters:

deliveryMedium -

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Returns:

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

See Also:

DeliveryMediumType

getAttributeName

public String getAttributeName()

The attribute name of the MFA option type. The only valid value is phone_number.

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

Returns:

The attribute name of the MFA option type. The only valid value is phone_number.

setAttributeName

public void setAttributeName(String attributeName)

The attribute name of the MFA option type. The only valid value is phone_number.

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

Parameters:

attributeName -

The attribute name of the MFA option type. The only valid value is phone_number.

withAttributeName

public MFAOptionType withAttributeName(String attributeName)

The attribute name of the MFA option type. The only valid value is phone_number.

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

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

Parameters:

attributeName -

The attribute name of the MFA option type. The only valid value is 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