Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest Class Reference

#include <SetUserPoolMfaConfigRequest.h>

Inheritance diagram for Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest:

Public Member Functions
	SetUserPoolMfaConfigRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetUserPoolId () const
bool	UserPoolIdHasBeenSet () const
void	SetUserPoolId (const Aws::String &value)
void	SetUserPoolId (Aws::String &&value)
void	SetUserPoolId (const char *value)
SetUserPoolMfaConfigRequest &	WithUserPoolId (const Aws::String &value)
SetUserPoolMfaConfigRequest &	WithUserPoolId (Aws::String &&value)
SetUserPoolMfaConfigRequest &	WithUserPoolId (const char *value)
const SmsMfaConfigType &	GetSmsMfaConfiguration () const
bool	SmsMfaConfigurationHasBeenSet () const
void	SetSmsMfaConfiguration (const SmsMfaConfigType &value)
void	SetSmsMfaConfiguration (SmsMfaConfigType &&value)
SetUserPoolMfaConfigRequest &	WithSmsMfaConfiguration (const SmsMfaConfigType &value)
SetUserPoolMfaConfigRequest &	WithSmsMfaConfiguration (SmsMfaConfigType &&value)
const SoftwareTokenMfaConfigType &	GetSoftwareTokenMfaConfiguration () const
bool	SoftwareTokenMfaConfigurationHasBeenSet () const
void	SetSoftwareTokenMfaConfiguration (const SoftwareTokenMfaConfigType &value)
void	SetSoftwareTokenMfaConfiguration (SoftwareTokenMfaConfigType &&value)
SetUserPoolMfaConfigRequest &	WithSoftwareTokenMfaConfiguration (const SoftwareTokenMfaConfigType &value)
SetUserPoolMfaConfigRequest &	WithSoftwareTokenMfaConfiguration (SoftwareTokenMfaConfigType &&value)
const UserPoolMfaType &	GetMfaConfiguration () const
bool	MfaConfigurationHasBeenSet () const
void	SetMfaConfiguration (const UserPoolMfaType &value)
void	SetMfaConfiguration (UserPoolMfaType &&value)
SetUserPoolMfaConfigRequest &	WithMfaConfiguration (const UserPoolMfaType &value)
SetUserPoolMfaConfigRequest &	WithMfaConfiguration (UserPoolMfaType &&value)
Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual	~CognitoIdentityProviderRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 24 of file SetUserPoolMfaConfigRequest.h.

Constructor & Destructor Documentation

SetUserPoolMfaConfigRequest()

Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetUserPoolMfaConfigRequest

(

)

Member Function Documentation

GetMfaConfiguration()

const UserPoolMfaType& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::GetMfaConfiguration ( ) const

inline

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

Definition at line 153 of file SetUserPoolMfaConfigRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest.

GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SetUserPoolMfaConfigRequest.h.

GetSmsMfaConfiguration()

const SmsMfaConfigType& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::GetSmsMfaConfiguration ( ) const

inline

The SMS text message MFA configuration.

Definition at line 84 of file SetUserPoolMfaConfigRequest.h.

GetSoftwareTokenMfaConfiguration()

const SoftwareTokenMfaConfigType& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::GetSoftwareTokenMfaConfiguration ( ) const

inline

The software token MFA configuration.

Definition at line 115 of file SetUserPoolMfaConfigRequest.h.

GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::GetUserPoolId ( ) const

inline

The user pool ID.

Definition at line 43 of file SetUserPoolMfaConfigRequest.h.

MfaConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::MfaConfigurationHasBeenSet ( ) const

inline

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

Definition at line 165 of file SetUserPoolMfaConfigRequest.h.

SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetMfaConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetMfaConfiguration ( const UserPoolMfaType &  value )

inline

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

Definition at line 177 of file SetUserPoolMfaConfigRequest.h.

SetMfaConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetMfaConfiguration ( UserPoolMfaType &&  value )

inline

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

Definition at line 189 of file SetUserPoolMfaConfigRequest.h.

SetSmsMfaConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetSmsMfaConfiguration ( const SmsMfaConfigType &  value )

inline

The SMS text message MFA configuration.

Definition at line 94 of file SetUserPoolMfaConfigRequest.h.

SetSmsMfaConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetSmsMfaConfiguration ( SmsMfaConfigType &&  value )

inline

The SMS text message MFA configuration.

Definition at line 99 of file SetUserPoolMfaConfigRequest.h.

SetSoftwareTokenMfaConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetSoftwareTokenMfaConfiguration ( const SoftwareTokenMfaConfigType &  value )

inline

The software token MFA configuration.

Definition at line 125 of file SetUserPoolMfaConfigRequest.h.

SetSoftwareTokenMfaConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetSoftwareTokenMfaConfiguration ( SoftwareTokenMfaConfigType &&  value )

inline

The software token MFA configuration.

Definition at line 130 of file SetUserPoolMfaConfigRequest.h.

SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetUserPoolId ( Aws::String &&  value )

inline

The user pool ID.

Definition at line 58 of file SetUserPoolMfaConfigRequest.h.

SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetUserPoolId ( const Aws::String &  value )

inline

The user pool ID.

Definition at line 53 of file SetUserPoolMfaConfigRequest.h.

SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SetUserPoolId ( const char *  value )

inline

The user pool ID.

Definition at line 63 of file SetUserPoolMfaConfigRequest.h.

SmsMfaConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SmsMfaConfigurationHasBeenSet ( ) const

inline

The SMS text message MFA configuration.

Definition at line 89 of file SetUserPoolMfaConfigRequest.h.

SoftwareTokenMfaConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::SoftwareTokenMfaConfigurationHasBeenSet ( ) const

inline

The software token MFA configuration.

Definition at line 120 of file SetUserPoolMfaConfigRequest.h.

UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::UserPoolIdHasBeenSet ( ) const

inline

The user pool ID.

Definition at line 48 of file SetUserPoolMfaConfigRequest.h.

WithMfaConfiguration() [1/2]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithMfaConfiguration ( const UserPoolMfaType &  value )

inline

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

Definition at line 201 of file SetUserPoolMfaConfigRequest.h.

WithMfaConfiguration() [2/2]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithMfaConfiguration ( UserPoolMfaType &&  value )

inline

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

Definition at line 213 of file SetUserPoolMfaConfigRequest.h.

WithSmsMfaConfiguration() [1/2]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithSmsMfaConfiguration ( const SmsMfaConfigType &  value )

inline

The SMS text message MFA configuration.

Definition at line 104 of file SetUserPoolMfaConfigRequest.h.

WithSmsMfaConfiguration() [2/2]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithSmsMfaConfiguration ( SmsMfaConfigType &&  value )

inline

The SMS text message MFA configuration.

Definition at line 109 of file SetUserPoolMfaConfigRequest.h.

WithSoftwareTokenMfaConfiguration() [1/2]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithSoftwareTokenMfaConfiguration ( const SoftwareTokenMfaConfigType &  value )

inline

The software token MFA configuration.

Definition at line 135 of file SetUserPoolMfaConfigRequest.h.

WithSoftwareTokenMfaConfiguration() [2/2]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithSoftwareTokenMfaConfiguration ( SoftwareTokenMfaConfigType &&  value )

inline

The software token MFA configuration.

Definition at line 140 of file SetUserPoolMfaConfigRequest.h.

WithUserPoolId() [1/3]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithUserPoolId ( Aws::String &&  value )

inline

The user pool ID.

Definition at line 73 of file SetUserPoolMfaConfigRequest.h.

WithUserPoolId() [2/3]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithUserPoolId ( const Aws::String &  value )

inline

The user pool ID.

Definition at line 68 of file SetUserPoolMfaConfigRequest.h.

WithUserPoolId() [3/3]

SetUserPoolMfaConfigRequest& Aws::CognitoIdentityProvider::Model::SetUserPoolMfaConfigRequest::WithUserPoolId ( const char *  value )

inline

The user pool ID.

Definition at line 78 of file SetUserPoolMfaConfigRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-cognito-idp/include/aws/cognito-idp/model/SetUserPoolMfaConfigRequest.h