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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:username]

Instance Attribute Summary

• #email_mfa_settings ⇒ Types::EmailMfaSettingsType

  User preferences for email message MFA.

• #sms_mfa_settings ⇒ Types::SMSMfaSettingsType

  User preferences for SMS message MFA.

• #software_token_mfa_settings ⇒ Types::SoftwareTokenMfaSettingsType

  User preferences for time-based one-time password (TOTP) MFA.

• #user_pool_id ⇒ String

  The ID of the user pool where you want to set a user’s MFA preferences.

• #username ⇒ String

  The username of the user that you want to query or modify.

Instance Attribute Details

#email_mfa_settings ⇒ Types::EmailMfaSettingsType

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, [ advanced security features] must be active in your user pool.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html

Returns:

• (Types::EmailMfaSettingsType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1701

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

#sms_mfa_settings ⇒ Types::SMSMfaSettingsType

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

Returns:

• (Types::SMSMfaSettingsType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1701

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

#software_token_mfa_settings ⇒ Types::SoftwareTokenMfaSettingsType

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available.

Returns:

• (Types::SoftwareTokenMfaSettingsType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1701

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

#user_pool_id ⇒ String

The ID of the user pool where you want to set a user’s MFA preferences.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1701

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

#username ⇒ String

The username of the user that you want to query or modify. The value of this parameter is typically your user’s username, but it can be any of their alias attributes. If ‘username` isn’t an alias attribute in your user pool, this value must be the ‘sub` of a local user or the username of a user from a third-party IdP.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 1701

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