You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::AdminSetUserMFAPreferenceRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AdminSetUserMFAPreferenceRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  sms_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  software_token_mfa_settings: {
    enabled: false,
    preferred_mfa: false,
  },
  username: "UsernameType", # required
  user_pool_id: "UserPoolIdType", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#sms_mfa_settings ⇒ Types::SMSMfaSettingsType

The SMS text message MFA settings.

Returns:

#software_token_mfa_settings ⇒ Types::SoftwareTokenMfaSettingsType

The time-based one-time password software token MFA settings.

Returns:

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) —

    The user pool ID.

#username ⇒ String

The user pool username or alias.

Returns:

  • (String) —

    The user pool username or alias.