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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SetUserPoolMfaConfigResponse.Builder`	`builder()`
`EmailMfaConfigType`	`emailMfaConfiguration()`	Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs).
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`UserPoolMfaType`	`mfaConfiguration()`	Displays multi-factor authentication (MFA) as on, off, or optional.
`String`	`mfaConfigurationAsString()`	Displays multi-factor authentication (MFA) as on, off, or optional.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SetUserPoolMfaConfigResponse.Builder>`	`serializableBuilderClass()`
`SmsMfaConfigType`	`smsMfaConfiguration()`	Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs.
`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, sign-in with authenticators like 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 and sign-in with SMS-message OTPs. Includes the message template and the SMS message sending configuration for Amazon SNS.
    
    Returns:
    
    Shows user pool SMS message configuration for MFA and sign-in with SMS-message OTPs. 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 configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
    
    Returns:
    
    Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
  - mfaConfiguration
```
public final UserPoolMfaType mfaConfiguration()
```
    Displays multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    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:
    
    Displays multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    See Also:
    
    UserPoolMfaType
  - mfaConfigurationAsString
```
public final String mfaConfigurationAsString()
```
    Displays multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    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:
    
    Displays multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL.
    
    When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor.
    
    See Also:
    
    UserPoolMfaType
  - webAuthnConfiguration
```
public final WebAuthnConfigurationType webAuthnConfiguration()
```
    The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators like biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.
    
    Returns:
    
    The configuration of your user pool for passkey, or WebAuthn, sign-in with authenticators like biometric and security-key devices. Includes relying-party configuration and settings for user-verification requirements.
  - 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

Class SetUserPoolMfaConfigResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

smsMfaConfiguration

softwareTokenMfaConfiguration

emailMfaConfiguration

mfaConfiguration

mfaConfigurationAsString

webAuthnConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField