AWS SDK for C++

AWS SDK for C++ Version 1.11.750

Loading...
Searching...
No Matches
UpdateUserPoolRequest.h
1
6#pragma once
7#include <aws/cognito-idp/CognitoIdentityProviderRequest.h>
8#include <aws/cognito-idp/CognitoIdentityProvider_EXPORTS.h>
9#include <aws/cognito-idp/model/AccountRecoverySettingType.h>
10#include <aws/cognito-idp/model/AdminCreateUserConfigType.h>
11#include <aws/cognito-idp/model/DeletionProtectionType.h>
12#include <aws/cognito-idp/model/DeviceConfigurationType.h>
13#include <aws/cognito-idp/model/EmailConfigurationType.h>
14#include <aws/cognito-idp/model/LambdaConfigType.h>
15#include <aws/cognito-idp/model/SmsConfigurationType.h>
16#include <aws/cognito-idp/model/UserAttributeUpdateSettingsType.h>
17#include <aws/cognito-idp/model/UserPoolAddOnsType.h>
18#include <aws/cognito-idp/model/UserPoolMfaType.h>
19#include <aws/cognito-idp/model/UserPoolPolicyType.h>
20#include <aws/cognito-idp/model/UserPoolTierType.h>
21#include <aws/cognito-idp/model/VerificationMessageTemplateType.h>
22#include <aws/cognito-idp/model/VerifiedAttributeType.h>
23#include <aws/core/utils/memory/stl/AWSMap.h>
24#include <aws/core/utils/memory/stl/AWSString.h>
25#include <aws/core/utils/memory/stl/AWSVector.h>
26
27#include <utility>
28
29namespace Aws {
30namespace CognitoIdentityProvider {
31namespace Model {
32
39 public:
40 AWS_COGNITOIDENTITYPROVIDER_API UpdateUserPoolRequest() = default;
41
42 // Service request name is the Operation name which will send this request out,
43 // each operation should has unique request name, so that we can get operation's name from this request.
44 // Note: this is not true for response, multiple operations may have the same response name,
45 // so we can not get operation's name from response.
46 inline virtual const char* GetServiceRequestName() const override { return "UpdateUserPool"; }
47
48 AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override;
49
50 AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
51
53
56 inline const Aws::String& GetUserPoolId() const { return m_userPoolId; }
57 inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; }
58 template <typename UserPoolIdT = Aws::String>
59 void SetUserPoolId(UserPoolIdT&& value) {
60 m_userPoolIdHasBeenSet = true;
61 m_userPoolId = std::forward<UserPoolIdT>(value);
62 }
63 template <typename UserPoolIdT = Aws::String>
64 UpdateUserPoolRequest& WithUserPoolId(UserPoolIdT&& value) {
65 SetUserPoolId(std::forward<UserPoolIdT>(value));
66 return *this;
67 }
69
71
78 inline const UserPoolPolicyType& GetPolicies() const { return m_policies; }
79 inline bool PoliciesHasBeenSet() const { return m_policiesHasBeenSet; }
80 template <typename PoliciesT = UserPoolPolicyType>
81 void SetPolicies(PoliciesT&& value) {
82 m_policiesHasBeenSet = true;
83 m_policies = std::forward<PoliciesT>(value);
84 }
85 template <typename PoliciesT = UserPoolPolicyType>
86 UpdateUserPoolRequest& WithPolicies(PoliciesT&& value) {
87 SetPolicies(std::forward<PoliciesT>(value));
88 return *this;
89 }
91
93
103 inline DeletionProtectionType GetDeletionProtection() const { return m_deletionProtection; }
104 inline bool DeletionProtectionHasBeenSet() const { return m_deletionProtectionHasBeenSet; }
106 m_deletionProtectionHasBeenSet = true;
107 m_deletionProtection = value;
108 }
111 return *this;
112 }
114
116
121 inline const LambdaConfigType& GetLambdaConfig() const { return m_lambdaConfig; }
122 inline bool LambdaConfigHasBeenSet() const { return m_lambdaConfigHasBeenSet; }
123 template <typename LambdaConfigT = LambdaConfigType>
124 void SetLambdaConfig(LambdaConfigT&& value) {
125 m_lambdaConfigHasBeenSet = true;
126 m_lambdaConfig = std::forward<LambdaConfigT>(value);
127 }
128 template <typename LambdaConfigT = LambdaConfigType>
129 UpdateUserPoolRequest& WithLambdaConfig(LambdaConfigT&& value) {
130 SetLambdaConfig(std::forward<LambdaConfigT>(value));
131 return *this;
132 }
134
136
142 inline const Aws::Vector<VerifiedAttributeType>& GetAutoVerifiedAttributes() const { return m_autoVerifiedAttributes; }
143 inline bool AutoVerifiedAttributesHasBeenSet() const { return m_autoVerifiedAttributesHasBeenSet; }
144 template <typename AutoVerifiedAttributesT = Aws::Vector<VerifiedAttributeType>>
145 void SetAutoVerifiedAttributes(AutoVerifiedAttributesT&& value) {
146 m_autoVerifiedAttributesHasBeenSet = true;
147 m_autoVerifiedAttributes = std::forward<AutoVerifiedAttributesT>(value);
148 }
149 template <typename AutoVerifiedAttributesT = Aws::Vector<VerifiedAttributeType>>
150 UpdateUserPoolRequest& WithAutoVerifiedAttributes(AutoVerifiedAttributesT&& value) {
151 SetAutoVerifiedAttributes(std::forward<AutoVerifiedAttributesT>(value));
152 return *this;
153 }
155 m_autoVerifiedAttributesHasBeenSet = true;
156 m_autoVerifiedAttributes.push_back(value);
157 return *this;
158 }
160
162
165 inline const Aws::String& GetSmsVerificationMessage() const { return m_smsVerificationMessage; }
166 inline bool SmsVerificationMessageHasBeenSet() const { return m_smsVerificationMessageHasBeenSet; }
167 template <typename SmsVerificationMessageT = Aws::String>
168 void SetSmsVerificationMessage(SmsVerificationMessageT&& value) {
169 m_smsVerificationMessageHasBeenSet = true;
170 m_smsVerificationMessage = std::forward<SmsVerificationMessageT>(value);
171 }
172 template <typename SmsVerificationMessageT = Aws::String>
173 UpdateUserPoolRequest& WithSmsVerificationMessage(SmsVerificationMessageT&& value) {
174 SetSmsVerificationMessage(std::forward<SmsVerificationMessageT>(value));
175 return *this;
176 }
178
180
183 inline const Aws::String& GetEmailVerificationMessage() const { return m_emailVerificationMessage; }
184 inline bool EmailVerificationMessageHasBeenSet() const { return m_emailVerificationMessageHasBeenSet; }
185 template <typename EmailVerificationMessageT = Aws::String>
186 void SetEmailVerificationMessage(EmailVerificationMessageT&& value) {
187 m_emailVerificationMessageHasBeenSet = true;
188 m_emailVerificationMessage = std::forward<EmailVerificationMessageT>(value);
189 }
190 template <typename EmailVerificationMessageT = Aws::String>
191 UpdateUserPoolRequest& WithEmailVerificationMessage(EmailVerificationMessageT&& value) {
192 SetEmailVerificationMessage(std::forward<EmailVerificationMessageT>(value));
193 return *this;
194 }
196
198
201 inline const Aws::String& GetEmailVerificationSubject() const { return m_emailVerificationSubject; }
202 inline bool EmailVerificationSubjectHasBeenSet() const { return m_emailVerificationSubjectHasBeenSet; }
203 template <typename EmailVerificationSubjectT = Aws::String>
204 void SetEmailVerificationSubject(EmailVerificationSubjectT&& value) {
205 m_emailVerificationSubjectHasBeenSet = true;
206 m_emailVerificationSubject = std::forward<EmailVerificationSubjectT>(value);
207 }
208 template <typename EmailVerificationSubjectT = Aws::String>
209 UpdateUserPoolRequest& WithEmailVerificationSubject(EmailVerificationSubjectT&& value) {
210 SetEmailVerificationSubject(std::forward<EmailVerificationSubjectT>(value));
211 return *this;
212 }
214
216
226 inline const VerificationMessageTemplateType& GetVerificationMessageTemplate() const { return m_verificationMessageTemplate; }
227 inline bool VerificationMessageTemplateHasBeenSet() const { return m_verificationMessageTemplateHasBeenSet; }
228 template <typename VerificationMessageTemplateT = VerificationMessageTemplateType>
229 void SetVerificationMessageTemplate(VerificationMessageTemplateT&& value) {
230 m_verificationMessageTemplateHasBeenSet = true;
231 m_verificationMessageTemplate = std::forward<VerificationMessageTemplateT>(value);
232 }
233 template <typename VerificationMessageTemplateT = VerificationMessageTemplateType>
234 UpdateUserPoolRequest& WithVerificationMessageTemplate(VerificationMessageTemplateT&& value) {
235 SetVerificationMessageTemplate(std::forward<VerificationMessageTemplateT>(value));
236 return *this;
237 }
239
241
245 inline const Aws::String& GetSmsAuthenticationMessage() const { return m_smsAuthenticationMessage; }
246 inline bool SmsAuthenticationMessageHasBeenSet() const { return m_smsAuthenticationMessageHasBeenSet; }
247 template <typename SmsAuthenticationMessageT = Aws::String>
248 void SetSmsAuthenticationMessage(SmsAuthenticationMessageT&& value) {
249 m_smsAuthenticationMessageHasBeenSet = true;
250 m_smsAuthenticationMessage = std::forward<SmsAuthenticationMessageT>(value);
251 }
252 template <typename SmsAuthenticationMessageT = Aws::String>
253 UpdateUserPoolRequest& WithSmsAuthenticationMessage(SmsAuthenticationMessageT&& value) {
254 SetSmsAuthenticationMessage(std::forward<SmsAuthenticationMessageT>(value));
255 return *this;
256 }
258
260
268 inline const UserAttributeUpdateSettingsType& GetUserAttributeUpdateSettings() const { return m_userAttributeUpdateSettings; }
269 inline bool UserAttributeUpdateSettingsHasBeenSet() const { return m_userAttributeUpdateSettingsHasBeenSet; }
270 template <typename UserAttributeUpdateSettingsT = UserAttributeUpdateSettingsType>
271 void SetUserAttributeUpdateSettings(UserAttributeUpdateSettingsT&& value) {
272 m_userAttributeUpdateSettingsHasBeenSet = true;
273 m_userAttributeUpdateSettings = std::forward<UserAttributeUpdateSettingsT>(value);
274 }
275 template <typename UserAttributeUpdateSettingsT = UserAttributeUpdateSettingsType>
276 UpdateUserPoolRequest& WithUserAttributeUpdateSettings(UserAttributeUpdateSettingsT&& value) {
277 SetUserAttributeUpdateSettings(std::forward<UserAttributeUpdateSettingsT>(value));
278 return *this;
279 }
281
283
294 inline UserPoolMfaType GetMfaConfiguration() const { return m_mfaConfiguration; }
295 inline bool MfaConfigurationHasBeenSet() const { return m_mfaConfigurationHasBeenSet; }
297 m_mfaConfigurationHasBeenSet = true;
298 m_mfaConfiguration = value;
299 }
301 SetMfaConfiguration(value);
302 return *this;
303 }
305
307
321 inline const DeviceConfigurationType& GetDeviceConfiguration() const { return m_deviceConfiguration; }
322 inline bool DeviceConfigurationHasBeenSet() const { return m_deviceConfigurationHasBeenSet; }
323 template <typename DeviceConfigurationT = DeviceConfigurationType>
324 void SetDeviceConfiguration(DeviceConfigurationT&& value) {
325 m_deviceConfigurationHasBeenSet = true;
326 m_deviceConfiguration = std::forward<DeviceConfigurationT>(value);
327 }
328 template <typename DeviceConfigurationT = DeviceConfigurationType>
329 UpdateUserPoolRequest& WithDeviceConfiguration(DeviceConfigurationT&& value) {
330 SetDeviceConfiguration(std::forward<DeviceConfigurationT>(value));
331 return *this;
332 }
334
336
341 inline const EmailConfigurationType& GetEmailConfiguration() const { return m_emailConfiguration; }
342 inline bool EmailConfigurationHasBeenSet() const { return m_emailConfigurationHasBeenSet; }
343 template <typename EmailConfigurationT = EmailConfigurationType>
344 void SetEmailConfiguration(EmailConfigurationT&& value) {
345 m_emailConfigurationHasBeenSet = true;
346 m_emailConfiguration = std::forward<EmailConfigurationT>(value);
347 }
348 template <typename EmailConfigurationT = EmailConfigurationType>
349 UpdateUserPoolRequest& WithEmailConfiguration(EmailConfigurationT&& value) {
350 SetEmailConfiguration(std::forward<EmailConfigurationT>(value));
351 return *this;
352 }
354
356
365 inline const SmsConfigurationType& GetSmsConfiguration() const { return m_smsConfiguration; }
366 inline bool SmsConfigurationHasBeenSet() const { return m_smsConfigurationHasBeenSet; }
367 template <typename SmsConfigurationT = SmsConfigurationType>
368 void SetSmsConfiguration(SmsConfigurationT&& value) {
369 m_smsConfigurationHasBeenSet = true;
370 m_smsConfiguration = std::forward<SmsConfigurationT>(value);
371 }
372 template <typename SmsConfigurationT = SmsConfigurationType>
373 UpdateUserPoolRequest& WithSmsConfiguration(SmsConfigurationT&& value) {
374 SetSmsConfiguration(std::forward<SmsConfigurationT>(value));
375 return *this;
376 }
378
380
385 inline const Aws::Map<Aws::String, Aws::String>& GetUserPoolTags() const { return m_userPoolTags; }
386 inline bool UserPoolTagsHasBeenSet() const { return m_userPoolTagsHasBeenSet; }
387 template <typename UserPoolTagsT = Aws::Map<Aws::String, Aws::String>>
388 void SetUserPoolTags(UserPoolTagsT&& value) {
389 m_userPoolTagsHasBeenSet = true;
390 m_userPoolTags = std::forward<UserPoolTagsT>(value);
391 }
392 template <typename UserPoolTagsT = Aws::Map<Aws::String, Aws::String>>
393 UpdateUserPoolRequest& WithUserPoolTags(UserPoolTagsT&& value) {
394 SetUserPoolTags(std::forward<UserPoolTagsT>(value));
395 return *this;
396 }
397 template <typename UserPoolTagsKeyT = Aws::String, typename UserPoolTagsValueT = Aws::String>
398 UpdateUserPoolRequest& AddUserPoolTags(UserPoolTagsKeyT&& key, UserPoolTagsValueT&& value) {
399 m_userPoolTagsHasBeenSet = true;
400 m_userPoolTags.emplace(std::forward<UserPoolTagsKeyT>(key), std::forward<UserPoolTagsValueT>(value));
401 return *this;
402 }
404
406
411 inline const AdminCreateUserConfigType& GetAdminCreateUserConfig() const { return m_adminCreateUserConfig; }
412 inline bool AdminCreateUserConfigHasBeenSet() const { return m_adminCreateUserConfigHasBeenSet; }
413 template <typename AdminCreateUserConfigT = AdminCreateUserConfigType>
414 void SetAdminCreateUserConfig(AdminCreateUserConfigT&& value) {
415 m_adminCreateUserConfigHasBeenSet = true;
416 m_adminCreateUserConfig = std::forward<AdminCreateUserConfigT>(value);
417 }
418 template <typename AdminCreateUserConfigT = AdminCreateUserConfigType>
419 UpdateUserPoolRequest& WithAdminCreateUserConfig(AdminCreateUserConfigT&& value) {
420 SetAdminCreateUserConfig(std::forward<AdminCreateUserConfigT>(value));
421 return *this;
422 }
424
426
438 inline const UserPoolAddOnsType& GetUserPoolAddOns() const { return m_userPoolAddOns; }
439 inline bool UserPoolAddOnsHasBeenSet() const { return m_userPoolAddOnsHasBeenSet; }
440 template <typename UserPoolAddOnsT = UserPoolAddOnsType>
441 void SetUserPoolAddOns(UserPoolAddOnsT&& value) {
442 m_userPoolAddOnsHasBeenSet = true;
443 m_userPoolAddOns = std::forward<UserPoolAddOnsT>(value);
444 }
445 template <typename UserPoolAddOnsT = UserPoolAddOnsType>
446 UpdateUserPoolRequest& WithUserPoolAddOns(UserPoolAddOnsT&& value) {
447 SetUserPoolAddOns(std::forward<UserPoolAddOnsT>(value));
448 return *this;
449 }
451
453
462 inline const AccountRecoverySettingType& GetAccountRecoverySetting() const { return m_accountRecoverySetting; }
463 inline bool AccountRecoverySettingHasBeenSet() const { return m_accountRecoverySettingHasBeenSet; }
464 template <typename AccountRecoverySettingT = AccountRecoverySettingType>
465 void SetAccountRecoverySetting(AccountRecoverySettingT&& value) {
466 m_accountRecoverySettingHasBeenSet = true;
467 m_accountRecoverySetting = std::forward<AccountRecoverySettingT>(value);
468 }
469 template <typename AccountRecoverySettingT = AccountRecoverySettingType>
470 UpdateUserPoolRequest& WithAccountRecoverySetting(AccountRecoverySettingT&& value) {
471 SetAccountRecoverySetting(std::forward<AccountRecoverySettingT>(value));
472 return *this;
473 }
475
477
480 inline const Aws::String& GetPoolName() const { return m_poolName; }
481 inline bool PoolNameHasBeenSet() const { return m_poolNameHasBeenSet; }
482 template <typename PoolNameT = Aws::String>
483 void SetPoolName(PoolNameT&& value) {
484 m_poolNameHasBeenSet = true;
485 m_poolName = std::forward<PoolNameT>(value);
486 }
487 template <typename PoolNameT = Aws::String>
489 SetPoolName(std::forward<PoolNameT>(value));
490 return *this;
491 }
493
495
502 inline UserPoolTierType GetUserPoolTier() const { return m_userPoolTier; }
503 inline bool UserPoolTierHasBeenSet() const { return m_userPoolTierHasBeenSet; }
505 m_userPoolTierHasBeenSet = true;
506 m_userPoolTier = value;
507 }
509 SetUserPoolTier(value);
510 return *this;
511 }
513 private:
514 Aws::String m_userPoolId;
515
516 UserPoolPolicyType m_policies;
517
519
520 LambdaConfigType m_lambdaConfig;
521
522 Aws::Vector<VerifiedAttributeType> m_autoVerifiedAttributes;
523
524 Aws::String m_smsVerificationMessage;
525
526 Aws::String m_emailVerificationMessage;
527
528 Aws::String m_emailVerificationSubject;
529
530 VerificationMessageTemplateType m_verificationMessageTemplate;
531
532 Aws::String m_smsAuthenticationMessage;
533
534 UserAttributeUpdateSettingsType m_userAttributeUpdateSettings;
535
536 UserPoolMfaType m_mfaConfiguration{UserPoolMfaType::NOT_SET};
537
538 DeviceConfigurationType m_deviceConfiguration;
539
540 EmailConfigurationType m_emailConfiguration;
541
542 SmsConfigurationType m_smsConfiguration;
543
545
546 AdminCreateUserConfigType m_adminCreateUserConfig;
547
548 UserPoolAddOnsType m_userPoolAddOns;
549
550 AccountRecoverySettingType m_accountRecoverySetting;
551
552 Aws::String m_poolName;
553
555 bool m_userPoolIdHasBeenSet = false;
556 bool m_policiesHasBeenSet = false;
557 bool m_deletionProtectionHasBeenSet = false;
558 bool m_lambdaConfigHasBeenSet = false;
559 bool m_autoVerifiedAttributesHasBeenSet = false;
560 bool m_smsVerificationMessageHasBeenSet = false;
561 bool m_emailVerificationMessageHasBeenSet = false;
562 bool m_emailVerificationSubjectHasBeenSet = false;
563 bool m_verificationMessageTemplateHasBeenSet = false;
564 bool m_smsAuthenticationMessageHasBeenSet = false;
565 bool m_userAttributeUpdateSettingsHasBeenSet = false;
566 bool m_mfaConfigurationHasBeenSet = false;
567 bool m_deviceConfigurationHasBeenSet = false;
568 bool m_emailConfigurationHasBeenSet = false;
569 bool m_smsConfigurationHasBeenSet = false;
570 bool m_userPoolTagsHasBeenSet = false;
571 bool m_adminCreateUserConfigHasBeenSet = false;
572 bool m_userPoolAddOnsHasBeenSet = false;
573 bool m_accountRecoverySettingHasBeenSet = false;
574 bool m_poolNameHasBeenSet = false;
575 bool m_userPoolTierHasBeenSet = false;
576};
577
578} // namespace Model
579} // namespace CognitoIdentityProvider
580} // 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