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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::AdminSetUserMFAPreferenceRequest

Includes:

Structure

Defined in:

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
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #sms_mfa_settings ⇒ Types::SMSMfaSettingsType

  The SMS text message MFA settings.

• #software_token_mfa_settings ⇒ Types::SoftwareTokenMfaSettingsType

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

• #user_pool_id ⇒ String

  The user pool ID.

• #username ⇒ String

  The user pool username or alias.

Instance Attribute Details

#sms_mfa_settings ⇒ Types::SMSMfaSettingsType

The SMS text message MFA settings.

Returns:

• (Types::SMSMfaSettingsType)

# File '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_settings ⇒ Types::SoftwareTokenMfaSettingsType

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

Returns:

• (Types::SoftwareTokenMfaSettingsType)

# File '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_id ⇒ String

The user pool ID.

Returns:

• (String)

# File '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

#username ⇒ String

The user pool username or alias.

Returns:

• (String)

# File '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