/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the request to update the user pool.See Also:
AWS
* API Reference
The user pool ID for the user pool you want to update.
*/ inline const Aws::String& GetUserPoolId() const{ return m_userPoolId; } /** *The user pool ID for the user pool you want to update.
*/ inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; } /** *The user pool ID for the user pool you want to update.
*/ inline void SetUserPoolId(const Aws::String& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = value; } /** *The user pool ID for the user pool you want to update.
*/ inline void SetUserPoolId(Aws::String&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::move(value); } /** *The user pool ID for the user pool you want to update.
*/ inline void SetUserPoolId(const char* value) { m_userPoolIdHasBeenSet = true; m_userPoolId.assign(value); } /** *The user pool ID for the user pool you want to update.
*/ inline UpdateUserPoolRequest& WithUserPoolId(const Aws::String& value) { SetUserPoolId(value); return *this;} /** *The user pool ID for the user pool you want to update.
*/ inline UpdateUserPoolRequest& WithUserPoolId(Aws::String&& value) { SetUserPoolId(std::move(value)); return *this;} /** *The user pool ID for the user pool you want to update.
*/ inline UpdateUserPoolRequest& WithUserPoolId(const char* value) { SetUserPoolId(value); return *this;} /** *A container with the policies you wish to update in a user pool.
*/ inline const UserPoolPolicyType& GetPolicies() const{ return m_policies; } /** *A container with the policies you wish to update in a user pool.
*/ inline bool PoliciesHasBeenSet() const { return m_policiesHasBeenSet; } /** *A container with the policies you wish to update in a user pool.
*/ inline void SetPolicies(const UserPoolPolicyType& value) { m_policiesHasBeenSet = true; m_policies = value; } /** *A container with the policies you wish to update in a user pool.
*/ inline void SetPolicies(UserPoolPolicyType&& value) { m_policiesHasBeenSet = true; m_policies = std::move(value); } /** *A container with the policies you wish to update in a user pool.
*/ inline UpdateUserPoolRequest& WithPolicies(const UserPoolPolicyType& value) { SetPolicies(value); return *this;} /** *A container with the policies you wish to update in a user pool.
*/ inline UpdateUserPoolRequest& WithPolicies(UserPoolPolicyType&& value) { SetPolicies(std::move(value)); return *this;} /** *The AWS Lambda configuration information from the request to update the user * pool.
*/ inline const LambdaConfigType& GetLambdaConfig() const{ return m_lambdaConfig; } /** *The AWS Lambda configuration information from the request to update the user * pool.
*/ inline bool LambdaConfigHasBeenSet() const { return m_lambdaConfigHasBeenSet; } /** *The AWS Lambda configuration information from the request to update the user * pool.
*/ inline void SetLambdaConfig(const LambdaConfigType& value) { m_lambdaConfigHasBeenSet = true; m_lambdaConfig = value; } /** *The AWS Lambda configuration information from the request to update the user * pool.
*/ inline void SetLambdaConfig(LambdaConfigType&& value) { m_lambdaConfigHasBeenSet = true; m_lambdaConfig = std::move(value); } /** *The AWS Lambda configuration information from the request to update the user * pool.
*/ inline UpdateUserPoolRequest& WithLambdaConfig(const LambdaConfigType& value) { SetLambdaConfig(value); return *this;} /** *The AWS Lambda configuration information from the request to update the user * pool.
*/ inline UpdateUserPoolRequest& WithLambdaConfig(LambdaConfigType&& value) { SetLambdaConfig(std::move(value)); return *this;} /** *The attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline const Aws::VectorThe attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline bool AutoVerifiedAttributesHasBeenSet() const { return m_autoVerifiedAttributesHasBeenSet; } /** *The attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline void SetAutoVerifiedAttributes(const Aws::VectorThe attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline void SetAutoVerifiedAttributes(Aws::VectorThe attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline UpdateUserPoolRequest& WithAutoVerifiedAttributes(const Aws::VectorThe attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline UpdateUserPoolRequest& WithAutoVerifiedAttributes(Aws::VectorThe attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline UpdateUserPoolRequest& AddAutoVerifiedAttributes(const VerifiedAttributeType& value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes.push_back(value); return *this; } /** *The attributes that are automatically verified when the Amazon Cognito * service makes a request to update user pools.
*/ inline UpdateUserPoolRequest& AddAutoVerifiedAttributes(VerifiedAttributeType&& value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes.push_back(std::move(value)); return *this; } /** *A container with information about the SMS verification message.
*/ inline const Aws::String& GetSmsVerificationMessage() const{ return m_smsVerificationMessage; } /** *A container with information about the SMS verification message.
*/ inline bool SmsVerificationMessageHasBeenSet() const { return m_smsVerificationMessageHasBeenSet; } /** *A container with information about the SMS verification message.
*/ inline void SetSmsVerificationMessage(const Aws::String& value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage = value; } /** *A container with information about the SMS verification message.
*/ inline void SetSmsVerificationMessage(Aws::String&& value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage = std::move(value); } /** *A container with information about the SMS verification message.
*/ inline void SetSmsVerificationMessage(const char* value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage.assign(value); } /** *A container with information about the SMS verification message.
*/ inline UpdateUserPoolRequest& WithSmsVerificationMessage(const Aws::String& value) { SetSmsVerificationMessage(value); return *this;} /** *A container with information about the SMS verification message.
*/ inline UpdateUserPoolRequest& WithSmsVerificationMessage(Aws::String&& value) { SetSmsVerificationMessage(std::move(value)); return *this;} /** *A container with information about the SMS verification message.
*/ inline UpdateUserPoolRequest& WithSmsVerificationMessage(const char* value) { SetSmsVerificationMessage(value); return *this;} /** *The contents of the email verification message.
*/ inline const Aws::String& GetEmailVerificationMessage() const{ return m_emailVerificationMessage; } /** *The contents of the email verification message.
*/ inline bool EmailVerificationMessageHasBeenSet() const { return m_emailVerificationMessageHasBeenSet; } /** *The contents of the email verification message.
*/ inline void SetEmailVerificationMessage(const Aws::String& value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage = value; } /** *The contents of the email verification message.
*/ inline void SetEmailVerificationMessage(Aws::String&& value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage = std::move(value); } /** *The contents of the email verification message.
*/ inline void SetEmailVerificationMessage(const char* value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage.assign(value); } /** *The contents of the email verification message.
*/ inline UpdateUserPoolRequest& WithEmailVerificationMessage(const Aws::String& value) { SetEmailVerificationMessage(value); return *this;} /** *The contents of the email verification message.
*/ inline UpdateUserPoolRequest& WithEmailVerificationMessage(Aws::String&& value) { SetEmailVerificationMessage(std::move(value)); return *this;} /** *The contents of the email verification message.
*/ inline UpdateUserPoolRequest& WithEmailVerificationMessage(const char* value) { SetEmailVerificationMessage(value); return *this;} /** *The subject of the email verification message.
*/ inline const Aws::String& GetEmailVerificationSubject() const{ return m_emailVerificationSubject; } /** *The subject of the email verification message.
*/ inline bool EmailVerificationSubjectHasBeenSet() const { return m_emailVerificationSubjectHasBeenSet; } /** *The subject of the email verification message.
*/ inline void SetEmailVerificationSubject(const Aws::String& value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject = value; } /** *The subject of the email verification message.
*/ inline void SetEmailVerificationSubject(Aws::String&& value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject = std::move(value); } /** *The subject of the email verification message.
*/ inline void SetEmailVerificationSubject(const char* value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject.assign(value); } /** *The subject of the email verification message.
*/ inline UpdateUserPoolRequest& WithEmailVerificationSubject(const Aws::String& value) { SetEmailVerificationSubject(value); return *this;} /** *The subject of the email verification message.
*/ inline UpdateUserPoolRequest& WithEmailVerificationSubject(Aws::String&& value) { SetEmailVerificationSubject(std::move(value)); return *this;} /** *The subject of the email verification message.
*/ inline UpdateUserPoolRequest& WithEmailVerificationSubject(const char* value) { SetEmailVerificationSubject(value); return *this;} /** *The template for verification messages.
*/ inline const VerificationMessageTemplateType& GetVerificationMessageTemplate() const{ return m_verificationMessageTemplate; } /** *The template for verification messages.
*/ inline bool VerificationMessageTemplateHasBeenSet() const { return m_verificationMessageTemplateHasBeenSet; } /** *The template for verification messages.
*/ inline void SetVerificationMessageTemplate(const VerificationMessageTemplateType& value) { m_verificationMessageTemplateHasBeenSet = true; m_verificationMessageTemplate = value; } /** *The template for verification messages.
*/ inline void SetVerificationMessageTemplate(VerificationMessageTemplateType&& value) { m_verificationMessageTemplateHasBeenSet = true; m_verificationMessageTemplate = std::move(value); } /** *The template for verification messages.
*/ inline UpdateUserPoolRequest& WithVerificationMessageTemplate(const VerificationMessageTemplateType& value) { SetVerificationMessageTemplate(value); return *this;} /** *The template for verification messages.
*/ inline UpdateUserPoolRequest& WithVerificationMessageTemplate(VerificationMessageTemplateType&& value) { SetVerificationMessageTemplate(std::move(value)); return *this;} /** *The contents of the SMS authentication message.
*/ inline const Aws::String& GetSmsAuthenticationMessage() const{ return m_smsAuthenticationMessage; } /** *The contents of the SMS authentication message.
*/ inline bool SmsAuthenticationMessageHasBeenSet() const { return m_smsAuthenticationMessageHasBeenSet; } /** *The contents of the SMS authentication message.
*/ inline void SetSmsAuthenticationMessage(const Aws::String& value) { m_smsAuthenticationMessageHasBeenSet = true; m_smsAuthenticationMessage = value; } /** *The contents of the SMS authentication message.
*/ inline void SetSmsAuthenticationMessage(Aws::String&& value) { m_smsAuthenticationMessageHasBeenSet = true; m_smsAuthenticationMessage = std::move(value); } /** *The contents of the SMS authentication message.
*/ inline void SetSmsAuthenticationMessage(const char* value) { m_smsAuthenticationMessageHasBeenSet = true; m_smsAuthenticationMessage.assign(value); } /** *The contents of the SMS authentication message.
*/ inline UpdateUserPoolRequest& WithSmsAuthenticationMessage(const Aws::String& value) { SetSmsAuthenticationMessage(value); return *this;} /** *The contents of the SMS authentication message.
*/ inline UpdateUserPoolRequest& WithSmsAuthenticationMessage(Aws::String&& value) { SetSmsAuthenticationMessage(std::move(value)); return *this;} /** *The contents of the SMS authentication message.
*/ inline UpdateUserPoolRequest& WithSmsAuthenticationMessage(const char* value) { SetSmsAuthenticationMessage(value); return *this;} /** *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 required when you are initially creating a
* user pool.
OPTIONAL - Users have the option when
* registering to create an MFA token.
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 required when you are initially creating a
* user pool.
OPTIONAL - Users have the option when
* registering to create an MFA token.
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 required when you are initially creating a
* user pool.
OPTIONAL - Users have the option when
* registering to create an MFA token.
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 required when you are initially creating a
* user pool.
OPTIONAL - Users have the option when
* registering to create an MFA token.
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 required when you are initially creating a
* user pool.
OPTIONAL - Users have the option when
* registering to create an MFA token.
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 required when you are initially creating a
* user pool.
OPTIONAL - Users have the option when
* registering to create an MFA token.
Device configuration.
*/ inline const DeviceConfigurationType& GetDeviceConfiguration() const{ return m_deviceConfiguration; } /** *Device configuration.
*/ inline bool DeviceConfigurationHasBeenSet() const { return m_deviceConfigurationHasBeenSet; } /** *Device configuration.
*/ inline void SetDeviceConfiguration(const DeviceConfigurationType& value) { m_deviceConfigurationHasBeenSet = true; m_deviceConfiguration = value; } /** *Device configuration.
*/ inline void SetDeviceConfiguration(DeviceConfigurationType&& value) { m_deviceConfigurationHasBeenSet = true; m_deviceConfiguration = std::move(value); } /** *Device configuration.
*/ inline UpdateUserPoolRequest& WithDeviceConfiguration(const DeviceConfigurationType& value) { SetDeviceConfiguration(value); return *this;} /** *Device configuration.
*/ inline UpdateUserPoolRequest& WithDeviceConfiguration(DeviceConfigurationType&& value) { SetDeviceConfiguration(std::move(value)); return *this;} /** *Email configuration.
*/ inline const EmailConfigurationType& GetEmailConfiguration() const{ return m_emailConfiguration; } /** *Email configuration.
*/ inline bool EmailConfigurationHasBeenSet() const { return m_emailConfigurationHasBeenSet; } /** *Email configuration.
*/ inline void SetEmailConfiguration(const EmailConfigurationType& value) { m_emailConfigurationHasBeenSet = true; m_emailConfiguration = value; } /** *Email configuration.
*/ inline void SetEmailConfiguration(EmailConfigurationType&& value) { m_emailConfigurationHasBeenSet = true; m_emailConfiguration = std::move(value); } /** *Email configuration.
*/ inline UpdateUserPoolRequest& WithEmailConfiguration(const EmailConfigurationType& value) { SetEmailConfiguration(value); return *this;} /** *Email configuration.
*/ inline UpdateUserPoolRequest& WithEmailConfiguration(EmailConfigurationType&& value) { SetEmailConfiguration(std::move(value)); return *this;} /** *SMS configuration.
*/ inline const SmsConfigurationType& GetSmsConfiguration() const{ return m_smsConfiguration; } /** *SMS configuration.
*/ inline bool SmsConfigurationHasBeenSet() const { return m_smsConfigurationHasBeenSet; } /** *SMS configuration.
*/ inline void SetSmsConfiguration(const SmsConfigurationType& value) { m_smsConfigurationHasBeenSet = true; m_smsConfiguration = value; } /** *SMS configuration.
*/ inline void SetSmsConfiguration(SmsConfigurationType&& value) { m_smsConfigurationHasBeenSet = true; m_smsConfiguration = std::move(value); } /** *SMS configuration.
*/ inline UpdateUserPoolRequest& WithSmsConfiguration(const SmsConfigurationType& value) { SetSmsConfiguration(value); return *this;} /** *SMS configuration.
*/ inline UpdateUserPoolRequest& WithSmsConfiguration(SmsConfigurationType&& value) { SetSmsConfiguration(std::move(value)); return *this;} /** *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.
*/ inline const Aws::MapThe 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.
*/ inline bool UserPoolTagsHasBeenSet() const { return m_userPoolTagsHasBeenSet; } /** *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.
*/ inline void SetUserPoolTags(const Aws::MapThe 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.
*/ inline void SetUserPoolTags(Aws::MapThe 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.
*/ inline UpdateUserPoolRequest& WithUserPoolTags(const Aws::MapThe 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.
*/ inline UpdateUserPoolRequest& WithUserPoolTags(Aws::MapThe 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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(const Aws::String& key, const Aws::String& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, value); return *this; } /** *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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(Aws::String&& key, const Aws::String& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::move(key), value); return *this; } /** *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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(const Aws::String& key, Aws::String&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(Aws::String&& key, Aws::String&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::move(key), std::move(value)); return *this; } /** *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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(const char* key, Aws::String&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, std::move(value)); return *this; } /** *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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(Aws::String&& key, const char* value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::move(key), value); return *this; } /** *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.
*/ inline UpdateUserPoolRequest& AddUserPoolTags(const char* key, const char* value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, value); return *this; } /** *The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
The configuration for AdminCreateUser requests.
Used to enable advanced security risk detection. Set the key
* AdvancedSecurityMode to the value "AUDIT".
Used to enable advanced security risk detection. Set the key
* AdvancedSecurityMode to the value "AUDIT".
Used to enable advanced security risk detection. Set the key
* AdvancedSecurityMode to the value "AUDIT".
Used to enable advanced security risk detection. Set the key
* AdvancedSecurityMode to the value "AUDIT".
Used to enable advanced security risk detection. Set the key
* AdvancedSecurityMode to the value "AUDIT".
Used to enable advanced security risk detection. Set the key
* AdvancedSecurityMode to the value "AUDIT".
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.
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.
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.
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.
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.
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.