Class GetUserPoolMfaConfigResponse

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.GetUserPoolMfaConfigResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetUserPoolMfaConfigResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>

  • Method Details

    • 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 multi-factor authentication (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 activated.

      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 multi-factor authentication (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 activated.

      See Also:

    • mfaConfigurationAsString

      public final String mfaConfigurationAsString()

      The multi-factor authentication (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 activated.

      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 multi-factor authentication (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 activated.

      See Also:

    • toBuilder

      public GetUserPoolMfaConfigResponse.Builder 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 interface ToCopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetUserPoolMfaConfigResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetUserPoolMfaConfigResponse.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.