class Aws::CognitoIdentityProvider::Types::SetUserPoolMfaConfigRequest

@note When making an API call, you may pass SetUserPoolMfaConfigRequest

data as a 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
    }

@!attribute [rw] user_pool_id

The user pool ID.
@return [String]

@!attribute [rw] sms_mfa_configuration

The SMS text message MFA configuration.
@return [Types::SmsMfaConfigType]

@!attribute [rw] software_token_mfa_configuration

The software token MFA configuration.
@return [Types::SoftwareTokenMfaConfigType]

@!attribute [rw] mfa_configuration

The MFA configuration. Users who don't have an MFA factor set up
won't be able to sign-in if you set the MfaConfiguration value to
‘ON’. See [Adding Multi-Factor Authentication (MFA) to a User
Pool](cognito/latest/developerguide/user-pool-settings-mfa.html) to
learn more. 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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserPoolMfaConfigRequest AWS API Documentation

Constants

SENSITIVE