Class SetUserPoolMfaConfigRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,
SetUserPoolMfaConfigRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final EmailMfaConfigType
Sets configuration for user pool email message MFA and sign-in with one-time passwords (OTPs).final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final UserPoolMfaType
Sets multi-factor authentication (MFA) to be on, off, or optional.final String
Sets multi-factor authentication (MFA) to be on, off, or optional.static Class
<? extends SetUserPoolMfaConfigRequest.Builder> final SmsMfaConfigType
Configures user pool SMS messages for MFA.Configures a user pool for time-based one-time password (TOTP) MFA.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The user pool ID.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolId
-
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
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
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
Sets multi-factor authentication (MFA) to be on, off, or optional. When
ON
, all users must set up MFA before they can sign in. WhenOPTIONAL
, 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, chooseOPTIONAL
.When
MfaConfiguration
isOPTIONAL
, 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 returnUserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommfaConfigurationAsString()
.- 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. WhenOPTIONAL
, 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, chooseOPTIONAL
.When
MfaConfiguration
isOPTIONAL
, 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:
-
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. WhenOPTIONAL
, 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, chooseOPTIONAL
.When
MfaConfiguration
isOPTIONAL
, 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 returnUserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommfaConfigurationAsString()
.- 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. WhenOPTIONAL
, 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, chooseOPTIONAL
.When
MfaConfiguration
isOPTIONAL
, 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:
-
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
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 interfaceToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,
SetUserPoolMfaConfigRequest> - Specified by:
toBuilder
in classCognitoIdentityProviderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-