Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SetUserPoolMfaConfigResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.SetUserPoolMfaConfigResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetUserPoolMfaConfigResponse.Builder,SetUserPoolMfaConfigResponse>

@Generated("software.amazon.awssdk:codegen")
public final class SetUserPoolMfaConfigResponse
extends CognitoIdentityProviderResponse
implements ToCopyableBuilder<SetUserPoolMfaConfigResponse.Builder,SetUserPoolMfaConfigResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetUserPoolMfaConfigResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SetUserPoolMfaConfigResponse.Builder	builder()
EmailMfaConfigType	emailMfaConfiguration()	Shows user pool email message configuration for MFA.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UserPoolMfaType	mfaConfiguration()	The MFA configuration.
String	mfaConfigurationAsString()	The MFA configuration.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SetUserPoolMfaConfigResponse.Builder>	serializableBuilderClass()
SmsMfaConfigType	smsMfaConfiguration()	Shows user pool SMS message configuration for MFA.
SoftwareTokenMfaConfigType	softwareTokenMfaConfiguration()	Shows user pool configuration for time-based one-time password (TOTP) MFA.
SetUserPoolMfaConfigResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
WebAuthnConfigurationType	webAuthnConfiguration()	The configuration of your user pool for passkey, or webauthN, biometric and security-key devices.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

smsMfaConfiguration

public final SmsMfaConfigType smsMfaConfiguration()

Shows user pool SMS message configuration for MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

Returns:

Shows user pool SMS message configuration for MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.

softwareTokenMfaConfiguration

public final SoftwareTokenMfaConfigType softwareTokenMfaConfiguration()

Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

Returns:

Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.

emailMfaConfiguration

public final EmailMfaConfigType emailMfaConfiguration()

Shows user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

Returns:

Shows user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

mfaConfiguration

public final UserPoolMfaType mfaConfiguration()

The MFA configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

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. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

See Also:

UserPoolMfaType

mfaConfigurationAsString

public final String mfaConfigurationAsString()

The MFA configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

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. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

See Also:

UserPoolMfaType

webAuthnConfiguration

public final WebAuthnConfigurationType webAuthnConfiguration()

The configuration of your user pool for passkey, or webauthN, biometric and security-key devices.

Returns:

The configuration of your user pool for passkey, or webauthN, biometric and security-key devices.

toBuilder

public SetUserPoolMfaConfigResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetUserPoolMfaConfigResponse.Builder,SetUserPoolMfaConfigResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SetUserPoolMfaConfigResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo