/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.cognitoidp.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SetUserPoolMfaConfigRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The user pool ID. *
*/ private String userPoolId; /** ** The SMS text message MFA configuration. *
*/ private SmsMfaConfigType smsMfaConfiguration; /** ** The software token MFA configuration. *
*/ private SoftwareTokenMfaConfigType softwareTokenMfaConfiguration; /** ** 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.
*
* The user pool ID. *
* * @param userPoolId * The user pool ID. */ public void setUserPoolId(String userPoolId) { this.userPoolId = userPoolId; } /** ** The user pool ID. *
* * @return The user pool ID. */ public String getUserPoolId() { return this.userPoolId; } /** ** The user pool ID. *
* * @param userPoolId * The user pool ID. * @return Returns a reference to this object so that method calls can be chained together. */ public SetUserPoolMfaConfigRequest withUserPoolId(String userPoolId) { setUserPoolId(userPoolId); return this; } /** ** The SMS text message MFA configuration. *
* * @param smsMfaConfiguration * The SMS text message MFA configuration. */ public void setSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration) { this.smsMfaConfiguration = smsMfaConfiguration; } /** ** The SMS text message MFA configuration. *
* * @return The SMS text message MFA configuration. */ public SmsMfaConfigType getSmsMfaConfiguration() { return this.smsMfaConfiguration; } /** ** The SMS text message MFA configuration. *
* * @param smsMfaConfiguration * The SMS text message MFA configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public SetUserPoolMfaConfigRequest withSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration) { setSmsMfaConfiguration(smsMfaConfiguration); return this; } /** ** The software token MFA configuration. *
* * @param softwareTokenMfaConfiguration * The software token MFA configuration. */ public void setSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration) { this.softwareTokenMfaConfiguration = softwareTokenMfaConfiguration; } /** ** The software token MFA configuration. *
* * @return The software token MFA configuration. */ public SoftwareTokenMfaConfigType getSoftwareTokenMfaConfiguration() { return this.softwareTokenMfaConfiguration; } /** ** The software token MFA configuration. *
* * @param softwareTokenMfaConfiguration * The software token MFA configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public SetUserPoolMfaConfigRequest withSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration) { setSoftwareTokenMfaConfiguration(softwareTokenMfaConfiguration); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*