/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace CognitoIdentityProvider { namespace Model { /** */ class SetUserPoolMfaConfigRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API SetUserPoolMfaConfigRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SetUserPoolMfaConfig"; } AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The user pool ID.

*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *

The user pool ID.

*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *

The user pool ID.

*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *

The user pool ID.

*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *

The user pool ID.

*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *

The user pool ID.

*/ inline SetUserPoolMfaConfigRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *

The user pool ID.

*/ inline SetUserPoolMfaConfigRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *

The user pool ID.

*/ inline SetUserPoolMfaConfigRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *

The SMS text message MFA configuration.

*/ inline const SmsMfaConfigType& GetSmsMfaConfiguration() const{ return m_smsMfaConfiguration; } /** *

The SMS text message MFA configuration.

*/ inline bool SmsMfaConfigurationHasBeenSet() const { return m_smsMfaConfigurationHasBeenSet; } /** *

The SMS text message MFA configuration.

*/ inline void SetSmsMfaConfiguration(const SmsMfaConfigType& value) { m_smsMfaConfigurationHasBeenSet = true; m_smsMfaConfiguration = value; } /** *

The SMS text message MFA configuration.

*/ inline void SetSmsMfaConfiguration(SmsMfaConfigType&& value) { m_smsMfaConfigurationHasBeenSet = true; m_smsMfaConfiguration = std::move(value); } /** *

The SMS text message MFA configuration.

*/ inline SetUserPoolMfaConfigRequest& WithSmsMfaConfiguration(const SmsMfaConfigType& value) { SetSmsMfaConfiguration(value); return *this;} /** *

The SMS text message MFA configuration.

*/ inline SetUserPoolMfaConfigRequest& WithSmsMfaConfiguration(SmsMfaConfigType&& value) { SetSmsMfaConfiguration(std::move(value)); return *this;} /** *

The software token MFA configuration.

*/ inline const SoftwareTokenMfaConfigType& GetSoftwareTokenMfaConfiguration() const{ return m_softwareTokenMfaConfiguration; } /** *

The software token MFA configuration.

*/ inline bool SoftwareTokenMfaConfigurationHasBeenSet() const { return m_softwareTokenMfaConfigurationHasBeenSet; } /** *

The software token MFA configuration.

*/ inline void SetSoftwareTokenMfaConfiguration(const SoftwareTokenMfaConfigType& value) { m_softwareTokenMfaConfigurationHasBeenSet = true; m_softwareTokenMfaConfiguration = value; } /** *

The software token MFA configuration.

*/ inline void SetSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType&& value) { m_softwareTokenMfaConfigurationHasBeenSet = true; m_softwareTokenMfaConfiguration = std::move(value); } /** *

The software token MFA configuration.

*/ inline SetUserPoolMfaConfigRequest& WithSoftwareTokenMfaConfiguration(const SoftwareTokenMfaConfigType& value) { SetSoftwareTokenMfaConfiguration(value); return *this;} /** *

The software token MFA configuration.

*/ inline SetUserPoolMfaConfigRequest& WithSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType&& value) { SetSoftwareTokenMfaConfiguration(std::move(value)); 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.

*/ inline const UserPoolMfaType& GetMfaConfiguration() const{ return m_mfaConfiguration; } /** *

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.

*/ inline bool MfaConfigurationHasBeenSet() const { return m_mfaConfigurationHasBeenSet; } /** *

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.

*/ inline void SetMfaConfiguration(const UserPoolMfaType& value) { m_mfaConfigurationHasBeenSet = true; m_mfaConfiguration = value; } /** *

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.

*/ inline void SetMfaConfiguration(UserPoolMfaType&& value) { m_mfaConfigurationHasBeenSet = true; m_mfaConfiguration = std::move(value); } /** *

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.

*/ inline SetUserPoolMfaConfigRequest& WithMfaConfiguration(const UserPoolMfaType& value) { SetMfaConfiguration(value); 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.

*/ inline SetUserPoolMfaConfigRequest& WithMfaConfiguration(UserPoolMfaType&& value) { SetMfaConfiguration(std::move(value)); return *this;} private: Aws::String m_userPoolId; bool m_userPoolIdHasBeenSet = false; SmsMfaConfigType m_smsMfaConfiguration; bool m_smsMfaConfigurationHasBeenSet = false; SoftwareTokenMfaConfigType m_softwareTokenMfaConfiguration; bool m_softwareTokenMfaConfigurationHasBeenSet = false; UserPoolMfaType m_mfaConfiguration; bool m_mfaConfigurationHasBeenSet = false; }; } // namespace Model } // namespace CognitoIdentityProvider } // namespace Aws