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("software.amazon.awssdk:codegen")
public final class SetUserPoolMfaConfigRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SetUserPoolMfaConfigRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SetUserPoolMfaConfigRequest.Builder`	`builder()`
`EmailMfaConfigType`	`emailMfaConfiguration()`	Sets 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()`	Sets multi-factor authentication (MFA) to be on, off, or optional.
`String`	`mfaConfigurationAsString()`	Sets multi-factor authentication (MFA) to be on, off, or optional.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SetUserPoolMfaConfigRequest.Builder>`	`serializableBuilderClass()`
`SmsMfaConfigType`	`smsMfaConfiguration()`	Configures user pool SMS messages for MFA.
`SoftwareTokenMfaConfigType`	`softwareTokenMfaConfiguration()`	Configures a user pool for time-based one-time password (TOTP) MFA.
`SetUserPoolMfaConfigRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userPoolId()`	The user pool ID.
`WebAuthnConfigurationType`	`webAuthnConfiguration()`	The configuration of your user pool for passkey, or WebAuthn, authentication and registration.

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

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
  - userPoolId
```
public final String userPoolId()
```
    The user pool ID.
    
    Returns:
    
    The user pool ID.
  - smsMfaConfiguration
```
public final SmsMfaConfigType smsMfaConfiguration()
```
    Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.
    
    Returns:
    
    Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.
  - softwareTokenMfaConfiguration
```
public final SoftwareTokenMfaConfigType softwareTokenMfaConfiguration()
```
    Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.
    
    Returns:
    
    Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.
  - emailMfaConfiguration
```
public final EmailMfaConfigType emailMfaConfiguration()
```
    Sets 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:
    
    Sets 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()
```
    Sets multi-factor authentication (MFA) to be 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:
    
    Sets multi-factor authentication (MFA) to be 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()
```
    Sets multi-factor authentication (MFA) to be 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:
    
    Sets multi-factor authentication (MFA) to be 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, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.
    
    Returns:
    
    The configuration of your user pool for passkey, or WebAuthn, authentication and registration. You can set this configuration independent of the MFA configuration options in this operation.
  - toBuilder
```
public SetUserPoolMfaConfigRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static SetUserPoolMfaConfigRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SetUserPoolMfaConfigRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - 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 SetUserPoolMfaConfigRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

userPoolId

smsMfaConfiguration

softwareTokenMfaConfiguration

emailMfaConfiguration

mfaConfiguration

mfaConfigurationAsString

webAuthnConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField