Class: Aws::CognitoIdentityProvider::Types::SetUserPoolMfaConfigRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#email_mfa_configuration ⇒ Types::EmailMfaConfigType

Configures user pool email messages for MFA. Sets the subject and body of the email message template for MFA messages. 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:



8000
8001
8002
8003
8004
8005
8006
8007
8008
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8000

class SetUserPoolMfaConfigRequest < Struct.new(
  :user_pool_id,
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#mfa_configuration ⇒ String

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see [Adding Multi-Factor Authentication (MFA) to a user pool]. Valid values include:

  • ‘OFF` MFA won’t be used for any users.

  • ‘ON` MFA is required for all users to sign in.

  • ‘OPTIONAL` MFA will be required only for individual users who have an MFA factor activated.

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

Returns:

  • (String) 


8000
8001
8002
8003
8004
8005
8006
8007
8008
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8000

class SetUserPoolMfaConfigRequest < Struct.new(
  :user_pool_id,
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#sms_mfa_configuration ⇒ Types::SmsMfaConfigType

Configures user pool SMS messages for MFA. Sets the message template and the SMS message sending configuration for Amazon SNS.

Returns:



8000
8001
8002
8003
8004
8005
8006
8007
8008
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8000

class SetUserPoolMfaConfigRequest < Struct.new(
  :user_pool_id,
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#software_token_mfa_configuration ⇒ Types::SoftwareTokenMfaConfigType

Configures a user pool for time-based one-time password (TOTP) MFA. Enables or disables TOTP.

Returns:



8000
8001
8002
8003
8004
8005
8006
8007
8008
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8000

class SetUserPoolMfaConfigRequest < Struct.new(
  :user_pool_id,
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) 


8000
8001
8002
8003
8004
8005
8006
8007
8008
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8000

class SetUserPoolMfaConfigRequest < Struct.new(
  :user_pool_id,
  :sms_mfa_configuration,
  :software_token_mfa_configuration,
  :email_mfa_configuration,
  :mfa_configuration)
  SENSITIVE = []
  include Aws::Structure
end