software.amazon.awssdk.services.amplifybackend.model

Class CreateBackendAuthMFAConfig

java.lang.Object

software.amazon.awssdk.services.amplifybackend.model.CreateBackendAuthMFAConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateBackendAuthMFAConfig.Builder,CreateBackendAuthMFAConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBackendAuthMFAConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateBackendAuthMFAConfig.Builder,CreateBackendAuthMFAConfig>

Describes whether to apply multi-factor authentication (MFA) policies for your Amazon Cognito user pool that's configured as a part of your Amplify project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateBackendAuthMFAConfig.Builder

Method Summary

Modifier and Type	Method and Description
static CreateBackendAuthMFAConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MFAMode	mfaMode() Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
String	mfaModeAsString() Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateBackendAuthMFAConfig.Builder>	serializableBuilderClass()
Settings	settings() Describes the configuration settings and methods for your Amplify app users to use MFA.
CreateBackendAuthMFAConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

mfaMode

public final MFAMode mfaMode()

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

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

Returns:

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

See Also:

MFAMode

mfaModeAsString

public final String mfaModeAsString()

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

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

Returns:

Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.

See Also:

MFAMode

settings

public final Settings settings()

Describes the configuration settings and methods for your Amplify app users to use MFA.

Returns:

Describes the configuration settings and methods for your Amplify app users to use MFA.

toBuilder

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

Returns:

a builder for type T

builder

public static CreateBackendAuthMFAConfig.Builder builder()

serializableBuilderClass

public static Class<? extends CreateBackendAuthMFAConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

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

sdkFields

public final 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.