user_pool_mfa_configs

Creates, updates, deletes, gets or lists a user_pool_mfa_configs resource.

Overview

Name	`user_pool_mfa_configs`
Type	Resource
Id	`aws.cognito_idp.user_pool_mfa_configs`

Fields

The following fields are returned by SELECT queries:

get_user_pool_mfa_config

Name	Datatype	Description
`email_mfa_configuration`	`object`	Shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.
`mfa_configuration`	`string`	Displays the state of multi-factor authentication (MFA) as on, off, or optional. When ON, all users must set up MFA before they can sign in. When OPTIONAL, your application must make a client-side determination of whether a user wants to register an MFA device. For user pools with adaptive authentication with threat protection, choose OPTIONAL. When MfaConfiguration is OPTIONAL, managed login doesn't automatically prompt users to set up MFA. Amazon Cognito generates MFA prompts in API responses and in managed login for users who have chosen and configured a preferred MFA factor. (OFF, ON, OPTIONAL)
`sms_mfa_configuration`	`object`	Shows user pool configuration for SMS message MFA. Includes the message template and the SMS message sending configuration for Amazon SNS.
`software_token_mfa_configuration`	`object`	Shows user pool configuration for time-based one-time password (TOTP) MFA. Includes TOTP enabled or disabled state.
`web_authn_configuration`	`object`	Shows user pool configuration for sign-in with passkey authenticators such as biometric devices and security keys. Includes relying-party configuration, user-verification requirements, and whether passkeys can satisfy MFA requirements.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_user_pool_mfa_config`	`select`	`region`		Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the following: The WebAuthn relying party (RP) ID and user-verification settings. The required, optional, or disabled state of MFA for all user pool users. The message templates for email and SMS MFA. The enabled or disabled state of time-based one-time password (TOTP) MFA. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints
`set_user_pool_mfa_config`	`update`	`region`, `UserPoolId`		Sets user pool multi-factor authentication (MFA) and passkey configuration. For more information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

get_user_pool_mfa_config

Given a user pool ID, returns configuration for sign-in with WebAuthn authenticators and for multi-factor authentication (MFA). This operation describes the following: The WebAuthn relying party (RP) ID and user-verification settings. The required, optional, or disabled state of MFA for all user pool users. The message templates for email and SMS MFA. The enabled or disabled state of time-based one-time password (TOTP) MFA. Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy. Learn more Signing Amazon Web Services API Requests Using the Amazon Cognito user pools API and user pool endpoints

SELECT
email_mfa_configuration,
mfa_configuration,
sms_mfa_configuration,
software_token_mfa_configuration,
web_authn_configuration
FROM aws.cognito_idp.user_pool_mfa_configs
WHERE region = '{{ region }}' -- required
;

`UPDATE` examples

set_user_pool_mfa_config

Sets user pool multi-factor authentication (MFA) and passkey configuration. For more information about user pool MFA, see Adding MFA. For more information about WebAuthn passkeys see Authentication flows. This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in. If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Services service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

UPDATE aws.cognito_idp.user_pool_mfa_configs
SET 
UserPoolId = '{{ UserPoolId }}',
SmsMfaConfiguration = '{{ SmsMfaConfiguration }}',
SoftwareTokenMfaConfiguration = '{{ SoftwareTokenMfaConfiguration }}',
EmailMfaConfiguration = '{{ EmailMfaConfiguration }}',
MfaConfiguration = '{{ MfaConfiguration }}',
WebAuthnConfiguration = '{{ WebAuthnConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND UserPoolId = '{{ UserPoolId }}' --required
RETURNING
email_mfa_configuration,
mfa_configuration,
sms_mfa_configuration,
software_token_mfa_configuration,
web_authn_configuration;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

UPDATE examples​