Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

set-user-pool-mfa-config

Description

Set the user pool multi-factor authentication (MFA) configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  set-user-pool-mfa-config
--user-pool-id <value>
[--sms-mfa-configuration <value>]
[--software-token-mfa-configuration <value>]
[--mfa-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID.

--sms-mfa-configuration (structure)

The SMS text message MFA configuration.

Shorthand Syntax:

SmsAuthenticationMessage=string,SmsConfiguration={SnsCallerArn=string,ExternalId=string}

JSON Syntax:

{
  "SmsAuthenticationMessage": "string",
  "SmsConfiguration": {
    "SnsCallerArn": "string",
    "ExternalId": "string"
  }
}

--software-token-mfa-configuration (structure)

The software token MFA configuration.

Shorthand Syntax:

Enabled=boolean

JSON Syntax:

{
  "Enabled": true|false
}

--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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

SmsMfaConfiguration -> (structure)

The SMS text message MFA configuration.

SmsAuthenticationMessage -> (string)

The SMS authentication message that will be sent to users with the code they need to sign in. The message must contain the ‘{####}’ placeholder, which will be replaced with the code. If the message is not included, and default message will be used.

SmsConfiguration -> (structure)

The SMS configuration.

SnsCallerArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.

ExternalId -> (string)

The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId , the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID . If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId .

SoftwareTokenMfaConfiguration -> (structure)

The software token MFA configuration.

Enabled -> (boolean)

Specifies whether software token MFA is enabled.

MfaConfiguration -> (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.