You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SetUserPoolMfaConfigRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  user_pool_id: "UserPoolIdType", # required
  sms_mfa_configuration: {
    sms_authentication_message: "SmsVerificationMessageType",
    sms_configuration: {
      sns_caller_arn: "ArnType", # required
      external_id: "StringType",
    },
  },
  software_token_mfa_configuration: {
    enabled: false,
  },
  mfa_configuration: "OFF", # accepts OFF, ON, OPTIONAL
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#mfa_configuration ⇒ String

The MFA configuration. Valid values include:

  • OFF MFA will not 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 enabled.

    Possible values:

    • OFF
    • ON
    • OPTIONAL

Returns:

  • (String) —

    The MFA configuration.

#sms_mfa_configuration ⇒ Types::SmsMfaConfigType

The SMS text message MFA configuration.

Returns:

#software_token_mfa_configuration ⇒ Types::SoftwareTokenMfaConfigType

The software token MFA configuration.

Returns:

#user_pool_id ⇒ String

The user pool ID.

Returns:

  • (String) —

    The user pool ID.