AWS SDK for C++

AWS SDK for C++ Version 1.11.750

Loading...
Searching...
No Matches
UpdateUserPoolClientRequest.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/AnalyticsConfigurationType.h>
10#include <aws/cognito-idp/model/ExplicitAuthFlowsType.h>
11#include <aws/cognito-idp/model/OAuthFlowType.h>
12#include <aws/cognito-idp/model/PreventUserExistenceErrorTypes.h>
13#include <aws/cognito-idp/model/RefreshTokenRotationType.h>
14#include <aws/cognito-idp/model/TokenValidityUnitsType.h>
15#include <aws/core/utils/memory/stl/AWSString.h>
16#include <aws/core/utils/memory/stl/AWSVector.h>
17
18#include <utility>
19
20namespace Aws {
21namespace CognitoIdentityProvider {
22namespace Model {
23
31 public:
32 AWS_COGNITOIDENTITYPROVIDER_API UpdateUserPoolClientRequest() = default;
33
34 // Service request name is the Operation name which will send this request out,
35 // each operation should has unique request name, so that we can get operation's name from this request.
36 // Note: this is not true for response, multiple operations may have the same response name,
37 // so we can not get operation's name from response.
38 inline virtual const char* GetServiceRequestName() const override { return "UpdateUserPoolClient"; }
39
40 AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override;
41
42 AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
43
45
48 inline const Aws::String& GetUserPoolId() const { return m_userPoolId; }
49 inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; }
50 template <typename UserPoolIdT = Aws::String>
51 void SetUserPoolId(UserPoolIdT&& value) {
52 m_userPoolIdHasBeenSet = true;
53 m_userPoolId = std::forward<UserPoolIdT>(value);
54 }
55 template <typename UserPoolIdT = Aws::String>
57 SetUserPoolId(std::forward<UserPoolIdT>(value));
58 return *this;
59 }
61
63
66 inline const Aws::String& GetClientId() const { return m_clientId; }
67 inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; }
68 template <typename ClientIdT = Aws::String>
69 void SetClientId(ClientIdT&& value) {
70 m_clientIdHasBeenSet = true;
71 m_clientId = std::forward<ClientIdT>(value);
72 }
73 template <typename ClientIdT = Aws::String>
75 SetClientId(std::forward<ClientIdT>(value));
76 return *this;
77 }
79
81
84 inline const Aws::String& GetClientName() const { return m_clientName; }
85 inline bool ClientNameHasBeenSet() const { return m_clientNameHasBeenSet; }
86 template <typename ClientNameT = Aws::String>
87 void SetClientName(ClientNameT&& value) {
88 m_clientNameHasBeenSet = true;
89 m_clientName = std::forward<ClientNameT>(value);
90 }
91 template <typename ClientNameT = Aws::String>
93 SetClientName(std::forward<ClientNameT>(value));
94 return *this;
95 }
97
99
115 inline int GetRefreshTokenValidity() const { return m_refreshTokenValidity; }
116 inline bool RefreshTokenValidityHasBeenSet() const { return m_refreshTokenValidityHasBeenSet; }
117 inline void SetRefreshTokenValidity(int value) {
118 m_refreshTokenValidityHasBeenSet = true;
119 m_refreshTokenValidity = value;
120 }
123 return *this;
124 }
126
128
141 inline int GetAccessTokenValidity() const { return m_accessTokenValidity; }
142 inline bool AccessTokenValidityHasBeenSet() const { return m_accessTokenValidityHasBeenSet; }
143 inline void SetAccessTokenValidity(int value) {
144 m_accessTokenValidityHasBeenSet = true;
145 m_accessTokenValidity = value;
146 }
149 return *this;
150 }
152
154
167 inline int GetIdTokenValidity() const { return m_idTokenValidity; }
168 inline bool IdTokenValidityHasBeenSet() const { return m_idTokenValidityHasBeenSet; }
169 inline void SetIdTokenValidity(int value) {
170 m_idTokenValidityHasBeenSet = true;
171 m_idTokenValidity = value;
172 }
174 SetIdTokenValidity(value);
175 return *this;
176 }
178
180
184 inline const TokenValidityUnitsType& GetTokenValidityUnits() const { return m_tokenValidityUnits; }
185 inline bool TokenValidityUnitsHasBeenSet() const { return m_tokenValidityUnitsHasBeenSet; }
186 template <typename TokenValidityUnitsT = TokenValidityUnitsType>
187 void SetTokenValidityUnits(TokenValidityUnitsT&& value) {
188 m_tokenValidityUnitsHasBeenSet = true;
189 m_tokenValidityUnits = std::forward<TokenValidityUnitsT>(value);
190 }
191 template <typename TokenValidityUnitsT = TokenValidityUnitsType>
193 SetTokenValidityUnits(std::forward<TokenValidityUnitsT>(value));
194 return *this;
195 }
197
199
211 inline const Aws::Vector<Aws::String>& GetReadAttributes() const { return m_readAttributes; }
212 inline bool ReadAttributesHasBeenSet() const { return m_readAttributesHasBeenSet; }
213 template <typename ReadAttributesT = Aws::Vector<Aws::String>>
214 void SetReadAttributes(ReadAttributesT&& value) {
215 m_readAttributesHasBeenSet = true;
216 m_readAttributes = std::forward<ReadAttributesT>(value);
217 }
218 template <typename ReadAttributesT = Aws::Vector<Aws::String>>
220 SetReadAttributes(std::forward<ReadAttributesT>(value));
221 return *this;
222 }
223 template <typename ReadAttributesT = Aws::String>
225 m_readAttributesHasBeenSet = true;
226 m_readAttributes.emplace_back(std::forward<ReadAttributesT>(value));
227 return *this;
228 }
230
232
250 inline const Aws::Vector<Aws::String>& GetWriteAttributes() const { return m_writeAttributes; }
251 inline bool WriteAttributesHasBeenSet() const { return m_writeAttributesHasBeenSet; }
252 template <typename WriteAttributesT = Aws::Vector<Aws::String>>
253 void SetWriteAttributes(WriteAttributesT&& value) {
254 m_writeAttributesHasBeenSet = true;
255 m_writeAttributes = std::forward<WriteAttributesT>(value);
256 }
257 template <typename WriteAttributesT = Aws::Vector<Aws::String>>
259 SetWriteAttributes(std::forward<WriteAttributesT>(value));
260 return *this;
261 }
262 template <typename WriteAttributesT = Aws::String>
264 m_writeAttributesHasBeenSet = true;
265 m_writeAttributes.emplace_back(std::forward<WriteAttributesT>(value));
266 return *this;
267 }
269
271
313 inline const Aws::Vector<ExplicitAuthFlowsType>& GetExplicitAuthFlows() const { return m_explicitAuthFlows; }
314 inline bool ExplicitAuthFlowsHasBeenSet() const { return m_explicitAuthFlowsHasBeenSet; }
315 template <typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
316 void SetExplicitAuthFlows(ExplicitAuthFlowsT&& value) {
317 m_explicitAuthFlowsHasBeenSet = true;
318 m_explicitAuthFlows = std::forward<ExplicitAuthFlowsT>(value);
319 }
320 template <typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
322 SetExplicitAuthFlows(std::forward<ExplicitAuthFlowsT>(value));
323 return *this;
324 }
326 m_explicitAuthFlowsHasBeenSet = true;
327 m_explicitAuthFlows.push_back(value);
328 return *this;
329 }
331
333
348 inline const Aws::Vector<Aws::String>& GetSupportedIdentityProviders() const { return m_supportedIdentityProviders; }
349 inline bool SupportedIdentityProvidersHasBeenSet() const { return m_supportedIdentityProvidersHasBeenSet; }
350 template <typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
351 void SetSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
352 m_supportedIdentityProvidersHasBeenSet = true;
353 m_supportedIdentityProviders = std::forward<SupportedIdentityProvidersT>(value);
354 }
355 template <typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
356 UpdateUserPoolClientRequest& WithSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
357 SetSupportedIdentityProviders(std::forward<SupportedIdentityProvidersT>(value));
358 return *this;
359 }
360 template <typename SupportedIdentityProvidersT = Aws::String>
361 UpdateUserPoolClientRequest& AddSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
362 m_supportedIdentityProvidersHasBeenSet = true;
363 m_supportedIdentityProviders.emplace_back(std::forward<SupportedIdentityProvidersT>(value));
364 return *this;
365 }
367
369
385 inline const Aws::Vector<Aws::String>& GetCallbackURLs() const { return m_callbackURLs; }
386 inline bool CallbackURLsHasBeenSet() const { return m_callbackURLsHasBeenSet; }
387 template <typename CallbackURLsT = Aws::Vector<Aws::String>>
388 void SetCallbackURLs(CallbackURLsT&& value) {
389 m_callbackURLsHasBeenSet = true;
390 m_callbackURLs = std::forward<CallbackURLsT>(value);
391 }
392 template <typename CallbackURLsT = Aws::Vector<Aws::String>>
394 SetCallbackURLs(std::forward<CallbackURLsT>(value));
395 return *this;
396 }
397 template <typename CallbackURLsT = Aws::String>
399 m_callbackURLsHasBeenSet = true;
400 m_callbackURLs.emplace_back(std::forward<CallbackURLsT>(value));
401 return *this;
402 }
404
406
417 inline const Aws::Vector<Aws::String>& GetLogoutURLs() const { return m_logoutURLs; }
418 inline bool LogoutURLsHasBeenSet() const { return m_logoutURLsHasBeenSet; }
419 template <typename LogoutURLsT = Aws::Vector<Aws::String>>
420 void SetLogoutURLs(LogoutURLsT&& value) {
421 m_logoutURLsHasBeenSet = true;
422 m_logoutURLs = std::forward<LogoutURLsT>(value);
423 }
424 template <typename LogoutURLsT = Aws::Vector<Aws::String>>
426 SetLogoutURLs(std::forward<LogoutURLsT>(value));
427 return *this;
428 }
429 template <typename LogoutURLsT = Aws::String>
431 m_logoutURLsHasBeenSet = true;
432 m_logoutURLs.emplace_back(std::forward<LogoutURLsT>(value));
433 return *this;
434 }
436
438
443 inline const Aws::String& GetDefaultRedirectURI() const { return m_defaultRedirectURI; }
444 inline bool DefaultRedirectURIHasBeenSet() const { return m_defaultRedirectURIHasBeenSet; }
445 template <typename DefaultRedirectURIT = Aws::String>
446 void SetDefaultRedirectURI(DefaultRedirectURIT&& value) {
447 m_defaultRedirectURIHasBeenSet = true;
448 m_defaultRedirectURI = std::forward<DefaultRedirectURIT>(value);
449 }
450 template <typename DefaultRedirectURIT = Aws::String>
452 SetDefaultRedirectURI(std::forward<DefaultRedirectURIT>(value));
453 return *this;
454 }
456
458
470 inline const Aws::Vector<OAuthFlowType>& GetAllowedOAuthFlows() const { return m_allowedOAuthFlows; }
471 inline bool AllowedOAuthFlowsHasBeenSet() const { return m_allowedOAuthFlowsHasBeenSet; }
472 template <typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
473 void SetAllowedOAuthFlows(AllowedOAuthFlowsT&& value) {
474 m_allowedOAuthFlowsHasBeenSet = true;
475 m_allowedOAuthFlows = std::forward<AllowedOAuthFlowsT>(value);
476 }
477 template <typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
479 SetAllowedOAuthFlows(std::forward<AllowedOAuthFlowsT>(value));
480 return *this;
481 }
483 m_allowedOAuthFlowsHasBeenSet = true;
484 m_allowedOAuthFlows.push_back(value);
485 return *this;
486 }
488
490
500 inline const Aws::Vector<Aws::String>& GetAllowedOAuthScopes() const { return m_allowedOAuthScopes; }
501 inline bool AllowedOAuthScopesHasBeenSet() const { return m_allowedOAuthScopesHasBeenSet; }
502 template <typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
503 void SetAllowedOAuthScopes(AllowedOAuthScopesT&& value) {
504 m_allowedOAuthScopesHasBeenSet = true;
505 m_allowedOAuthScopes = std::forward<AllowedOAuthScopesT>(value);
506 }
507 template <typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
509 SetAllowedOAuthScopes(std::forward<AllowedOAuthScopesT>(value));
510 return *this;
511 }
512 template <typename AllowedOAuthScopesT = Aws::String>
514 m_allowedOAuthScopesHasBeenSet = true;
515 m_allowedOAuthScopes.emplace_back(std::forward<AllowedOAuthScopesT>(value));
516 return *this;
517 }
519
521
538 inline bool GetAllowedOAuthFlowsUserPoolClient() const { return m_allowedOAuthFlowsUserPoolClient; }
539 inline bool AllowedOAuthFlowsUserPoolClientHasBeenSet() const { return m_allowedOAuthFlowsUserPoolClientHasBeenSet; }
540 inline void SetAllowedOAuthFlowsUserPoolClient(bool value) {
541 m_allowedOAuthFlowsUserPoolClientHasBeenSet = true;
542 m_allowedOAuthFlowsUserPoolClient = value;
543 }
546 return *this;
547 }
549
551
560 inline const AnalyticsConfigurationType& GetAnalyticsConfiguration() const { return m_analyticsConfiguration; }
561 inline bool AnalyticsConfigurationHasBeenSet() const { return m_analyticsConfigurationHasBeenSet; }
562 template <typename AnalyticsConfigurationT = AnalyticsConfigurationType>
563 void SetAnalyticsConfiguration(AnalyticsConfigurationT&& value) {
564 m_analyticsConfigurationHasBeenSet = true;
565 m_analyticsConfiguration = std::forward<AnalyticsConfigurationT>(value);
566 }
567 template <typename AnalyticsConfigurationT = AnalyticsConfigurationType>
568 UpdateUserPoolClientRequest& WithAnalyticsConfiguration(AnalyticsConfigurationT&& value) {
569 SetAnalyticsConfiguration(std::forward<AnalyticsConfigurationT>(value));
570 return *this;
571 }
573
575
588 inline PreventUserExistenceErrorTypes GetPreventUserExistenceErrors() const { return m_preventUserExistenceErrors; }
589 inline bool PreventUserExistenceErrorsHasBeenSet() const { return m_preventUserExistenceErrorsHasBeenSet; }
591 m_preventUserExistenceErrorsHasBeenSet = true;
592 m_preventUserExistenceErrors = value;
593 }
596 return *this;
597 }
599
601
606 inline bool GetEnableTokenRevocation() const { return m_enableTokenRevocation; }
607 inline bool EnableTokenRevocationHasBeenSet() const { return m_enableTokenRevocationHasBeenSet; }
608 inline void SetEnableTokenRevocation(bool value) {
609 m_enableTokenRevocationHasBeenSet = true;
610 m_enableTokenRevocation = value;
611 }
614 return *this;
615 }
617
619
630 inline bool GetEnablePropagateAdditionalUserContextData() const { return m_enablePropagateAdditionalUserContextData; }
631 inline bool EnablePropagateAdditionalUserContextDataHasBeenSet() const { return m_enablePropagateAdditionalUserContextDataHasBeenSet; }
633 m_enablePropagateAdditionalUserContextDataHasBeenSet = true;
634 m_enablePropagateAdditionalUserContextData = value;
635 }
638 return *this;
639 }
641
643
649 inline int GetAuthSessionValidity() const { return m_authSessionValidity; }
650 inline bool AuthSessionValidityHasBeenSet() const { return m_authSessionValidityHasBeenSet; }
651 inline void SetAuthSessionValidity(int value) {
652 m_authSessionValidityHasBeenSet = true;
653 m_authSessionValidity = value;
654 }
657 return *this;
658 }
660
662
668 inline const RefreshTokenRotationType& GetRefreshTokenRotation() const { return m_refreshTokenRotation; }
669 inline bool RefreshTokenRotationHasBeenSet() const { return m_refreshTokenRotationHasBeenSet; }
670 template <typename RefreshTokenRotationT = RefreshTokenRotationType>
671 void SetRefreshTokenRotation(RefreshTokenRotationT&& value) {
672 m_refreshTokenRotationHasBeenSet = true;
673 m_refreshTokenRotation = std::forward<RefreshTokenRotationT>(value);
674 }
675 template <typename RefreshTokenRotationT = RefreshTokenRotationType>
677 SetRefreshTokenRotation(std::forward<RefreshTokenRotationT>(value));
678 return *this;
679 }
681 private:
682 Aws::String m_userPoolId;
683
684 Aws::String m_clientId;
685
686 Aws::String m_clientName;
687
688 int m_refreshTokenValidity{0};
689
690 int m_accessTokenValidity{0};
691
692 int m_idTokenValidity{0};
693
694 TokenValidityUnitsType m_tokenValidityUnits;
695
696 Aws::Vector<Aws::String> m_readAttributes;
697
698 Aws::Vector<Aws::String> m_writeAttributes;
699
700 Aws::Vector<ExplicitAuthFlowsType> m_explicitAuthFlows;
701
702 Aws::Vector<Aws::String> m_supportedIdentityProviders;
703
704 Aws::Vector<Aws::String> m_callbackURLs;
705
706 Aws::Vector<Aws::String> m_logoutURLs;
707
708 Aws::String m_defaultRedirectURI;
709
710 Aws::Vector<OAuthFlowType> m_allowedOAuthFlows;
711
712 Aws::Vector<Aws::String> m_allowedOAuthScopes;
713
714 bool m_allowedOAuthFlowsUserPoolClient{false};
715
716 AnalyticsConfigurationType m_analyticsConfiguration;
717
719
720 bool m_enableTokenRevocation{false};
721
722 bool m_enablePropagateAdditionalUserContextData{false};
723
724 int m_authSessionValidity{0};
725
726 RefreshTokenRotationType m_refreshTokenRotation;
727 bool m_userPoolIdHasBeenSet = false;
728 bool m_clientIdHasBeenSet = false;
729 bool m_clientNameHasBeenSet = false;
730 bool m_refreshTokenValidityHasBeenSet = false;
731 bool m_accessTokenValidityHasBeenSet = false;
732 bool m_idTokenValidityHasBeenSet = false;
733 bool m_tokenValidityUnitsHasBeenSet = false;
734 bool m_readAttributesHasBeenSet = false;
735 bool m_writeAttributesHasBeenSet = false;
736 bool m_explicitAuthFlowsHasBeenSet = false;
737 bool m_supportedIdentityProvidersHasBeenSet = false;
738 bool m_callbackURLsHasBeenSet = false;
739 bool m_logoutURLsHasBeenSet = false;
740 bool m_defaultRedirectURIHasBeenSet = false;
741 bool m_allowedOAuthFlowsHasBeenSet = false;
742 bool m_allowedOAuthScopesHasBeenSet = false;
743 bool m_allowedOAuthFlowsUserPoolClientHasBeenSet = false;
744 bool m_analyticsConfigurationHasBeenSet = false;
745 bool m_preventUserExistenceErrorsHasBeenSet = false;
746 bool m_enableTokenRevocationHasBeenSet = false;
747 bool m_enablePropagateAdditionalUserContextDataHasBeenSet = false;
748 bool m_authSessionValidityHasBeenSet = false;
749 bool m_refreshTokenRotationHasBeenSet = false;
750};
751
752} // namespace Model
753} // namespace CognitoIdentityProvider
754} // namespace Aws
UpdateUserPoolClientRequest & WithExplicitAuthFlows(ExplicitAuthFlowsT &&value)
UpdateUserPoolClientRequest & AddReadAttributes(ReadAttributesT &&value)
UpdateUserPoolClientRequest & WithTokenValidityUnits(TokenValidityUnitsT &&value)
UpdateUserPoolClientRequest & AddSupportedIdentityProviders(SupportedIdentityProvidersT &&value)
UpdateUserPoolClientRequest & WithAllowedOAuthScopes(AllowedOAuthScopesT &&value)
UpdateUserPoolClientRequest & WithWriteAttributes(WriteAttributesT &&value)
AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override
UpdateUserPoolClientRequest & WithReadAttributes(ReadAttributesT &&value)
UpdateUserPoolClientRequest & WithRefreshTokenRotation(RefreshTokenRotationT &&value)
UpdateUserPoolClientRequest & WithDefaultRedirectURI(DefaultRedirectURIT &&value)
const Aws::Vector< ExplicitAuthFlowsType > & GetExplicitAuthFlows() const
UpdateUserPoolClientRequest & WithCallbackURLs(CallbackURLsT &&value)
UpdateUserPoolClientRequest & AddWriteAttributes(WriteAttributesT &&value)
UpdateUserPoolClientRequest & AddAllowedOAuthScopes(AllowedOAuthScopesT &&value)
UpdateUserPoolClientRequest & AddAllowedOAuthFlows(OAuthFlowType value)
UpdateUserPoolClientRequest & WithLogoutURLs(LogoutURLsT &&value)
UpdateUserPoolClientRequest & AddExplicitAuthFlows(ExplicitAuthFlowsType value)
UpdateUserPoolClientRequest & WithAnalyticsConfiguration(AnalyticsConfigurationT &&value)
AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
UpdateUserPoolClientRequest & WithAllowedOAuthFlows(AllowedOAuthFlowsT &&value)
UpdateUserPoolClientRequest & WithSupportedIdentityProviders(SupportedIdentityProvidersT &&value)
UpdateUserPoolClientRequest & WithPreventUserExistenceErrors(PreventUserExistenceErrorTypes value)
UpdateUserPoolClientRequest & WithEnablePropagateAdditionalUserContextData(bool value)
AWS_COGNITOIDENTITYPROVIDER_API UpdateUserPoolClientRequest()=default
UpdateUserPoolClientRequest & WithClientName(ClientNameT &&value)
UpdateUserPoolClientRequest & AddLogoutURLs(LogoutURLsT &&value)
UpdateUserPoolClientRequest & AddCallbackURLs(CallbackURLsT &&value)
UpdateUserPoolClientRequest & WithUserPoolId(UserPoolIdT &&value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector