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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass AdminSetUserMFAPreferenceRequest data as a 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
}

Constant Summary collapse

SENSITIVE =
[:username]

Instance Attribute Summary collapse

Instance Attribute Details

#sms_mfa_settingsTypes::SMSMfaSettingsType

The SMS text message MFA settings.



1852
1853
1854
1855
1856
1857
1858
1859
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1852

class AdminSetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :username,
  :user_pool_id)
  SENSITIVE = [:username]
  include Aws::Structure
end

#software_token_mfa_settingsTypes::SoftwareTokenMfaSettingsType

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



1852
1853
1854
1855
1856
1857
1858
1859
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1852

class AdminSetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :username,
  :user_pool_id)
  SENSITIVE = [:username]
  include Aws::Structure
end

#user_pool_idString

The user pool ID.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1852

class AdminSetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :username,
  :user_pool_id)
  SENSITIVE = [:username]
  include Aws::Structure
end

#usernameString

The user pool username or alias.

Returns:

  • (String)


1852
1853
1854
1855
1856
1857
1858
1859
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1852

class AdminSetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :username,
  :user_pool_id)
  SENSITIVE = [:username]
  include Aws::Structure
end