AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest Class Reference

#include <UpdateUserPoolRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest:

Public Member Functions

 UpdateUserPoolRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
UpdateUserPoolRequestWithUserPoolId (const Aws::String &value)
 
UpdateUserPoolRequestWithUserPoolId (Aws::String &&value)
 
UpdateUserPoolRequestWithUserPoolId (const char *value)
 
const UserPoolPolicyTypeGetPolicies () const
 
bool PoliciesHasBeenSet () const
 
void SetPolicies (const UserPoolPolicyType &value)
 
void SetPolicies (UserPoolPolicyType &&value)
 
UpdateUserPoolRequestWithPolicies (const UserPoolPolicyType &value)
 
UpdateUserPoolRequestWithPolicies (UserPoolPolicyType &&value)
 
const LambdaConfigTypeGetLambdaConfig () const
 
bool LambdaConfigHasBeenSet () const
 
void SetLambdaConfig (const LambdaConfigType &value)
 
void SetLambdaConfig (LambdaConfigType &&value)
 
UpdateUserPoolRequestWithLambdaConfig (const LambdaConfigType &value)
 
UpdateUserPoolRequestWithLambdaConfig (LambdaConfigType &&value)
 
const Aws::Vector< VerifiedAttributeType > & GetAutoVerifiedAttributes () const
 
bool AutoVerifiedAttributesHasBeenSet () const
 
void SetAutoVerifiedAttributes (const Aws::Vector< VerifiedAttributeType > &value)
 
void SetAutoVerifiedAttributes (Aws::Vector< VerifiedAttributeType > &&value)
 
UpdateUserPoolRequestWithAutoVerifiedAttributes (const Aws::Vector< VerifiedAttributeType > &value)
 
UpdateUserPoolRequestWithAutoVerifiedAttributes (Aws::Vector< VerifiedAttributeType > &&value)
 
UpdateUserPoolRequestAddAutoVerifiedAttributes (const VerifiedAttributeType &value)
 
UpdateUserPoolRequestAddAutoVerifiedAttributes (VerifiedAttributeType &&value)
 
const Aws::StringGetSmsVerificationMessage () const
 
bool SmsVerificationMessageHasBeenSet () const
 
void SetSmsVerificationMessage (const Aws::String &value)
 
void SetSmsVerificationMessage (Aws::String &&value)
 
void SetSmsVerificationMessage (const char *value)
 
UpdateUserPoolRequestWithSmsVerificationMessage (const Aws::String &value)
 
UpdateUserPoolRequestWithSmsVerificationMessage (Aws::String &&value)
 
UpdateUserPoolRequestWithSmsVerificationMessage (const char *value)
 
const Aws::StringGetEmailVerificationMessage () const
 
bool EmailVerificationMessageHasBeenSet () const
 
void SetEmailVerificationMessage (const Aws::String &value)
 
void SetEmailVerificationMessage (Aws::String &&value)
 
void SetEmailVerificationMessage (const char *value)
 
UpdateUserPoolRequestWithEmailVerificationMessage (const Aws::String &value)
 
UpdateUserPoolRequestWithEmailVerificationMessage (Aws::String &&value)
 
UpdateUserPoolRequestWithEmailVerificationMessage (const char *value)
 
const Aws::StringGetEmailVerificationSubject () const
 
bool EmailVerificationSubjectHasBeenSet () const
 
void SetEmailVerificationSubject (const Aws::String &value)
 
void SetEmailVerificationSubject (Aws::String &&value)
 
void SetEmailVerificationSubject (const char *value)
 
UpdateUserPoolRequestWithEmailVerificationSubject (const Aws::String &value)
 
UpdateUserPoolRequestWithEmailVerificationSubject (Aws::String &&value)
 
UpdateUserPoolRequestWithEmailVerificationSubject (const char *value)
 
const VerificationMessageTemplateTypeGetVerificationMessageTemplate () const
 
bool VerificationMessageTemplateHasBeenSet () const
 
void SetVerificationMessageTemplate (const VerificationMessageTemplateType &value)
 
void SetVerificationMessageTemplate (VerificationMessageTemplateType &&value)
 
UpdateUserPoolRequestWithVerificationMessageTemplate (const VerificationMessageTemplateType &value)
 
UpdateUserPoolRequestWithVerificationMessageTemplate (VerificationMessageTemplateType &&value)
 
const Aws::StringGetSmsAuthenticationMessage () const
 
bool SmsAuthenticationMessageHasBeenSet () const
 
void SetSmsAuthenticationMessage (const Aws::String &value)
 
void SetSmsAuthenticationMessage (Aws::String &&value)
 
void SetSmsAuthenticationMessage (const char *value)
 
UpdateUserPoolRequestWithSmsAuthenticationMessage (const Aws::String &value)
 
UpdateUserPoolRequestWithSmsAuthenticationMessage (Aws::String &&value)
 
UpdateUserPoolRequestWithSmsAuthenticationMessage (const char *value)
 
const UserPoolMfaTypeGetMfaConfiguration () const
 
bool MfaConfigurationHasBeenSet () const
 
void SetMfaConfiguration (const UserPoolMfaType &value)
 
void SetMfaConfiguration (UserPoolMfaType &&value)
 
UpdateUserPoolRequestWithMfaConfiguration (const UserPoolMfaType &value)
 
UpdateUserPoolRequestWithMfaConfiguration (UserPoolMfaType &&value)
 
const DeviceConfigurationTypeGetDeviceConfiguration () const
 
bool DeviceConfigurationHasBeenSet () const
 
void SetDeviceConfiguration (const DeviceConfigurationType &value)
 
void SetDeviceConfiguration (DeviceConfigurationType &&value)
 
UpdateUserPoolRequestWithDeviceConfiguration (const DeviceConfigurationType &value)
 
UpdateUserPoolRequestWithDeviceConfiguration (DeviceConfigurationType &&value)
 
const EmailConfigurationTypeGetEmailConfiguration () const
 
bool EmailConfigurationHasBeenSet () const
 
void SetEmailConfiguration (const EmailConfigurationType &value)
 
void SetEmailConfiguration (EmailConfigurationType &&value)
 
UpdateUserPoolRequestWithEmailConfiguration (const EmailConfigurationType &value)
 
UpdateUserPoolRequestWithEmailConfiguration (EmailConfigurationType &&value)
 
const SmsConfigurationTypeGetSmsConfiguration () const
 
bool SmsConfigurationHasBeenSet () const
 
void SetSmsConfiguration (const SmsConfigurationType &value)
 
void SetSmsConfiguration (SmsConfigurationType &&value)
 
UpdateUserPoolRequestWithSmsConfiguration (const SmsConfigurationType &value)
 
UpdateUserPoolRequestWithSmsConfiguration (SmsConfigurationType &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetUserPoolTags () const
 
bool UserPoolTagsHasBeenSet () const
 
void SetUserPoolTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetUserPoolTags (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateUserPoolRequestWithUserPoolTags (const Aws::Map< Aws::String, Aws::String > &value)
 
UpdateUserPoolRequestWithUserPoolTags (Aws::Map< Aws::String, Aws::String > &&value)
 
UpdateUserPoolRequestAddUserPoolTags (const Aws::String &key, const Aws::String &value)
 
UpdateUserPoolRequestAddUserPoolTags (Aws::String &&key, const Aws::String &value)
 
UpdateUserPoolRequestAddUserPoolTags (const Aws::String &key, Aws::String &&value)
 
UpdateUserPoolRequestAddUserPoolTags (Aws::String &&key, Aws::String &&value)
 
UpdateUserPoolRequestAddUserPoolTags (const char *key, Aws::String &&value)
 
UpdateUserPoolRequestAddUserPoolTags (Aws::String &&key, const char *value)
 
UpdateUserPoolRequestAddUserPoolTags (const char *key, const char *value)
 
const AdminCreateUserConfigTypeGetAdminCreateUserConfig () const
 
bool AdminCreateUserConfigHasBeenSet () const
 
void SetAdminCreateUserConfig (const AdminCreateUserConfigType &value)
 
void SetAdminCreateUserConfig (AdminCreateUserConfigType &&value)
 
UpdateUserPoolRequestWithAdminCreateUserConfig (const AdminCreateUserConfigType &value)
 
UpdateUserPoolRequestWithAdminCreateUserConfig (AdminCreateUserConfigType &&value)
 
const UserPoolAddOnsTypeGetUserPoolAddOns () const
 
bool UserPoolAddOnsHasBeenSet () const
 
void SetUserPoolAddOns (const UserPoolAddOnsType &value)
 
void SetUserPoolAddOns (UserPoolAddOnsType &&value)
 
UpdateUserPoolRequestWithUserPoolAddOns (const UserPoolAddOnsType &value)
 
UpdateUserPoolRequestWithUserPoolAddOns (UserPoolAddOnsType &&value)
 
const AccountRecoverySettingTypeGetAccountRecoverySetting () const
 
bool AccountRecoverySettingHasBeenSet () const
 
void SetAccountRecoverySetting (const AccountRecoverySettingType &value)
 
void SetAccountRecoverySetting (AccountRecoverySettingType &&value)
 
UpdateUserPoolRequestWithAccountRecoverySetting (const AccountRecoverySettingType &value)
 
UpdateUserPoolRequestWithAccountRecoverySetting (AccountRecoverySettingType &&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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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

Represents the request to update the user pool.

See Also:

AWS API Reference

Definition at line 37 of file UpdateUserPoolRequest.h.

Constructor & Destructor Documentation

◆ UpdateUserPoolRequest()

Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::UpdateUserPoolRequest ( )

Member Function Documentation

◆ AccountRecoverySettingHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AccountRecoverySettingHasBeenSet ( ) const
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 758 of file UpdateUserPoolRequest.h.

◆ AddAutoVerifiedAttributes() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddAutoVerifiedAttributes ( const VerifiedAttributeType value)
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 202 of file UpdateUserPoolRequest.h.

◆ AddAutoVerifiedAttributes() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddAutoVerifiedAttributes ( VerifiedAttributeType &&  value)
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 208 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [1/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 646 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [2/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 632 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [3/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( Aws::String &&  key,
const char *  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 660 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [4/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 639 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [5/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( const Aws::String key,
const Aws::String value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 625 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [6/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( const char *  key,
Aws::String &&  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 653 of file UpdateUserPoolRequest.h.

◆ AddUserPoolTags() [7/7]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AddUserPoolTags ( const char *  key,
const char *  value 
)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 667 of file UpdateUserPoolRequest.h.

◆ AdminCreateUserConfigHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AdminCreateUserConfigHasBeenSet ( ) const
inline

The configuration for AdminCreateUser requests.

Definition at line 678 of file UpdateUserPoolRequest.h.

◆ AutoVerifiedAttributesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::AutoVerifiedAttributesHasBeenSet ( ) const
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 172 of file UpdateUserPoolRequest.h.

◆ DeviceConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::DeviceConfigurationHasBeenSet ( ) const
inline

Device configuration.

Definition at line 493 of file UpdateUserPoolRequest.h.

◆ EmailConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::EmailConfigurationHasBeenSet ( ) const
inline

Email configuration.

Definition at line 524 of file UpdateUserPoolRequest.h.

◆ EmailVerificationMessageHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::EmailVerificationMessageHasBeenSet ( ) const
inline

The contents of the email verification message.

Definition at line 260 of file UpdateUserPoolRequest.h.

◆ EmailVerificationSubjectHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::EmailVerificationSubjectHasBeenSet ( ) const
inline

The subject of the email verification message.

Definition at line 301 of file UpdateUserPoolRequest.h.

◆ GetAccountRecoverySetting()

const AccountRecoverySettingType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetAccountRecoverySetting ( ) const
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 747 of file UpdateUserPoolRequest.h.

◆ GetAdminCreateUserConfig()

const AdminCreateUserConfigType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetAdminCreateUserConfig ( ) const
inline

The configuration for AdminCreateUser requests.

Definition at line 673 of file UpdateUserPoolRequest.h.

◆ GetAutoVerifiedAttributes()

const Aws::Vector<VerifiedAttributeType>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetAutoVerifiedAttributes ( ) const
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 166 of file UpdateUserPoolRequest.h.

◆ GetDeviceConfiguration()

const DeviceConfigurationType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetDeviceConfiguration ( ) const
inline

Device configuration.

Definition at line 488 of file UpdateUserPoolRequest.h.

◆ GetEmailConfiguration()

const EmailConfigurationType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetEmailConfiguration ( ) const
inline

Email configuration.

Definition at line 519 of file UpdateUserPoolRequest.h.

◆ GetEmailVerificationMessage()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetEmailVerificationMessage ( ) const
inline

The contents of the email verification message.

Definition at line 255 of file UpdateUserPoolRequest.h.

◆ GetEmailVerificationSubject()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetEmailVerificationSubject ( ) const
inline

The subject of the email verification message.

Definition at line 296 of file UpdateUserPoolRequest.h.

◆ GetLambdaConfig()

const LambdaConfigType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetLambdaConfig ( ) const
inline

The AWS Lambda configuration information from the request to update the user pool.

Definition at line 129 of file UpdateUserPoolRequest.h.

◆ GetMfaConfiguration()

const UserPoolMfaType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetMfaConfiguration ( ) const
inline

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Definition at line 417 of file UpdateUserPoolRequest.h.

◆ GetPolicies()

const UserPoolPolicyType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetPolicies ( ) const
inline

A container with the policies you wish to update in a user pool.

Definition at line 97 of file UpdateUserPoolRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 46 of file UpdateUserPoolRequest.h.

◆ GetSmsAuthenticationMessage()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetSmsAuthenticationMessage ( ) const
inline

The contents of the SMS authentication message.

Definition at line 368 of file UpdateUserPoolRequest.h.

◆ GetSmsConfiguration()

const SmsConfigurationType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetSmsConfiguration ( ) const
inline

SMS configuration.

Definition at line 550 of file UpdateUserPoolRequest.h.

◆ GetSmsVerificationMessage()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetSmsVerificationMessage ( ) const
inline

A container with information about the SMS verification message.

Definition at line 214 of file UpdateUserPoolRequest.h.

◆ GetUserPoolAddOns()

const UserPoolAddOnsType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetUserPoolAddOns ( ) const
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 705 of file UpdateUserPoolRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool you want to update.

Definition at line 56 of file UpdateUserPoolRequest.h.

◆ GetUserPoolTags()

const Aws::Map<Aws::String, Aws::String>& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetUserPoolTags ( ) const
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 583 of file UpdateUserPoolRequest.h.

◆ GetVerificationMessageTemplate()

const VerificationMessageTemplateType& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::GetVerificationMessageTemplate ( ) const
inline

The template for verification messages.

Definition at line 337 of file UpdateUserPoolRequest.h.

◆ LambdaConfigHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::LambdaConfigHasBeenSet ( ) const
inline

The AWS Lambda configuration information from the request to update the user pool.

Definition at line 135 of file UpdateUserPoolRequest.h.

◆ MfaConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::MfaConfigurationHasBeenSet ( ) const
inline

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Definition at line 430 of file UpdateUserPoolRequest.h.

◆ PoliciesHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::PoliciesHasBeenSet ( ) const
inline

A container with the policies you wish to update in a user pool.

Definition at line 102 of file UpdateUserPoolRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAccountRecoverySetting() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetAccountRecoverySetting ( AccountRecoverySettingType &&  value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 780 of file UpdateUserPoolRequest.h.

◆ SetAccountRecoverySetting() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetAccountRecoverySetting ( const AccountRecoverySettingType value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 769 of file UpdateUserPoolRequest.h.

◆ SetAdminCreateUserConfig() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetAdminCreateUserConfig ( AdminCreateUserConfigType &&  value)
inline

The configuration for AdminCreateUser requests.

Definition at line 688 of file UpdateUserPoolRequest.h.

◆ SetAdminCreateUserConfig() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetAdminCreateUserConfig ( const AdminCreateUserConfigType value)
inline

The configuration for AdminCreateUser requests.

Definition at line 683 of file UpdateUserPoolRequest.h.

◆ SetAutoVerifiedAttributes() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetAutoVerifiedAttributes ( Aws::Vector< VerifiedAttributeType > &&  value)
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 184 of file UpdateUserPoolRequest.h.

◆ SetAutoVerifiedAttributes() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetAutoVerifiedAttributes ( const Aws::Vector< VerifiedAttributeType > &  value)
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 178 of file UpdateUserPoolRequest.h.

◆ SetDeviceConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetDeviceConfiguration ( const DeviceConfigurationType value)
inline

Device configuration.

Definition at line 498 of file UpdateUserPoolRequest.h.

◆ SetDeviceConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetDeviceConfiguration ( DeviceConfigurationType &&  value)
inline

Device configuration.

Definition at line 503 of file UpdateUserPoolRequest.h.

◆ SetEmailConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailConfiguration ( const EmailConfigurationType value)
inline

Email configuration.

Definition at line 529 of file UpdateUserPoolRequest.h.

◆ SetEmailConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailConfiguration ( EmailConfigurationType &&  value)
inline

Email configuration.

Definition at line 534 of file UpdateUserPoolRequest.h.

◆ SetEmailVerificationMessage() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailVerificationMessage ( Aws::String &&  value)
inline

The contents of the email verification message.

Definition at line 270 of file UpdateUserPoolRequest.h.

◆ SetEmailVerificationMessage() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailVerificationMessage ( const Aws::String value)
inline

The contents of the email verification message.

Definition at line 265 of file UpdateUserPoolRequest.h.

◆ SetEmailVerificationMessage() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailVerificationMessage ( const char *  value)
inline

The contents of the email verification message.

Definition at line 275 of file UpdateUserPoolRequest.h.

◆ SetEmailVerificationSubject() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailVerificationSubject ( Aws::String &&  value)
inline

The subject of the email verification message.

Definition at line 311 of file UpdateUserPoolRequest.h.

◆ SetEmailVerificationSubject() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailVerificationSubject ( const Aws::String value)
inline

The subject of the email verification message.

Definition at line 306 of file UpdateUserPoolRequest.h.

◆ SetEmailVerificationSubject() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetEmailVerificationSubject ( const char *  value)
inline

The subject of the email verification message.

Definition at line 316 of file UpdateUserPoolRequest.h.

◆ SetLambdaConfig() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetLambdaConfig ( const LambdaConfigType value)
inline

The AWS Lambda configuration information from the request to update the user pool.

Definition at line 141 of file UpdateUserPoolRequest.h.

◆ SetLambdaConfig() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetLambdaConfig ( LambdaConfigType &&  value)
inline

The AWS Lambda configuration information from the request to update the user pool.

Definition at line 147 of file UpdateUserPoolRequest.h.

◆ SetMfaConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetMfaConfiguration ( const UserPoolMfaType value)
inline

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Definition at line 443 of file UpdateUserPoolRequest.h.

◆ SetMfaConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetMfaConfiguration ( UserPoolMfaType &&  value)
inline

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Definition at line 456 of file UpdateUserPoolRequest.h.

◆ SetPolicies() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetPolicies ( const UserPoolPolicyType value)
inline

A container with the policies you wish to update in a user pool.

Definition at line 107 of file UpdateUserPoolRequest.h.

◆ SetPolicies() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetPolicies ( UserPoolPolicyType &&  value)
inline

A container with the policies you wish to update in a user pool.

Definition at line 112 of file UpdateUserPoolRequest.h.

◆ SetSmsAuthenticationMessage() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsAuthenticationMessage ( Aws::String &&  value)
inline

The contents of the SMS authentication message.

Definition at line 383 of file UpdateUserPoolRequest.h.

◆ SetSmsAuthenticationMessage() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsAuthenticationMessage ( const Aws::String value)
inline

The contents of the SMS authentication message.

Definition at line 378 of file UpdateUserPoolRequest.h.

◆ SetSmsAuthenticationMessage() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsAuthenticationMessage ( const char *  value)
inline

The contents of the SMS authentication message.

Definition at line 388 of file UpdateUserPoolRequest.h.

◆ SetSmsConfiguration() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsConfiguration ( const SmsConfigurationType value)
inline

SMS configuration.

Definition at line 560 of file UpdateUserPoolRequest.h.

◆ SetSmsConfiguration() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsConfiguration ( SmsConfigurationType &&  value)
inline

SMS configuration.

Definition at line 565 of file UpdateUserPoolRequest.h.

◆ SetSmsVerificationMessage() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsVerificationMessage ( Aws::String &&  value)
inline

A container with information about the SMS verification message.

Definition at line 229 of file UpdateUserPoolRequest.h.

◆ SetSmsVerificationMessage() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsVerificationMessage ( const Aws::String value)
inline

A container with information about the SMS verification message.

Definition at line 224 of file UpdateUserPoolRequest.h.

◆ SetSmsVerificationMessage() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetSmsVerificationMessage ( const char *  value)
inline

A container with information about the SMS verification message.

Definition at line 234 of file UpdateUserPoolRequest.h.

◆ SetUserPoolAddOns() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetUserPoolAddOns ( const UserPoolAddOnsType value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 717 of file UpdateUserPoolRequest.h.

◆ SetUserPoolAddOns() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetUserPoolAddOns ( UserPoolAddOnsType &&  value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 723 of file UpdateUserPoolRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool you want to update.

Definition at line 71 of file UpdateUserPoolRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool you want to update.

Definition at line 66 of file UpdateUserPoolRequest.h.

◆ SetUserPoolId() [3/3]

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

The user pool ID for the user pool you want to update.

Definition at line 76 of file UpdateUserPoolRequest.h.

◆ SetUserPoolTags() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetUserPoolTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 604 of file UpdateUserPoolRequest.h.

◆ SetUserPoolTags() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetUserPoolTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 597 of file UpdateUserPoolRequest.h.

◆ SetVerificationMessageTemplate() [1/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetVerificationMessageTemplate ( const VerificationMessageTemplateType value)
inline

The template for verification messages.

Definition at line 347 of file UpdateUserPoolRequest.h.

◆ SetVerificationMessageTemplate() [2/2]

void Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SetVerificationMessageTemplate ( VerificationMessageTemplateType &&  value)
inline

The template for verification messages.

Definition at line 352 of file UpdateUserPoolRequest.h.

◆ SmsAuthenticationMessageHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SmsAuthenticationMessageHasBeenSet ( ) const
inline

The contents of the SMS authentication message.

Definition at line 373 of file UpdateUserPoolRequest.h.

◆ SmsConfigurationHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SmsConfigurationHasBeenSet ( ) const
inline

SMS configuration.

Definition at line 555 of file UpdateUserPoolRequest.h.

◆ SmsVerificationMessageHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::SmsVerificationMessageHasBeenSet ( ) const
inline

A container with information about the SMS verification message.

Definition at line 219 of file UpdateUserPoolRequest.h.

◆ UserPoolAddOnsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::UserPoolAddOnsHasBeenSet ( ) const
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 711 of file UpdateUserPoolRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool you want to update.

Definition at line 61 of file UpdateUserPoolRequest.h.

◆ UserPoolTagsHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::UserPoolTagsHasBeenSet ( ) const
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 590 of file UpdateUserPoolRequest.h.

◆ VerificationMessageTemplateHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::VerificationMessageTemplateHasBeenSet ( ) const
inline

The template for verification messages.

Definition at line 342 of file UpdateUserPoolRequest.h.

◆ WithAccountRecoverySetting() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithAccountRecoverySetting ( AccountRecoverySettingType &&  value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 802 of file UpdateUserPoolRequest.h.

◆ WithAccountRecoverySetting() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithAccountRecoverySetting ( const AccountRecoverySettingType value)
inline

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Definition at line 791 of file UpdateUserPoolRequest.h.

◆ WithAdminCreateUserConfig() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithAdminCreateUserConfig ( AdminCreateUserConfigType &&  value)
inline

The configuration for AdminCreateUser requests.

Definition at line 698 of file UpdateUserPoolRequest.h.

◆ WithAdminCreateUserConfig() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithAdminCreateUserConfig ( const AdminCreateUserConfigType value)
inline

The configuration for AdminCreateUser requests.

Definition at line 693 of file UpdateUserPoolRequest.h.

◆ WithAutoVerifiedAttributes() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithAutoVerifiedAttributes ( Aws::Vector< VerifiedAttributeType > &&  value)
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 196 of file UpdateUserPoolRequest.h.

◆ WithAutoVerifiedAttributes() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithAutoVerifiedAttributes ( const Aws::Vector< VerifiedAttributeType > &  value)
inline

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

Definition at line 190 of file UpdateUserPoolRequest.h.

◆ WithDeviceConfiguration() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithDeviceConfiguration ( const DeviceConfigurationType value)
inline

Device configuration.

Definition at line 508 of file UpdateUserPoolRequest.h.

◆ WithDeviceConfiguration() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithDeviceConfiguration ( DeviceConfigurationType &&  value)
inline

Device configuration.

Definition at line 513 of file UpdateUserPoolRequest.h.

◆ WithEmailConfiguration() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailConfiguration ( const EmailConfigurationType value)
inline

Email configuration.

Definition at line 539 of file UpdateUserPoolRequest.h.

◆ WithEmailConfiguration() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailConfiguration ( EmailConfigurationType &&  value)
inline

Email configuration.

Definition at line 544 of file UpdateUserPoolRequest.h.

◆ WithEmailVerificationMessage() [1/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailVerificationMessage ( Aws::String &&  value)
inline

The contents of the email verification message.

Definition at line 285 of file UpdateUserPoolRequest.h.

◆ WithEmailVerificationMessage() [2/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailVerificationMessage ( const Aws::String value)
inline

The contents of the email verification message.

Definition at line 280 of file UpdateUserPoolRequest.h.

◆ WithEmailVerificationMessage() [3/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailVerificationMessage ( const char *  value)
inline

The contents of the email verification message.

Definition at line 290 of file UpdateUserPoolRequest.h.

◆ WithEmailVerificationSubject() [1/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailVerificationSubject ( Aws::String &&  value)
inline

The subject of the email verification message.

Definition at line 326 of file UpdateUserPoolRequest.h.

◆ WithEmailVerificationSubject() [2/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailVerificationSubject ( const Aws::String value)
inline

The subject of the email verification message.

Definition at line 321 of file UpdateUserPoolRequest.h.

◆ WithEmailVerificationSubject() [3/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithEmailVerificationSubject ( const char *  value)
inline

The subject of the email verification message.

Definition at line 331 of file UpdateUserPoolRequest.h.

◆ WithLambdaConfig() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithLambdaConfig ( const LambdaConfigType value)
inline

The AWS Lambda configuration information from the request to update the user pool.

Definition at line 153 of file UpdateUserPoolRequest.h.

◆ WithLambdaConfig() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithLambdaConfig ( LambdaConfigType &&  value)
inline

The AWS Lambda configuration information from the request to update the user pool.

Definition at line 159 of file UpdateUserPoolRequest.h.

◆ WithMfaConfiguration() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithMfaConfiguration ( const UserPoolMfaType value)
inline

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Definition at line 469 of file UpdateUserPoolRequest.h.

◆ WithMfaConfiguration() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithMfaConfiguration ( UserPoolMfaType &&  value)
inline

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

  • OPTIONAL - Users have the option when registering to create an MFA token.

Definition at line 482 of file UpdateUserPoolRequest.h.

◆ WithPolicies() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithPolicies ( const UserPoolPolicyType value)
inline

A container with the policies you wish to update in a user pool.

Definition at line 117 of file UpdateUserPoolRequest.h.

◆ WithPolicies() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithPolicies ( UserPoolPolicyType &&  value)
inline

A container with the policies you wish to update in a user pool.

Definition at line 122 of file UpdateUserPoolRequest.h.

◆ WithSmsAuthenticationMessage() [1/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsAuthenticationMessage ( Aws::String &&  value)
inline

The contents of the SMS authentication message.

Definition at line 398 of file UpdateUserPoolRequest.h.

◆ WithSmsAuthenticationMessage() [2/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsAuthenticationMessage ( const Aws::String value)
inline

The contents of the SMS authentication message.

Definition at line 393 of file UpdateUserPoolRequest.h.

◆ WithSmsAuthenticationMessage() [3/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsAuthenticationMessage ( const char *  value)
inline

The contents of the SMS authentication message.

Definition at line 403 of file UpdateUserPoolRequest.h.

◆ WithSmsConfiguration() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsConfiguration ( const SmsConfigurationType value)
inline

SMS configuration.

Definition at line 570 of file UpdateUserPoolRequest.h.

◆ WithSmsConfiguration() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsConfiguration ( SmsConfigurationType &&  value)
inline

SMS configuration.

Definition at line 575 of file UpdateUserPoolRequest.h.

◆ WithSmsVerificationMessage() [1/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsVerificationMessage ( Aws::String &&  value)
inline

A container with information about the SMS verification message.

Definition at line 244 of file UpdateUserPoolRequest.h.

◆ WithSmsVerificationMessage() [2/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsVerificationMessage ( const Aws::String value)
inline

A container with information about the SMS verification message.

Definition at line 239 of file UpdateUserPoolRequest.h.

◆ WithSmsVerificationMessage() [3/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithSmsVerificationMessage ( const char *  value)
inline

A container with information about the SMS verification message.

Definition at line 249 of file UpdateUserPoolRequest.h.

◆ WithUserPoolAddOns() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithUserPoolAddOns ( const UserPoolAddOnsType value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 729 of file UpdateUserPoolRequest.h.

◆ WithUserPoolAddOns() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithUserPoolAddOns ( UserPoolAddOnsType &&  value)
inline

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Definition at line 735 of file UpdateUserPoolRequest.h.

◆ WithUserPoolId() [1/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool you want to update.

Definition at line 86 of file UpdateUserPoolRequest.h.

◆ WithUserPoolId() [2/3]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool you want to update.

Definition at line 81 of file UpdateUserPoolRequest.h.

◆ WithUserPoolId() [3/3]

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

The user pool ID for the user pool you want to update.

Definition at line 91 of file UpdateUserPoolRequest.h.

◆ WithUserPoolTags() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithUserPoolTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 618 of file UpdateUserPoolRequest.h.

◆ WithUserPoolTags() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithUserPoolTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Definition at line 611 of file UpdateUserPoolRequest.h.

◆ WithVerificationMessageTemplate() [1/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithVerificationMessageTemplate ( const VerificationMessageTemplateType value)
inline

The template for verification messages.

Definition at line 357 of file UpdateUserPoolRequest.h.

◆ WithVerificationMessageTemplate() [2/2]

UpdateUserPoolRequest& Aws::CognitoIdentityProvider::Model::UpdateUserPoolRequest::WithVerificationMessageTemplate ( VerificationMessageTemplateType &&  value)
inline

The template for verification messages.

Definition at line 362 of file UpdateUserPoolRequest.h.


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