Class SetUserPoolMfaConfigRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,
SetUserPoolMfaConfigRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
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
The MFA configuration.final String
The MFA configuration.static Class
<? extends SetUserPoolMfaConfigRequest.Builder> final SmsMfaConfigType
The SMS text message MFA configuration.The software token MFA configuration.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolId
The user pool ID.
- Returns:
- The user pool ID.
-
smsMfaConfiguration
The SMS text message MFA configuration.
- Returns:
- The SMS text message MFA configuration.
-
softwareTokenMfaConfiguration
The software token MFA configuration.
- Returns:
- The software token MFA configuration.
-
mfaConfiguration
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. 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 activated.
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:
- The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA
factor can sign in. To learn more, see Adding
Multi-Factor Authentication (MFA) to a user pool. 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 activated.
-
- See Also:
-
-
mfaConfigurationAsString
The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. 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 activated.
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:
- The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA
factor can sign in. To learn more, see Adding
Multi-Factor Authentication (MFA) to a user pool. 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 activated.
-
- See Also:
-
-
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
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. -
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
-