software.amazon.awssdk.services.cognitoidentityprovider.model

Class SetUserPoolMfaConfigRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.SetUserPoolMfaConfigRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SetUserPoolMfaConfigRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetUserPoolMfaConfigRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SetUserPoolMfaConfigRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
UserPoolMfaType	mfaConfiguration() The MFA configuration.
String	mfaConfigurationAsString() The MFA configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends SetUserPoolMfaConfigRequest.Builder>	serializableBuilderClass()
SmsMfaConfigType	smsMfaConfiguration() The SMS text message MFA configuration.
SoftwareTokenMfaConfigType	softwareTokenMfaConfiguration() The software token MFA configuration.
SetUserPoolMfaConfigRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId() The user pool ID.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userPoolId

public String userPoolId()

The user pool ID.

Returns:

The user pool ID.

smsMfaConfiguration

public SmsMfaConfigType smsMfaConfiguration()

The SMS text message MFA configuration.

Returns:

The SMS text message MFA configuration.

softwareTokenMfaConfiguration

public SoftwareTokenMfaConfigType softwareTokenMfaConfiguration()

The software token MFA configuration.

Returns:

The software token MFA configuration.

mfaConfiguration

public UserPoolMfaType mfaConfiguration()

The MFA configuration.

If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().

Returns:

The MFA configuration.

See Also:

UserPoolMfaType

mfaConfigurationAsString

public String mfaConfigurationAsString()

The MFA configuration.

If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().

Returns:

The MFA configuration.

See Also:

UserPoolMfaType

toBuilder

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

Specified by:

toBuilder in class CognitoIdentityProviderRequest

Returns:

a builder for type T

builder

public static SetUserPoolMfaConfigRequest.Builder builder()

serializableBuilderClass

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.