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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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 username of the user that you want to query or modify.

Instance Attribute Details

#sms_mfa_settings ⇒ Types::SMSMfaSettingsType

The SMS text message MFA settings.

Returns:

• (Types::SMSMfaSettingsType)

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

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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

class AdminSetUserMFAPreferenceRequest < Struct.new(
  :sms_mfa_settings,
  :software_token_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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 1674

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