AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
UpdateUserPoolRequest.h
1
6#pragma once
7#include <aws/cognito-idp/CognitoIdentityProvider_EXPORTS.h>
8#include <aws/cognito-idp/CognitoIdentityProviderRequest.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/cognito-idp/model/UserPoolPolicyType.h>
11#include <aws/cognito-idp/model/DeletionProtectionType.h>
12#include <aws/cognito-idp/model/LambdaConfigType.h>
13#include <aws/core/utils/memory/stl/AWSVector.h>
14#include <aws/cognito-idp/model/VerificationMessageTemplateType.h>
15#include <aws/cognito-idp/model/UserAttributeUpdateSettingsType.h>
16#include <aws/cognito-idp/model/UserPoolMfaType.h>
17#include <aws/cognito-idp/model/DeviceConfigurationType.h>
18#include <aws/cognito-idp/model/EmailConfigurationType.h>
19#include <aws/cognito-idp/model/SmsConfigurationType.h>
20#include <aws/core/utils/memory/stl/AWSMap.h>
21#include <aws/cognito-idp/model/AdminCreateUserConfigType.h>
22#include <aws/cognito-idp/model/UserPoolAddOnsType.h>
23#include <aws/cognito-idp/model/AccountRecoverySettingType.h>
24#include <aws/cognito-idp/model/UserPoolTierType.h>
25#include <aws/cognito-idp/model/VerifiedAttributeType.h>
26#include <utility>
27
28namespace Aws
29{
30namespace CognitoIdentityProvider
31{
32namespace Model
33{
34
41 {
42 public:
43 AWS_COGNITOIDENTITYPROVIDER_API UpdateUserPoolRequest() = default;
44
45 // Service request name is the Operation name which will send this request out,
46 // each operation should has unique request name, so that we can get operation's name from this request.
47 // Note: this is not true for response, multiple operations may have the same response name,
48 // so we can not get operation's name from response.
49 inline virtual const char* GetServiceRequestName() const override { return "UpdateUserPool"; }
50
51 AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override;
52
53 AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
54
55
57
60 inline const Aws::String& GetUserPoolId() const { return m_userPoolId; }
61 inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; }
62 template<typename UserPoolIdT = Aws::String>
63 void SetUserPoolId(UserPoolIdT&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::forward<UserPoolIdT>(value); }
64 template<typename UserPoolIdT = Aws::String>
65 UpdateUserPoolRequest& WithUserPoolId(UserPoolIdT&& value) { SetUserPoolId(std::forward<UserPoolIdT>(value)); return *this;}
67
69
76 inline const UserPoolPolicyType& GetPolicies() const { return m_policies; }
77 inline bool PoliciesHasBeenSet() const { return m_policiesHasBeenSet; }
78 template<typename PoliciesT = UserPoolPolicyType>
79 void SetPolicies(PoliciesT&& value) { m_policiesHasBeenSet = true; m_policies = std::forward<PoliciesT>(value); }
80 template<typename PoliciesT = UserPoolPolicyType>
81 UpdateUserPoolRequest& WithPolicies(PoliciesT&& value) { SetPolicies(std::forward<PoliciesT>(value)); return *this;}
83
85
95 inline DeletionProtectionType GetDeletionProtection() const { return m_deletionProtection; }
96 inline bool DeletionProtectionHasBeenSet() const { return m_deletionProtectionHasBeenSet; }
97 inline void SetDeletionProtection(DeletionProtectionType value) { m_deletionProtectionHasBeenSet = true; m_deletionProtection = value; }
100
102
107 inline const LambdaConfigType& GetLambdaConfig() const { return m_lambdaConfig; }
108 inline bool LambdaConfigHasBeenSet() const { return m_lambdaConfigHasBeenSet; }
109 template<typename LambdaConfigT = LambdaConfigType>
110 void SetLambdaConfig(LambdaConfigT&& value) { m_lambdaConfigHasBeenSet = true; m_lambdaConfig = std::forward<LambdaConfigT>(value); }
111 template<typename LambdaConfigT = LambdaConfigType>
112 UpdateUserPoolRequest& WithLambdaConfig(LambdaConfigT&& value) { SetLambdaConfig(std::forward<LambdaConfigT>(value)); return *this;}
114
116
122 inline const Aws::Vector<VerifiedAttributeType>& GetAutoVerifiedAttributes() const { return m_autoVerifiedAttributes; }
123 inline bool AutoVerifiedAttributesHasBeenSet() const { return m_autoVerifiedAttributesHasBeenSet; }
124 template<typename AutoVerifiedAttributesT = Aws::Vector<VerifiedAttributeType>>
125 void SetAutoVerifiedAttributes(AutoVerifiedAttributesT&& value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes = std::forward<AutoVerifiedAttributesT>(value); }
126 template<typename AutoVerifiedAttributesT = Aws::Vector<VerifiedAttributeType>>
127 UpdateUserPoolRequest& WithAutoVerifiedAttributes(AutoVerifiedAttributesT&& value) { SetAutoVerifiedAttributes(std::forward<AutoVerifiedAttributesT>(value)); return *this;}
128 inline UpdateUserPoolRequest& AddAutoVerifiedAttributes(VerifiedAttributeType value) { m_autoVerifiedAttributesHasBeenSet = true; m_autoVerifiedAttributes.push_back(value); return *this; }
130
132
135 inline const Aws::String& GetSmsVerificationMessage() const { return m_smsVerificationMessage; }
136 inline bool SmsVerificationMessageHasBeenSet() const { return m_smsVerificationMessageHasBeenSet; }
137 template<typename SmsVerificationMessageT = Aws::String>
138 void SetSmsVerificationMessage(SmsVerificationMessageT&& value) { m_smsVerificationMessageHasBeenSet = true; m_smsVerificationMessage = std::forward<SmsVerificationMessageT>(value); }
139 template<typename SmsVerificationMessageT = Aws::String>
140 UpdateUserPoolRequest& WithSmsVerificationMessage(SmsVerificationMessageT&& value) { SetSmsVerificationMessage(std::forward<SmsVerificationMessageT>(value)); return *this;}
142
144
147 inline const Aws::String& GetEmailVerificationMessage() const { return m_emailVerificationMessage; }
148 inline bool EmailVerificationMessageHasBeenSet() const { return m_emailVerificationMessageHasBeenSet; }
149 template<typename EmailVerificationMessageT = Aws::String>
150 void SetEmailVerificationMessage(EmailVerificationMessageT&& value) { m_emailVerificationMessageHasBeenSet = true; m_emailVerificationMessage = std::forward<EmailVerificationMessageT>(value); }
151 template<typename EmailVerificationMessageT = Aws::String>
152 UpdateUserPoolRequest& WithEmailVerificationMessage(EmailVerificationMessageT&& value) { SetEmailVerificationMessage(std::forward<EmailVerificationMessageT>(value)); return *this;}
154
156
159 inline const Aws::String& GetEmailVerificationSubject() const { return m_emailVerificationSubject; }
160 inline bool EmailVerificationSubjectHasBeenSet() const { return m_emailVerificationSubjectHasBeenSet; }
161 template<typename EmailVerificationSubjectT = Aws::String>
162 void SetEmailVerificationSubject(EmailVerificationSubjectT&& value) { m_emailVerificationSubjectHasBeenSet = true; m_emailVerificationSubject = std::forward<EmailVerificationSubjectT>(value); }
163 template<typename EmailVerificationSubjectT = Aws::String>
164 UpdateUserPoolRequest& WithEmailVerificationSubject(EmailVerificationSubjectT&& value) { SetEmailVerificationSubject(std::forward<EmailVerificationSubjectT>(value)); return *this;}
166
168
178 inline const VerificationMessageTemplateType& GetVerificationMessageTemplate() const { return m_verificationMessageTemplate; }
179 inline bool VerificationMessageTemplateHasBeenSet() const { return m_verificationMessageTemplateHasBeenSet; }
180 template<typename VerificationMessageTemplateT = VerificationMessageTemplateType>
181 void SetVerificationMessageTemplate(VerificationMessageTemplateT&& value) { m_verificationMessageTemplateHasBeenSet = true; m_verificationMessageTemplate = std::forward<VerificationMessageTemplateT>(value); }
182 template<typename VerificationMessageTemplateT = VerificationMessageTemplateType>
183 UpdateUserPoolRequest& WithVerificationMessageTemplate(VerificationMessageTemplateT&& value) { SetVerificationMessageTemplate(std::forward<VerificationMessageTemplateT>(value)); return *this;}
185
187
191 inline const Aws::String& GetSmsAuthenticationMessage() const { return m_smsAuthenticationMessage; }
192 inline bool SmsAuthenticationMessageHasBeenSet() const { return m_smsAuthenticationMessageHasBeenSet; }
193 template<typename SmsAuthenticationMessageT = Aws::String>
194 void SetSmsAuthenticationMessage(SmsAuthenticationMessageT&& value) { m_smsAuthenticationMessageHasBeenSet = true; m_smsAuthenticationMessage = std::forward<SmsAuthenticationMessageT>(value); }
195 template<typename SmsAuthenticationMessageT = Aws::String>
196 UpdateUserPoolRequest& WithSmsAuthenticationMessage(SmsAuthenticationMessageT&& value) { SetSmsAuthenticationMessage(std::forward<SmsAuthenticationMessageT>(value)); return *this;}
198
200
208 inline const UserAttributeUpdateSettingsType& GetUserAttributeUpdateSettings() const { return m_userAttributeUpdateSettings; }
209 inline bool UserAttributeUpdateSettingsHasBeenSet() const { return m_userAttributeUpdateSettingsHasBeenSet; }
210 template<typename UserAttributeUpdateSettingsT = UserAttributeUpdateSettingsType>
211 void SetUserAttributeUpdateSettings(UserAttributeUpdateSettingsT&& value) { m_userAttributeUpdateSettingsHasBeenSet = true; m_userAttributeUpdateSettings = std::forward<UserAttributeUpdateSettingsT>(value); }
212 template<typename UserAttributeUpdateSettingsT = UserAttributeUpdateSettingsType>
213 UpdateUserPoolRequest& WithUserAttributeUpdateSettings(UserAttributeUpdateSettingsT&& value) { SetUserAttributeUpdateSettings(std::forward<UserAttributeUpdateSettingsT>(value)); return *this;}
215
217
228 inline UserPoolMfaType GetMfaConfiguration() const { return m_mfaConfiguration; }
229 inline bool MfaConfigurationHasBeenSet() const { return m_mfaConfigurationHasBeenSet; }
230 inline void SetMfaConfiguration(UserPoolMfaType value) { m_mfaConfigurationHasBeenSet = true; m_mfaConfiguration = value; }
233
235
249 inline const DeviceConfigurationType& GetDeviceConfiguration() const { return m_deviceConfiguration; }
250 inline bool DeviceConfigurationHasBeenSet() const { return m_deviceConfigurationHasBeenSet; }
251 template<typename DeviceConfigurationT = DeviceConfigurationType>
252 void SetDeviceConfiguration(DeviceConfigurationT&& value) { m_deviceConfigurationHasBeenSet = true; m_deviceConfiguration = std::forward<DeviceConfigurationT>(value); }
253 template<typename DeviceConfigurationT = DeviceConfigurationType>
254 UpdateUserPoolRequest& WithDeviceConfiguration(DeviceConfigurationT&& value) { SetDeviceConfiguration(std::forward<DeviceConfigurationT>(value)); return *this;}
256
258
263 inline const EmailConfigurationType& GetEmailConfiguration() const { return m_emailConfiguration; }
264 inline bool EmailConfigurationHasBeenSet() const { return m_emailConfigurationHasBeenSet; }
265 template<typename EmailConfigurationT = EmailConfigurationType>
266 void SetEmailConfiguration(EmailConfigurationT&& value) { m_emailConfigurationHasBeenSet = true; m_emailConfiguration = std::forward<EmailConfigurationT>(value); }
267 template<typename EmailConfigurationT = EmailConfigurationType>
268 UpdateUserPoolRequest& WithEmailConfiguration(EmailConfigurationT&& value) { SetEmailConfiguration(std::forward<EmailConfigurationT>(value)); return *this;}
270
272
281 inline const SmsConfigurationType& GetSmsConfiguration() const { return m_smsConfiguration; }
282 inline bool SmsConfigurationHasBeenSet() const { return m_smsConfigurationHasBeenSet; }
283 template<typename SmsConfigurationT = SmsConfigurationType>
284 void SetSmsConfiguration(SmsConfigurationT&& value) { m_smsConfigurationHasBeenSet = true; m_smsConfiguration = std::forward<SmsConfigurationT>(value); }
285 template<typename SmsConfigurationT = SmsConfigurationType>
286 UpdateUserPoolRequest& WithSmsConfiguration(SmsConfigurationT&& value) { SetSmsConfiguration(std::forward<SmsConfigurationT>(value)); return *this;}
288
290
295 inline const Aws::Map<Aws::String, Aws::String>& GetUserPoolTags() const { return m_userPoolTags; }
296 inline bool UserPoolTagsHasBeenSet() const { return m_userPoolTagsHasBeenSet; }
297 template<typename UserPoolTagsT = Aws::Map<Aws::String, Aws::String>>
298 void SetUserPoolTags(UserPoolTagsT&& value) { m_userPoolTagsHasBeenSet = true; m_userPoolTags = std::forward<UserPoolTagsT>(value); }
299 template<typename UserPoolTagsT = Aws::Map<Aws::String, Aws::String>>
300 UpdateUserPoolRequest& WithUserPoolTags(UserPoolTagsT&& value) { SetUserPoolTags(std::forward<UserPoolTagsT>(value)); return *this;}
301 template<typename UserPoolTagsKeyT = Aws::String, typename UserPoolTagsValueT = Aws::String>
302 UpdateUserPoolRequest& AddUserPoolTags(UserPoolTagsKeyT&& key, UserPoolTagsValueT&& value) {
303 m_userPoolTagsHasBeenSet = true; m_userPoolTags.emplace(std::forward<UserPoolTagsKeyT>(key), std::forward<UserPoolTagsValueT>(value)); return *this;
304 }
306
308
313 inline const AdminCreateUserConfigType& GetAdminCreateUserConfig() const { return m_adminCreateUserConfig; }
314 inline bool AdminCreateUserConfigHasBeenSet() const { return m_adminCreateUserConfigHasBeenSet; }
315 template<typename AdminCreateUserConfigT = AdminCreateUserConfigType>
316 void SetAdminCreateUserConfig(AdminCreateUserConfigT&& value) { m_adminCreateUserConfigHasBeenSet = true; m_adminCreateUserConfig = std::forward<AdminCreateUserConfigT>(value); }
317 template<typename AdminCreateUserConfigT = AdminCreateUserConfigType>
318 UpdateUserPoolRequest& WithAdminCreateUserConfig(AdminCreateUserConfigT&& value) { SetAdminCreateUserConfig(std::forward<AdminCreateUserConfigT>(value)); return *this;}
320
322
334 inline const UserPoolAddOnsType& GetUserPoolAddOns() const { return m_userPoolAddOns; }
335 inline bool UserPoolAddOnsHasBeenSet() const { return m_userPoolAddOnsHasBeenSet; }
336 template<typename UserPoolAddOnsT = UserPoolAddOnsType>
337 void SetUserPoolAddOns(UserPoolAddOnsT&& value) { m_userPoolAddOnsHasBeenSet = true; m_userPoolAddOns = std::forward<UserPoolAddOnsT>(value); }
338 template<typename UserPoolAddOnsT = UserPoolAddOnsType>
339 UpdateUserPoolRequest& WithUserPoolAddOns(UserPoolAddOnsT&& value) { SetUserPoolAddOns(std::forward<UserPoolAddOnsT>(value)); return *this;}
341
343
352 inline const AccountRecoverySettingType& GetAccountRecoverySetting() const { return m_accountRecoverySetting; }
353 inline bool AccountRecoverySettingHasBeenSet() const { return m_accountRecoverySettingHasBeenSet; }
354 template<typename AccountRecoverySettingT = AccountRecoverySettingType>
355 void SetAccountRecoverySetting(AccountRecoverySettingT&& value) { m_accountRecoverySettingHasBeenSet = true; m_accountRecoverySetting = std::forward<AccountRecoverySettingT>(value); }
356 template<typename AccountRecoverySettingT = AccountRecoverySettingType>
357 UpdateUserPoolRequest& WithAccountRecoverySetting(AccountRecoverySettingT&& value) { SetAccountRecoverySetting(std::forward<AccountRecoverySettingT>(value)); return *this;}
359
361
364 inline const Aws::String& GetPoolName() const { return m_poolName; }
365 inline bool PoolNameHasBeenSet() const { return m_poolNameHasBeenSet; }
366 template<typename PoolNameT = Aws::String>
367 void SetPoolName(PoolNameT&& value) { m_poolNameHasBeenSet = true; m_poolName = std::forward<PoolNameT>(value); }
368 template<typename PoolNameT = Aws::String>
369 UpdateUserPoolRequest& WithPoolName(PoolNameT&& value) { SetPoolName(std::forward<PoolNameT>(value)); return *this;}
371
373
380 inline UserPoolTierType GetUserPoolTier() const { return m_userPoolTier; }
381 inline bool UserPoolTierHasBeenSet() const { return m_userPoolTierHasBeenSet; }
382 inline void SetUserPoolTier(UserPoolTierType value) { m_userPoolTierHasBeenSet = true; m_userPoolTier = value; }
385 private:
386
387 Aws::String m_userPoolId;
388 bool m_userPoolIdHasBeenSet = false;
389
390 UserPoolPolicyType m_policies;
391 bool m_policiesHasBeenSet = false;
392
394 bool m_deletionProtectionHasBeenSet = false;
395
396 LambdaConfigType m_lambdaConfig;
397 bool m_lambdaConfigHasBeenSet = false;
398
399 Aws::Vector<VerifiedAttributeType> m_autoVerifiedAttributes;
400 bool m_autoVerifiedAttributesHasBeenSet = false;
401
402 Aws::String m_smsVerificationMessage;
403 bool m_smsVerificationMessageHasBeenSet = false;
404
405 Aws::String m_emailVerificationMessage;
406 bool m_emailVerificationMessageHasBeenSet = false;
407
408 Aws::String m_emailVerificationSubject;
409 bool m_emailVerificationSubjectHasBeenSet = false;
410
411 VerificationMessageTemplateType m_verificationMessageTemplate;
412 bool m_verificationMessageTemplateHasBeenSet = false;
413
414 Aws::String m_smsAuthenticationMessage;
415 bool m_smsAuthenticationMessageHasBeenSet = false;
416
417 UserAttributeUpdateSettingsType m_userAttributeUpdateSettings;
418 bool m_userAttributeUpdateSettingsHasBeenSet = false;
419
420 UserPoolMfaType m_mfaConfiguration{UserPoolMfaType::NOT_SET};
421 bool m_mfaConfigurationHasBeenSet = false;
422
423 DeviceConfigurationType m_deviceConfiguration;
424 bool m_deviceConfigurationHasBeenSet = false;
425
426 EmailConfigurationType m_emailConfiguration;
427 bool m_emailConfigurationHasBeenSet = false;
428
429 SmsConfigurationType m_smsConfiguration;
430 bool m_smsConfigurationHasBeenSet = false;
431
433 bool m_userPoolTagsHasBeenSet = false;
434
435 AdminCreateUserConfigType m_adminCreateUserConfig;
436 bool m_adminCreateUserConfigHasBeenSet = false;
437
438 UserPoolAddOnsType m_userPoolAddOns;
439 bool m_userPoolAddOnsHasBeenSet = false;
440
441 AccountRecoverySettingType m_accountRecoverySetting;
442 bool m_accountRecoverySettingHasBeenSet = false;
443
444 Aws::String m_poolName;
445 bool m_poolNameHasBeenSet = false;
446
448 bool m_userPoolTierHasBeenSet = false;
449 };
450
451} // namespace Model
452} // namespace CognitoIdentityProvider
453} // namespace Aws
void SetEmailVerificationMessage(EmailVerificationMessageT &&value)
UpdateUserPoolRequest & WithSmsConfiguration(SmsConfigurationT &&value)
UpdateUserPoolRequest & WithLambdaConfig(LambdaConfigT &&value)
UpdateUserPoolRequest & WithDeletionProtection(DeletionProtectionType value)
UpdateUserPoolRequest & WithSmsAuthenticationMessage(SmsAuthenticationMessageT &&value)
const Aws::Map< Aws::String, Aws::String > & GetUserPoolTags() const
UpdateUserPoolRequest & WithAccountRecoverySetting(AccountRecoverySettingT &&value)
UpdateUserPoolRequest & WithEmailVerificationMessage(EmailVerificationMessageT &&value)
UpdateUserPoolRequest & WithMfaConfiguration(UserPoolMfaType value)
const AccountRecoverySettingType & GetAccountRecoverySetting() const
const DeviceConfigurationType & GetDeviceConfiguration() const
UpdateUserPoolRequest & AddUserPoolTags(UserPoolTagsKeyT &&key, UserPoolTagsValueT &&value)
void SetEmailVerificationSubject(EmailVerificationSubjectT &&value)
void SetSmsAuthenticationMessage(SmsAuthenticationMessageT &&value)
UpdateUserPoolRequest & WithDeviceConfiguration(DeviceConfigurationT &&value)
UpdateUserPoolRequest & WithEmailVerificationSubject(EmailVerificationSubjectT &&value)
UpdateUserPoolRequest & WithAutoVerifiedAttributes(AutoVerifiedAttributesT &&value)
const UserAttributeUpdateSettingsType & GetUserAttributeUpdateSettings() const
UpdateUserPoolRequest & WithUserPoolId(UserPoolIdT &&value)
UpdateUserPoolRequest & WithUserPoolTags(UserPoolTagsT &&value)
UpdateUserPoolRequest & WithPoolName(PoolNameT &&value)
const Aws::Vector< VerifiedAttributeType > & GetAutoVerifiedAttributes() const
const AdminCreateUserConfigType & GetAdminCreateUserConfig() const
void SetVerificationMessageTemplate(VerificationMessageTemplateT &&value)
AWS_COGNITOIDENTITYPROVIDER_API UpdateUserPoolRequest()=default
AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
UpdateUserPoolRequest & WithSmsVerificationMessage(SmsVerificationMessageT &&value)
UpdateUserPoolRequest & WithVerificationMessageTemplate(VerificationMessageTemplateT &&value)
void SetUserAttributeUpdateSettings(UserAttributeUpdateSettingsT &&value)
UpdateUserPoolRequest & WithUserPoolAddOns(UserPoolAddOnsT &&value)
UpdateUserPoolRequest & WithEmailConfiguration(EmailConfigurationT &&value)
UpdateUserPoolRequest & AddAutoVerifiedAttributes(VerifiedAttributeType value)
AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override
const VerificationMessageTemplateType & GetVerificationMessageTemplate() const
UpdateUserPoolRequest & WithUserAttributeUpdateSettings(UserAttributeUpdateSettingsT &&value)
UpdateUserPoolRequest & WithPolicies(PoliciesT &&value)
UpdateUserPoolRequest & WithUserPoolTier(UserPoolTierType value)
UpdateUserPoolRequest & WithAdminCreateUserConfig(AdminCreateUserConfigT &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector