/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace CognitoIdentityProvider { namespace Model { /** *

Represents the request to update the user pool.

*/ class UpdateUserPoolRequest : public CognitoIdentityProviderRequest { public: AWS_COGNITOIDENTITYPROVIDER_API UpdateUserPoolRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateUserPool"; } AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override; AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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 want to update in a user pool.

*/ inline const UserPoolPolicyType& GetPolicies() const{ return m_policies; } /** *

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

*/ inline bool PoliciesHasBeenSet() const { return m_policiesHasBeenSet; } /** *

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

*/ inline void SetPolicies(const UserPoolPolicyType& value) { m_policiesHasBeenSet = true; m_policies = value; } /** *

A container with the policies you want 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 want to update in a user pool.

*/ inline UpdateUserPoolRequest& WithPolicies(const UserPoolPolicyType& value) { SetPolicies(value); return *this;} /** *

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

*/ inline UpdateUserPoolRequest& WithPolicies(UserPoolPolicyType&& value) { SetPolicies(std::move(value)); return *this;} /** *

When active, DeletionProtection prevents accidental deletion of * your user pool. Before you can delete a user pool that you have protected * against deletion, you must deactivate this feature.

When you try to * delete a protected user pool in a DeleteUserPool API request, * Amazon Cognito returns an InvalidParameterException error. To * delete a protected user pool, send a new DeleteUserPool request * after you deactivate deletion protection in an UpdateUserPool API * request.

*/ inline const DeletionProtectionType& GetDeletionProtection() const{ return m_deletionProtection; } /** *

When active, DeletionProtection prevents accidental deletion of * your user pool. Before you can delete a user pool that you have protected * against deletion, you must deactivate this feature.

*/ inline bool DeletionProtectionHasBeenSet() const { return m_deletionProtectionHasBeenSet; } /** *

When active, DeletionProtection prevents accidental deletion of * your user pool. Before you can delete a user pool that you have protected * against deletion, you must deactivate this feature.

*/ inline void SetDeletionProtection(const DeletionProtectionType& value) { m_deletionProtectionHasBeenSet = true; m_deletionProtection = value; } /** *

When active, DeletionProtection prevents accidental deletion of * your user pool. Before you can delete a user pool that you have protected * against deletion, you must deactivate this feature.

*/ inline void SetDeletionProtection(DeletionProtectionType&& value) { m_deletionProtectionHasBeenSet = true; m_deletionProtection = std::move(value); } /** *

When active, DeletionProtection prevents accidental deletion of * your user pool. Before you can delete a user pool that you have protected * against deletion, you must deactivate this feature.

*/ inline UpdateUserPoolRequest& WithDeletionProtection(const DeletionProtectionType& value) { SetDeletionProtection(value); return *this;} /** *

When active, DeletionProtection prevents accidental deletion of * your user pool. Before you can delete a user pool that you have protected * against deletion, you must deactivate this feature.

*/ inline UpdateUserPoolRequest& WithDeletionProtection(DeletionProtectionType&& value) { SetDeletionProtection(std::move(value)); return *this;} /** *

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

*/ inline const LambdaConfigType& GetLambdaConfig() const{ return m_lambdaConfig; } /** *

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

*/ inline bool LambdaConfigHasBeenSet() const { return m_lambdaConfigHasBeenSet; } /** *

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

*/ inline void SetLambdaConfig(const LambdaConfigType& value) { m_lambdaConfigHasBeenSet = true; m_lambdaConfig = value; } /** *

The 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 Lambda configuration information from the request to update the user * pool.

*/ inline UpdateUserPoolRequest& WithLambdaConfig(const LambdaConfigType& value) { SetLambdaConfig(value); return *this;} /** *

The 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 Amazon Cognito requests * to update user pools.

*/ inline const Aws::Vector& GetAutoVerifiedAttributes() const{ return m_autoVerifiedAttributes; } /** *

The attributes that are automatically verified when Amazon Cognito requests * to update user pools.

*/ inline bool AutoVerifiedAttributesHasBeenSet() const { return m_autoVerifiedAttributesHasBeenSet; } /** *

The attributes that are automatically verified when Amazon Cognito requests * to update user pools.

*/ inline void SetAutoVerifiedAttributes(const Aws::Vector& value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes = value; } /** *

The attributes that are automatically verified when Amazon Cognito requests * to update user pools.

*/ inline void SetAutoVerifiedAttributes(Aws::Vector&& value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes = std::move(value); } /** *

The attributes that are automatically verified when Amazon Cognito requests * to update user pools.

*/ inline UpdateUserPoolRequest& WithAutoVerifiedAttributes(const Aws::Vector& value) { SetAutoVerifiedAttributes(value); return *this;} /** *

The attributes that are automatically verified when Amazon Cognito requests * to update user pools.

*/ inline UpdateUserPoolRequest& WithAutoVerifiedAttributes(Aws::Vector&& value) { SetAutoVerifiedAttributes(std::move(value)); return *this;} /** *

The attributes that are automatically verified when Amazon Cognito requests * 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 Amazon Cognito requests * to update user pools.

*/ inline UpdateUserPoolRequest& AddAutoVerifiedAttributes(VerifiedAttributeType&& value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes.push_back(std::move(value)); return *this; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline const Aws::String& GetSmsVerificationMessage() const{ return m_smsVerificationMessage; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline bool SmsVerificationMessageHasBeenSet() const { return m_smsVerificationMessageHasBeenSet; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetSmsVerificationMessage(const Aws::String& value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage = value; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetSmsVerificationMessage(Aws::String&& value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage = std::move(value); } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetSmsVerificationMessage(const char* value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage.assign(value); } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithSmsVerificationMessage(const Aws::String& value) { SetSmsVerificationMessage(value); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithSmsVerificationMessage(Aws::String&& value) { SetSmsVerificationMessage(std::move(value)); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithSmsVerificationMessage(const char* value) { SetSmsVerificationMessage(value); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline const Aws::String& GetEmailVerificationMessage() const{ return m_emailVerificationMessage; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline bool EmailVerificationMessageHasBeenSet() const { return m_emailVerificationMessageHasBeenSet; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetEmailVerificationMessage(const Aws::String& value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage = value; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetEmailVerificationMessage(Aws::String&& value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage = std::move(value); } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetEmailVerificationMessage(const char* value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage.assign(value); } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithEmailVerificationMessage(const Aws::String& value) { SetEmailVerificationMessage(value); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithEmailVerificationMessage(Aws::String&& value) { SetEmailVerificationMessage(std::move(value)); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithEmailVerificationMessage(const char* value) { SetEmailVerificationMessage(value); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline const Aws::String& GetEmailVerificationSubject() const{ return m_emailVerificationSubject; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline bool EmailVerificationSubjectHasBeenSet() const { return m_emailVerificationSubjectHasBeenSet; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetEmailVerificationSubject(const Aws::String& value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject = value; } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetEmailVerificationSubject(Aws::String&& value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject = std::move(value); } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline void SetEmailVerificationSubject(const char* value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject.assign(value); } /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithEmailVerificationSubject(const Aws::String& value) { SetEmailVerificationSubject(value); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ inline UpdateUserPoolRequest& WithEmailVerificationSubject(Aws::String&& value) { SetEmailVerificationSubject(std::move(value)); return *this;} /** *

This parameter is no longer used. See VerificationMessageTemplateType.

*/ 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;} /** *

The settings for updates to user attributes. These settings include the * property AttributesRequireVerificationBeforeUpdate, a user-pool * setting that tells Amazon Cognito how to handle changes to the value of your * users' email address and phone number attributes. For more information, see * Verifying updates to email addresses and phone numbers.

*/ inline const UserAttributeUpdateSettingsType& GetUserAttributeUpdateSettings() const{ return m_userAttributeUpdateSettings; } /** *

*/ inline bool UserAttributeUpdateSettingsHasBeenSet() const { return m_userAttributeUpdateSettingsHasBeenSet; } /** *

*/ inline void SetUserAttributeUpdateSettings(const UserAttributeUpdateSettingsType& value) { m_userAttributeUpdateSettingsHasBeenSet = true; m_userAttributeUpdateSettings = value; } /** *

*/ inline void SetUserAttributeUpdateSettings(UserAttributeUpdateSettingsType&& value) { m_userAttributeUpdateSettingsHasBeenSet = true; m_userAttributeUpdateSettings = std::move(value); } /** *

*/ inline UpdateUserPoolRequest& WithUserAttributeUpdateSettings(const UserAttributeUpdateSettingsType& value) { SetUserAttributeUpdateSettings(value); return *this;} /** *

*/ inline UpdateUserPoolRequest& WithUserAttributeUpdateSettings(UserAttributeUpdateSettingsType&& value) { SetUserAttributeUpdateSettings(std::move(value)); return *this;} /** *

Possible values include:

OFF - MFA tokens * aren't required and can't be specified during user registration.
*
ON - MFA tokens are required for all user registrations. You * can only specify ON when you're 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.

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

Possible values include:

OFF - MFA tokens * aren't required and can't be specified during user registration.
*
ON - MFA tokens are required for all user registrations. You * can only specify ON when you're 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.

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

Possible values include:

OFF - MFA tokens * aren't required and can't be specified during user registration.
*
ON - MFA tokens are required for all user registrations. You * can only specify ON when you're 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.

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

Possible values include:

OFF - MFA tokens * aren't required and can't be specified during user registration.
*
ON - MFA tokens are required for all user registrations. You * can only specify ON when you're 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.

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

Possible values include:

OFF - MFA tokens * aren't required and can't be specified during user registration.
*
ON - MFA tokens are required for all user registrations. You * can only specify ON when you're 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.

*/ inline UpdateUserPoolRequest& WithMfaConfiguration(const UserPoolMfaType& value) { SetMfaConfiguration(value); return *this;} /** *

Possible values include:

OFF - MFA tokens * aren't required and can't be specified during user registration.
*
ON - MFA tokens are required for all user registrations. You * can only specify ON when you're 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.

*/ inline UpdateUserPoolRequest& WithMfaConfiguration(UserPoolMfaType&& value) { SetMfaConfiguration(std::move(value)); return *this;} /** *

The device-remembering configuration for a user pool. A null value indicates * that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you * activate the Amazon Cognito device-remembering feature.

*/ inline const DeviceConfigurationType& GetDeviceConfiguration() const{ return m_deviceConfiguration; } /** *

The device-remembering configuration for a user pool. A null value indicates * that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you * activate the Amazon Cognito device-remembering feature.

*/ inline bool DeviceConfigurationHasBeenSet() const { return m_deviceConfigurationHasBeenSet; } /** *

The device-remembering configuration for a user pool. A null value indicates * that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you * activate the Amazon Cognito device-remembering feature.

*/ inline void SetDeviceConfiguration(const DeviceConfigurationType& value) { m_deviceConfigurationHasBeenSet = true; m_deviceConfiguration = value; } /** *

The device-remembering configuration for a user pool. A null value indicates * that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you * activate the Amazon Cognito device-remembering feature.

*/ inline void SetDeviceConfiguration(DeviceConfigurationType&& value) { m_deviceConfigurationHasBeenSet = true; m_deviceConfiguration = std::move(value); } /** *

The device-remembering configuration for a user pool. A null value indicates * that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you * activate the Amazon Cognito device-remembering feature.

*/ inline UpdateUserPoolRequest& WithDeviceConfiguration(const DeviceConfigurationType& value) { SetDeviceConfiguration(value); return *this;} /** *

The device-remembering configuration for a user pool. A null value indicates * that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you * activate the Amazon Cognito device-remembering feature.

*/ inline UpdateUserPoolRequest& WithDeviceConfiguration(DeviceConfigurationType&& value) { SetDeviceConfiguration(std::move(value)); return *this;} /** *

The email configuration of your user pool. The email configuration type sets * your preferred sending method, Amazon Web Services Region, and sender for email * invitation and verification messages from your user pool.

*/ inline const EmailConfigurationType& GetEmailConfiguration() const{ return m_emailConfiguration; } /** *

*/ inline bool EmailConfigurationHasBeenSet() const { return m_emailConfigurationHasBeenSet; } /** *

*/ inline void SetEmailConfiguration(const EmailConfigurationType& value) { m_emailConfigurationHasBeenSet = true; m_emailConfiguration = value; } /** *

*/ inline void SetEmailConfiguration(EmailConfigurationType&& value) { m_emailConfigurationHasBeenSet = true; m_emailConfiguration = std::move(value); } /** *

*/ inline UpdateUserPoolRequest& WithEmailConfiguration(const EmailConfigurationType& value) { SetEmailConfiguration(value); return *this;} /** *

*/ inline UpdateUserPoolRequest& WithEmailConfiguration(EmailConfigurationType&& value) { SetEmailConfiguration(std::move(value)); return *this;} /** *

The SMS configuration with the settings that your Amazon Cognito user pool * must use to send an SMS message from your Amazon Web Services account through * Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the * Amazon Web Services Region that you want, the Amazon Cognito user pool uses an * Identity and Access Management (IAM) role in your Amazon Web Services * account.

*/ inline const SmsConfigurationType& GetSmsConfiguration() const{ return m_smsConfiguration; } /** *

*/ inline bool SmsConfigurationHasBeenSet() const { return m_smsConfigurationHasBeenSet; } /** *

*/ inline void SetSmsConfiguration(const SmsConfigurationType& value) { m_smsConfigurationHasBeenSet = true; m_smsConfiguration = value; } /** *

*/ inline void SetSmsConfiguration(SmsConfigurationType&& value) { m_smsConfigurationHasBeenSet = true; m_smsConfiguration = std::move(value); } /** *

*/ inline UpdateUserPoolRequest& WithSmsConfiguration(const SmsConfigurationType& value) { SetSmsConfiguration(value); return *this;} /** *

*/ 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::Map& GetUserPoolTags() const{ return m_userPoolTags; } /** *

*/ inline bool UserPoolTagsHasBeenSet() const { return m_userPoolTagsHasBeenSet; } /** *

*/ inline void SetUserPoolTags(const Aws::Map& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags = value; } /** *

*/ inline void SetUserPoolTags(Aws::Map&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags = std::move(value); } /** *

*/ inline UpdateUserPoolRequest& WithUserPoolTags(const Aws::Map& value) { SetUserPoolTags(value); return *this;} /** *

*/ inline UpdateUserPoolRequest& WithUserPoolTags(Aws::Map&& value) { SetUserPoolTags(std::move(value)); return *this;} /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(const Aws::String& key, const Aws::String& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, value); return *this; } /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(Aws::String&& key, const Aws::String& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::move(key), value); return *this; } /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(const Aws::String& key, Aws::String&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, std::move(value)); return *this; } /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(Aws::String&& key, Aws::String&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::move(key), std::move(value)); return *this; } /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(const char* key, Aws::String&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, std::move(value)); return *this; } /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(Aws::String&& key, const char* value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::move(key), value); return *this; } /** *

*/ inline UpdateUserPoolRequest& AddUserPoolTags(const char* key, const char* value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(key, value); return *this; } /** *

The configuration for AdminCreateUser requests.

*/ inline const AdminCreateUserConfigType& GetAdminCreateUserConfig() const{ return m_adminCreateUserConfig; } /** *

The configuration for AdminCreateUser requests.

*/ inline bool AdminCreateUserConfigHasBeenSet() const { return m_adminCreateUserConfigHasBeenSet; } /** *

The configuration for AdminCreateUser requests.

*/ inline void SetAdminCreateUserConfig(const AdminCreateUserConfigType& value) { m_adminCreateUserConfigHasBeenSet = true; m_adminCreateUserConfig = value; } /** *

The configuration for AdminCreateUser requests.

*/ inline void SetAdminCreateUserConfig(AdminCreateUserConfigType&& value) { m_adminCreateUserConfigHasBeenSet = true; m_adminCreateUserConfig = std::move(value); } /** *

The configuration for AdminCreateUser requests.

*/ inline UpdateUserPoolRequest& WithAdminCreateUserConfig(const AdminCreateUserConfigType& value) { SetAdminCreateUserConfig(value); return *this;} /** *

The configuration for AdminCreateUser requests.

*/ inline UpdateUserPoolRequest& WithAdminCreateUserConfig(AdminCreateUserConfigType&& value) { SetAdminCreateUserConfig(std::move(value)); return *this;} /** *

Enables advanced security risk detection. Set the key * AdvancedSecurityMode to the value "AUDIT".

*/ inline const UserPoolAddOnsType& GetUserPoolAddOns() const{ return m_userPoolAddOns; } /** *

Enables advanced security risk detection. Set the key * AdvancedSecurityMode to the value "AUDIT".

*/ inline bool UserPoolAddOnsHasBeenSet() const { return m_userPoolAddOnsHasBeenSet; } /** *

Enables advanced security risk detection. Set the key * AdvancedSecurityMode to the value "AUDIT".

*/ inline void SetUserPoolAddOns(const UserPoolAddOnsType& value) { m_userPoolAddOnsHasBeenSet = true; m_userPoolAddOns = value; } /** *

Enables advanced security risk detection. Set the key * AdvancedSecurityMode to the value "AUDIT".

*/ inline void SetUserPoolAddOns(UserPoolAddOnsType&& value) { m_userPoolAddOnsHasBeenSet = true; m_userPoolAddOns = std::move(value); } /** *

Enables advanced security risk detection. Set the key * AdvancedSecurityMode to the value "AUDIT".

*/ inline UpdateUserPoolRequest& WithUserPoolAddOns(const UserPoolAddOnsType& value) { SetUserPoolAddOns(value); return *this;} /** *

Enables advanced security risk detection. Set the key * AdvancedSecurityMode to the value "AUDIT".

*/ inline UpdateUserPoolRequest& WithUserPoolAddOns(UserPoolAddOnsType&& value) { SetUserPoolAddOns(std::move(value)); return *this;} /** *

The available verified method a user can use to recover their password when * they call ForgotPassword. You can use this setting to define a * preferred method when a user has more than one method available. With this * setting, SMS doesn't qualify for a valid password recovery mechanism if the user * also has SMS multi-factor authentication (MFA) activated. In the absence of this * setting, Amazon Cognito uses the legacy behavior to determine the recovery * method where SMS is preferred through email.

*/ inline const AccountRecoverySettingType& GetAccountRecoverySetting() const{ return m_accountRecoverySetting; } /** *

*/ inline bool AccountRecoverySettingHasBeenSet() const { return m_accountRecoverySettingHasBeenSet; } /** *

*/ inline void SetAccountRecoverySetting(const AccountRecoverySettingType& value) { m_accountRecoverySettingHasBeenSet = true; m_accountRecoverySetting = value; } /** *

*/ inline void SetAccountRecoverySetting(AccountRecoverySettingType&& value) { m_accountRecoverySettingHasBeenSet = true; m_accountRecoverySetting = std::move(value); } /** *

*/ inline UpdateUserPoolRequest& WithAccountRecoverySetting(const AccountRecoverySettingType& value) { SetAccountRecoverySetting(value); return *this;} /** *

*/ inline UpdateUserPoolRequest& WithAccountRecoverySetting(AccountRecoverySettingType&& value) { SetAccountRecoverySetting(std::move(value)); return *this;} private: Aws::String m_userPoolId; bool m_userPoolIdHasBeenSet = false; UserPoolPolicyType m_policies; bool m_policiesHasBeenSet = false; DeletionProtectionType m_deletionProtection; bool m_deletionProtectionHasBeenSet = false; LambdaConfigType m_lambdaConfig; bool m_lambdaConfigHasBeenSet = false; Aws::Vector m_autoVerifiedAttributes; bool m_autoVerifiedAttributesHasBeenSet = false; Aws::String m_smsVerificationMessage; bool m_smsVerificationMessageHasBeenSet = false; Aws::String m_emailVerificationMessage; bool m_emailVerificationMessageHasBeenSet = false; Aws::String m_emailVerificationSubject; bool m_emailVerificationSubjectHasBeenSet = false; VerificationMessageTemplateType m_verificationMessageTemplate; bool m_verificationMessageTemplateHasBeenSet = false; Aws::String m_smsAuthenticationMessage; bool m_smsAuthenticationMessageHasBeenSet = false; UserAttributeUpdateSettingsType m_userAttributeUpdateSettings; bool m_userAttributeUpdateSettingsHasBeenSet = false; UserPoolMfaType m_mfaConfiguration; bool m_mfaConfigurationHasBeenSet = false; DeviceConfigurationType m_deviceConfiguration; bool m_deviceConfigurationHasBeenSet = false; EmailConfigurationType m_emailConfiguration; bool m_emailConfigurationHasBeenSet = false; SmsConfigurationType m_smsConfiguration; bool m_smsConfigurationHasBeenSet = false; Aws::Map m_userPoolTags; bool m_userPoolTagsHasBeenSet = false; AdminCreateUserConfigType m_adminCreateUserConfig; bool m_adminCreateUserConfigHasBeenSet = false; UserPoolAddOnsType m_userPoolAddOns; bool m_userPoolAddOnsHasBeenSet = false; AccountRecoverySettingType m_accountRecoverySetting; bool m_accountRecoverySettingHasBeenSet = false; }; } // namespace Model } // namespace CognitoIdentityProvider } // namespace Aws

See Also: