AWS SDK for C++

AWS SDK for C++ Version 1.11.789

Loading...
Searching...
No Matches
CreateUserPoolClientRequest.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 CreateUserPoolClientRequest() = 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 "CreateUserPoolClient"; }
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& GetClientName() const { return m_clientName; }
67 inline bool ClientNameHasBeenSet() const { return m_clientNameHasBeenSet; }
68 template <typename ClientNameT = Aws::String>
69 void SetClientName(ClientNameT&& value) {
70 m_clientNameHasBeenSet = true;
71 m_clientName = std::forward<ClientNameT>(value);
72 }
73 template <typename ClientNameT = Aws::String>
75 SetClientName(std::forward<ClientNameT>(value));
76 return *this;
77 }
79
81
89 inline bool GetGenerateSecret() const { return m_generateSecret; }
90 inline bool GenerateSecretHasBeenSet() const { return m_generateSecretHasBeenSet; }
91 inline void SetGenerateSecret(bool value) {
92 m_generateSecretHasBeenSet = true;
93 m_generateSecret = value;
94 }
96 SetGenerateSecret(value);
97 return *this;
98 }
100
102
106 inline const Aws::String& GetClientSecret() const { return m_clientSecret; }
107 inline bool ClientSecretHasBeenSet() const { return m_clientSecretHasBeenSet; }
108 template <typename ClientSecretT = Aws::String>
109 void SetClientSecret(ClientSecretT&& value) {
110 m_clientSecretHasBeenSet = true;
111 m_clientSecret = std::forward<ClientSecretT>(value);
112 }
113 template <typename ClientSecretT = Aws::String>
115 SetClientSecret(std::forward<ClientSecretT>(value));
116 return *this;
117 }
119
121
137 inline int GetRefreshTokenValidity() const { return m_refreshTokenValidity; }
138 inline bool RefreshTokenValidityHasBeenSet() const { return m_refreshTokenValidityHasBeenSet; }
139 inline void SetRefreshTokenValidity(int value) {
140 m_refreshTokenValidityHasBeenSet = true;
141 m_refreshTokenValidity = value;
142 }
145 return *this;
146 }
148
150
163 inline int GetAccessTokenValidity() const { return m_accessTokenValidity; }
164 inline bool AccessTokenValidityHasBeenSet() const { return m_accessTokenValidityHasBeenSet; }
165 inline void SetAccessTokenValidity(int value) {
166 m_accessTokenValidityHasBeenSet = true;
167 m_accessTokenValidity = value;
168 }
171 return *this;
172 }
174
176
189 inline int GetIdTokenValidity() const { return m_idTokenValidity; }
190 inline bool IdTokenValidityHasBeenSet() const { return m_idTokenValidityHasBeenSet; }
191 inline void SetIdTokenValidity(int value) {
192 m_idTokenValidityHasBeenSet = true;
193 m_idTokenValidity = value;
194 }
196 SetIdTokenValidity(value);
197 return *this;
198 }
200
202
206 inline const TokenValidityUnitsType& GetTokenValidityUnits() const { return m_tokenValidityUnits; }
207 inline bool TokenValidityUnitsHasBeenSet() const { return m_tokenValidityUnitsHasBeenSet; }
208 template <typename TokenValidityUnitsT = TokenValidityUnitsType>
209 void SetTokenValidityUnits(TokenValidityUnitsT&& value) {
210 m_tokenValidityUnitsHasBeenSet = true;
211 m_tokenValidityUnits = std::forward<TokenValidityUnitsT>(value);
212 }
213 template <typename TokenValidityUnitsT = TokenValidityUnitsType>
215 SetTokenValidityUnits(std::forward<TokenValidityUnitsT>(value));
216 return *this;
217 }
219
221
233 inline const Aws::Vector<Aws::String>& GetReadAttributes() const { return m_readAttributes; }
234 inline bool ReadAttributesHasBeenSet() const { return m_readAttributesHasBeenSet; }
235 template <typename ReadAttributesT = Aws::Vector<Aws::String>>
236 void SetReadAttributes(ReadAttributesT&& value) {
237 m_readAttributesHasBeenSet = true;
238 m_readAttributes = std::forward<ReadAttributesT>(value);
239 }
240 template <typename ReadAttributesT = Aws::Vector<Aws::String>>
242 SetReadAttributes(std::forward<ReadAttributesT>(value));
243 return *this;
244 }
245 template <typename ReadAttributesT = Aws::String>
247 m_readAttributesHasBeenSet = true;
248 m_readAttributes.emplace_back(std::forward<ReadAttributesT>(value));
249 return *this;
250 }
252
254
272 inline const Aws::Vector<Aws::String>& GetWriteAttributes() const { return m_writeAttributes; }
273 inline bool WriteAttributesHasBeenSet() const { return m_writeAttributesHasBeenSet; }
274 template <typename WriteAttributesT = Aws::Vector<Aws::String>>
275 void SetWriteAttributes(WriteAttributesT&& value) {
276 m_writeAttributesHasBeenSet = true;
277 m_writeAttributes = std::forward<WriteAttributesT>(value);
278 }
279 template <typename WriteAttributesT = Aws::Vector<Aws::String>>
281 SetWriteAttributes(std::forward<WriteAttributesT>(value));
282 return *this;
283 }
284 template <typename WriteAttributesT = Aws::String>
286 m_writeAttributesHasBeenSet = true;
287 m_writeAttributes.emplace_back(std::forward<WriteAttributesT>(value));
288 return *this;
289 }
291
293
335 inline const Aws::Vector<ExplicitAuthFlowsType>& GetExplicitAuthFlows() const { return m_explicitAuthFlows; }
336 inline bool ExplicitAuthFlowsHasBeenSet() const { return m_explicitAuthFlowsHasBeenSet; }
337 template <typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
338 void SetExplicitAuthFlows(ExplicitAuthFlowsT&& value) {
339 m_explicitAuthFlowsHasBeenSet = true;
340 m_explicitAuthFlows = std::forward<ExplicitAuthFlowsT>(value);
341 }
342 template <typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
344 SetExplicitAuthFlows(std::forward<ExplicitAuthFlowsT>(value));
345 return *this;
346 }
348 m_explicitAuthFlowsHasBeenSet = true;
349 m_explicitAuthFlows.push_back(value);
350 return *this;
351 }
353
355
370 inline const Aws::Vector<Aws::String>& GetSupportedIdentityProviders() const { return m_supportedIdentityProviders; }
371 inline bool SupportedIdentityProvidersHasBeenSet() const { return m_supportedIdentityProvidersHasBeenSet; }
372 template <typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
373 void SetSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
374 m_supportedIdentityProvidersHasBeenSet = true;
375 m_supportedIdentityProviders = std::forward<SupportedIdentityProvidersT>(value);
376 }
377 template <typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
378 CreateUserPoolClientRequest& WithSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
379 SetSupportedIdentityProviders(std::forward<SupportedIdentityProvidersT>(value));
380 return *this;
381 }
382 template <typename SupportedIdentityProvidersT = Aws::String>
383 CreateUserPoolClientRequest& AddSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
384 m_supportedIdentityProvidersHasBeenSet = true;
385 m_supportedIdentityProviders.emplace_back(std::forward<SupportedIdentityProvidersT>(value));
386 return *this;
387 }
389
391
409 inline const Aws::Vector<Aws::String>& GetCallbackURLs() const { return m_callbackURLs; }
410 inline bool CallbackURLsHasBeenSet() const { return m_callbackURLsHasBeenSet; }
411 template <typename CallbackURLsT = Aws::Vector<Aws::String>>
412 void SetCallbackURLs(CallbackURLsT&& value) {
413 m_callbackURLsHasBeenSet = true;
414 m_callbackURLs = std::forward<CallbackURLsT>(value);
415 }
416 template <typename CallbackURLsT = Aws::Vector<Aws::String>>
418 SetCallbackURLs(std::forward<CallbackURLsT>(value));
419 return *this;
420 }
421 template <typename CallbackURLsT = Aws::String>
423 m_callbackURLsHasBeenSet = true;
424 m_callbackURLs.emplace_back(std::forward<CallbackURLsT>(value));
425 return *this;
426 }
428
430
441 inline const Aws::Vector<Aws::String>& GetLogoutURLs() const { return m_logoutURLs; }
442 inline bool LogoutURLsHasBeenSet() const { return m_logoutURLsHasBeenSet; }
443 template <typename LogoutURLsT = Aws::Vector<Aws::String>>
444 void SetLogoutURLs(LogoutURLsT&& value) {
445 m_logoutURLsHasBeenSet = true;
446 m_logoutURLs = std::forward<LogoutURLsT>(value);
447 }
448 template <typename LogoutURLsT = Aws::Vector<Aws::String>>
450 SetLogoutURLs(std::forward<LogoutURLsT>(value));
451 return *this;
452 }
453 template <typename LogoutURLsT = Aws::String>
455 m_logoutURLsHasBeenSet = true;
456 m_logoutURLs.emplace_back(std::forward<LogoutURLsT>(value));
457 return *this;
458 }
460
462
467 inline const Aws::String& GetDefaultRedirectURI() const { return m_defaultRedirectURI; }
468 inline bool DefaultRedirectURIHasBeenSet() const { return m_defaultRedirectURIHasBeenSet; }
469 template <typename DefaultRedirectURIT = Aws::String>
470 void SetDefaultRedirectURI(DefaultRedirectURIT&& value) {
471 m_defaultRedirectURIHasBeenSet = true;
472 m_defaultRedirectURI = std::forward<DefaultRedirectURIT>(value);
473 }
474 template <typename DefaultRedirectURIT = Aws::String>
476 SetDefaultRedirectURI(std::forward<DefaultRedirectURIT>(value));
477 return *this;
478 }
480
482
495 inline const Aws::Vector<OAuthFlowType>& GetAllowedOAuthFlows() const { return m_allowedOAuthFlows; }
496 inline bool AllowedOAuthFlowsHasBeenSet() const { return m_allowedOAuthFlowsHasBeenSet; }
497 template <typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
498 void SetAllowedOAuthFlows(AllowedOAuthFlowsT&& value) {
499 m_allowedOAuthFlowsHasBeenSet = true;
500 m_allowedOAuthFlows = std::forward<AllowedOAuthFlowsT>(value);
501 }
502 template <typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
504 SetAllowedOAuthFlows(std::forward<AllowedOAuthFlowsT>(value));
505 return *this;
506 }
508 m_allowedOAuthFlowsHasBeenSet = true;
509 m_allowedOAuthFlows.push_back(value);
510 return *this;
511 }
513
515
525 inline const Aws::Vector<Aws::String>& GetAllowedOAuthScopes() const { return m_allowedOAuthScopes; }
526 inline bool AllowedOAuthScopesHasBeenSet() const { return m_allowedOAuthScopesHasBeenSet; }
527 template <typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
528 void SetAllowedOAuthScopes(AllowedOAuthScopesT&& value) {
529 m_allowedOAuthScopesHasBeenSet = true;
530 m_allowedOAuthScopes = std::forward<AllowedOAuthScopesT>(value);
531 }
532 template <typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
534 SetAllowedOAuthScopes(std::forward<AllowedOAuthScopesT>(value));
535 return *this;
536 }
537 template <typename AllowedOAuthScopesT = Aws::String>
539 m_allowedOAuthScopesHasBeenSet = true;
540 m_allowedOAuthScopes.emplace_back(std::forward<AllowedOAuthScopesT>(value));
541 return *this;
542 }
544
546
563 inline bool GetAllowedOAuthFlowsUserPoolClient() const { return m_allowedOAuthFlowsUserPoolClient; }
564 inline bool AllowedOAuthFlowsUserPoolClientHasBeenSet() const { return m_allowedOAuthFlowsUserPoolClientHasBeenSet; }
565 inline void SetAllowedOAuthFlowsUserPoolClient(bool value) {
566 m_allowedOAuthFlowsUserPoolClientHasBeenSet = true;
567 m_allowedOAuthFlowsUserPoolClient = value;
568 }
571 return *this;
572 }
574
576
585 inline const AnalyticsConfigurationType& GetAnalyticsConfiguration() const { return m_analyticsConfiguration; }
586 inline bool AnalyticsConfigurationHasBeenSet() const { return m_analyticsConfigurationHasBeenSet; }
587 template <typename AnalyticsConfigurationT = AnalyticsConfigurationType>
588 void SetAnalyticsConfiguration(AnalyticsConfigurationT&& value) {
589 m_analyticsConfigurationHasBeenSet = true;
590 m_analyticsConfiguration = std::forward<AnalyticsConfigurationT>(value);
591 }
592 template <typename AnalyticsConfigurationT = AnalyticsConfigurationType>
593 CreateUserPoolClientRequest& WithAnalyticsConfiguration(AnalyticsConfigurationT&& value) {
594 SetAnalyticsConfiguration(std::forward<AnalyticsConfigurationT>(value));
595 return *this;
596 }
598
600
613 inline PreventUserExistenceErrorTypes GetPreventUserExistenceErrors() const { return m_preventUserExistenceErrors; }
614 inline bool PreventUserExistenceErrorsHasBeenSet() const { return m_preventUserExistenceErrorsHasBeenSet; }
616 m_preventUserExistenceErrorsHasBeenSet = true;
617 m_preventUserExistenceErrors = value;
618 }
621 return *this;
622 }
624
626
633 inline bool GetEnableTokenRevocation() const { return m_enableTokenRevocation; }
634 inline bool EnableTokenRevocationHasBeenSet() const { return m_enableTokenRevocationHasBeenSet; }
635 inline void SetEnableTokenRevocation(bool value) {
636 m_enableTokenRevocationHasBeenSet = true;
637 m_enableTokenRevocation = value;
638 }
641 return *this;
642 }
644
646
657 inline bool GetEnablePropagateAdditionalUserContextData() const { return m_enablePropagateAdditionalUserContextData; }
658 inline bool EnablePropagateAdditionalUserContextDataHasBeenSet() const { return m_enablePropagateAdditionalUserContextDataHasBeenSet; }
660 m_enablePropagateAdditionalUserContextDataHasBeenSet = true;
661 m_enablePropagateAdditionalUserContextData = value;
662 }
665 return *this;
666 }
668
670
676 inline int GetAuthSessionValidity() const { return m_authSessionValidity; }
677 inline bool AuthSessionValidityHasBeenSet() const { return m_authSessionValidityHasBeenSet; }
678 inline void SetAuthSessionValidity(int value) {
679 m_authSessionValidityHasBeenSet = true;
680 m_authSessionValidity = value;
681 }
684 return *this;
685 }
687
689
695 inline const RefreshTokenRotationType& GetRefreshTokenRotation() const { return m_refreshTokenRotation; }
696 inline bool RefreshTokenRotationHasBeenSet() const { return m_refreshTokenRotationHasBeenSet; }
697 template <typename RefreshTokenRotationT = RefreshTokenRotationType>
698 void SetRefreshTokenRotation(RefreshTokenRotationT&& value) {
699 m_refreshTokenRotationHasBeenSet = true;
700 m_refreshTokenRotation = std::forward<RefreshTokenRotationT>(value);
701 }
702 template <typename RefreshTokenRotationT = RefreshTokenRotationType>
704 SetRefreshTokenRotation(std::forward<RefreshTokenRotationT>(value));
705 return *this;
706 }
708 private:
709 Aws::String m_userPoolId;
710
711 Aws::String m_clientName;
712
713 bool m_generateSecret{false};
714
715 Aws::String m_clientSecret;
716
717 int m_refreshTokenValidity{0};
718
719 int m_accessTokenValidity{0};
720
721 int m_idTokenValidity{0};
722
723 TokenValidityUnitsType m_tokenValidityUnits;
724
725 Aws::Vector<Aws::String> m_readAttributes;
726
727 Aws::Vector<Aws::String> m_writeAttributes;
728
729 Aws::Vector<ExplicitAuthFlowsType> m_explicitAuthFlows;
730
731 Aws::Vector<Aws::String> m_supportedIdentityProviders;
732
733 Aws::Vector<Aws::String> m_callbackURLs;
734
735 Aws::Vector<Aws::String> m_logoutURLs;
736
737 Aws::String m_defaultRedirectURI;
738
739 Aws::Vector<OAuthFlowType> m_allowedOAuthFlows;
740
741 Aws::Vector<Aws::String> m_allowedOAuthScopes;
742
743 bool m_allowedOAuthFlowsUserPoolClient{false};
744
745 AnalyticsConfigurationType m_analyticsConfiguration;
746
748
749 bool m_enableTokenRevocation{false};
750
751 bool m_enablePropagateAdditionalUserContextData{false};
752
753 int m_authSessionValidity{0};
754
755 RefreshTokenRotationType m_refreshTokenRotation;
756 bool m_userPoolIdHasBeenSet = false;
757 bool m_clientNameHasBeenSet = false;
758 bool m_generateSecretHasBeenSet = false;
759 bool m_clientSecretHasBeenSet = false;
760 bool m_refreshTokenValidityHasBeenSet = false;
761 bool m_accessTokenValidityHasBeenSet = false;
762 bool m_idTokenValidityHasBeenSet = false;
763 bool m_tokenValidityUnitsHasBeenSet = false;
764 bool m_readAttributesHasBeenSet = false;
765 bool m_writeAttributesHasBeenSet = false;
766 bool m_explicitAuthFlowsHasBeenSet = false;
767 bool m_supportedIdentityProvidersHasBeenSet = false;
768 bool m_callbackURLsHasBeenSet = false;
769 bool m_logoutURLsHasBeenSet = false;
770 bool m_defaultRedirectURIHasBeenSet = false;
771 bool m_allowedOAuthFlowsHasBeenSet = false;
772 bool m_allowedOAuthScopesHasBeenSet = false;
773 bool m_allowedOAuthFlowsUserPoolClientHasBeenSet = false;
774 bool m_analyticsConfigurationHasBeenSet = false;
775 bool m_preventUserExistenceErrorsHasBeenSet = false;
776 bool m_enableTokenRevocationHasBeenSet = false;
777 bool m_enablePropagateAdditionalUserContextDataHasBeenSet = false;
778 bool m_authSessionValidityHasBeenSet = false;
779 bool m_refreshTokenRotationHasBeenSet = false;
780};
781
782} // namespace Model
783} // namespace CognitoIdentityProvider
784} // namespace Aws
const Aws::Vector< ExplicitAuthFlowsType > & GetExplicitAuthFlows() const
CreateUserPoolClientRequest & WithPreventUserExistenceErrors(PreventUserExistenceErrorTypes value)
CreateUserPoolClientRequest & WithCallbackURLs(CallbackURLsT &&value)
CreateUserPoolClientRequest & AddCallbackURLs(CallbackURLsT &&value)
CreateUserPoolClientRequest & WithSupportedIdentityProviders(SupportedIdentityProvidersT &&value)
CreateUserPoolClientRequest & WithClientName(ClientNameT &&value)
CreateUserPoolClientRequest & WithAllowedOAuthFlows(AllowedOAuthFlowsT &&value)
CreateUserPoolClientRequest & AddWriteAttributes(WriteAttributesT &&value)
CreateUserPoolClientRequest & AddReadAttributes(ReadAttributesT &&value)
CreateUserPoolClientRequest & WithAnalyticsConfiguration(AnalyticsConfigurationT &&value)
CreateUserPoolClientRequest & AddSupportedIdentityProviders(SupportedIdentityProvidersT &&value)
CreateUserPoolClientRequest & WithAllowedOAuthScopes(AllowedOAuthScopesT &&value)
AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override
CreateUserPoolClientRequest & AddExplicitAuthFlows(ExplicitAuthFlowsType value)
CreateUserPoolClientRequest & AddAllowedOAuthFlows(OAuthFlowType value)
CreateUserPoolClientRequest & WithUserPoolId(UserPoolIdT &&value)
CreateUserPoolClientRequest & WithTokenValidityUnits(TokenValidityUnitsT &&value)
CreateUserPoolClientRequest & WithClientSecret(ClientSecretT &&value)
CreateUserPoolClientRequest & WithWriteAttributes(WriteAttributesT &&value)
CreateUserPoolClientRequest & AddLogoutURLs(LogoutURLsT &&value)
CreateUserPoolClientRequest & WithDefaultRedirectURI(DefaultRedirectURIT &&value)
CreateUserPoolClientRequest & WithEnablePropagateAdditionalUserContextData(bool value)
AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
CreateUserPoolClientRequest & WithReadAttributes(ReadAttributesT &&value)
AWS_COGNITOIDENTITYPROVIDER_API CreateUserPoolClientRequest()=default
CreateUserPoolClientRequest & AddAllowedOAuthScopes(AllowedOAuthScopesT &&value)
CreateUserPoolClientRequest & WithExplicitAuthFlows(ExplicitAuthFlowsT &&value)
CreateUserPoolClientRequest & WithRefreshTokenRotation(RefreshTokenRotationT &&value)
CreateUserPoolClientRequest & WithLogoutURLs(LogoutURLsT &&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