Class: Aws::CognitoIdentityProvider::Types::SetUserMFAPreferenceRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::SetUserMFAPreferenceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:access_token]

Instance Attribute Summary

• #access_token ⇒ String

  A valid access token that Amazon Cognito issued to the currently signed-in user.

• #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.

Instance Attribute Details

#access_token ⇒ String

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for ‘aws.cognito.signin.user.admin`.

Returns:

• (String)

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

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

#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, your user pool must be in the [ Essentials tier] or higher.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/feature-plans-features-essentials.html

Returns:

• (Types::EmailMfaSettingsType)

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

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  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 9783

class SetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_mfa_settings,
  :email_mfa_settings,
  :access_token)
  SENSITIVE = [:access_token]
  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. Users must register a TOTP authenticator before they set this as their preferred MFA method.

Returns:

• (Types::SoftwareTokenMfaSettingsType)

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

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