AWS SDK for C++

AWS SDK for C++ Version 1.11.742

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
118 inline int GetRefreshTokenValidity() const { return m_refreshTokenValidity; }
119 inline bool RefreshTokenValidityHasBeenSet() const { return m_refreshTokenValidityHasBeenSet; }
120 inline void SetRefreshTokenValidity(int value) {
121 m_refreshTokenValidityHasBeenSet = true;
122 m_refreshTokenValidity = value;
123 }
126 return *this;
127 }
129
131
144 inline int GetAccessTokenValidity() const { return m_accessTokenValidity; }
145 inline bool AccessTokenValidityHasBeenSet() const { return m_accessTokenValidityHasBeenSet; }
146 inline void SetAccessTokenValidity(int value) {
147 m_accessTokenValidityHasBeenSet = true;
148 m_accessTokenValidity = value;
149 }
152 return *this;
153 }
155
157
170 inline int GetIdTokenValidity() const { return m_idTokenValidity; }
171 inline bool IdTokenValidityHasBeenSet() const { return m_idTokenValidityHasBeenSet; }
172 inline void SetIdTokenValidity(int value) {
173 m_idTokenValidityHasBeenSet = true;
174 m_idTokenValidity = value;
175 }
177 SetIdTokenValidity(value);
178 return *this;
179 }
181
183
187 inline const TokenValidityUnitsType& GetTokenValidityUnits() const { return m_tokenValidityUnits; }
188 inline bool TokenValidityUnitsHasBeenSet() const { return m_tokenValidityUnitsHasBeenSet; }
189 template <typename TokenValidityUnitsT = TokenValidityUnitsType>
190 void SetTokenValidityUnits(TokenValidityUnitsT&& value) {
191 m_tokenValidityUnitsHasBeenSet = true;
192 m_tokenValidityUnits = std::forward<TokenValidityUnitsT>(value);
193 }
194 template <typename TokenValidityUnitsT = TokenValidityUnitsType>
196 SetTokenValidityUnits(std::forward<TokenValidityUnitsT>(value));
197 return *this;
198 }
200
202
214 inline const Aws::Vector<Aws::String>& GetReadAttributes() const { return m_readAttributes; }
215 inline bool ReadAttributesHasBeenSet() const { return m_readAttributesHasBeenSet; }
216 template <typename ReadAttributesT = Aws::Vector<Aws::String>>
217 void SetReadAttributes(ReadAttributesT&& value) {
218 m_readAttributesHasBeenSet = true;
219 m_readAttributes = std::forward<ReadAttributesT>(value);
220 }
221 template <typename ReadAttributesT = Aws::Vector<Aws::String>>
223 SetReadAttributes(std::forward<ReadAttributesT>(value));
224 return *this;
225 }
226 template <typename ReadAttributesT = Aws::String>
228 m_readAttributesHasBeenSet = true;
229 m_readAttributes.emplace_back(std::forward<ReadAttributesT>(value));
230 return *this;
231 }
233
235
253 inline const Aws::Vector<Aws::String>& GetWriteAttributes() const { return m_writeAttributes; }
254 inline bool WriteAttributesHasBeenSet() const { return m_writeAttributesHasBeenSet; }
255 template <typename WriteAttributesT = Aws::Vector<Aws::String>>
256 void SetWriteAttributes(WriteAttributesT&& value) {
257 m_writeAttributesHasBeenSet = true;
258 m_writeAttributes = std::forward<WriteAttributesT>(value);
259 }
260 template <typename WriteAttributesT = Aws::Vector<Aws::String>>
262 SetWriteAttributes(std::forward<WriteAttributesT>(value));
263 return *this;
264 }
265 template <typename WriteAttributesT = Aws::String>
267 m_writeAttributesHasBeenSet = true;
268 m_writeAttributes.emplace_back(std::forward<WriteAttributesT>(value));
269 return *this;
270 }
272
274
316 inline const Aws::Vector<ExplicitAuthFlowsType>& GetExplicitAuthFlows() const { return m_explicitAuthFlows; }
317 inline bool ExplicitAuthFlowsHasBeenSet() const { return m_explicitAuthFlowsHasBeenSet; }
318 template <typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
319 void SetExplicitAuthFlows(ExplicitAuthFlowsT&& value) {
320 m_explicitAuthFlowsHasBeenSet = true;
321 m_explicitAuthFlows = std::forward<ExplicitAuthFlowsT>(value);
322 }
323 template <typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
325 SetExplicitAuthFlows(std::forward<ExplicitAuthFlowsT>(value));
326 return *this;
327 }
329 m_explicitAuthFlowsHasBeenSet = true;
330 m_explicitAuthFlows.push_back(value);
331 return *this;
332 }
334
336
351 inline const Aws::Vector<Aws::String>& GetSupportedIdentityProviders() const { return m_supportedIdentityProviders; }
352 inline bool SupportedIdentityProvidersHasBeenSet() const { return m_supportedIdentityProvidersHasBeenSet; }
353 template <typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
354 void SetSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
355 m_supportedIdentityProvidersHasBeenSet = true;
356 m_supportedIdentityProviders = std::forward<SupportedIdentityProvidersT>(value);
357 }
358 template <typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
359 CreateUserPoolClientRequest& WithSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
360 SetSupportedIdentityProviders(std::forward<SupportedIdentityProvidersT>(value));
361 return *this;
362 }
363 template <typename SupportedIdentityProvidersT = Aws::String>
364 CreateUserPoolClientRequest& AddSupportedIdentityProviders(SupportedIdentityProvidersT&& value) {
365 m_supportedIdentityProvidersHasBeenSet = true;
366 m_supportedIdentityProviders.emplace_back(std::forward<SupportedIdentityProvidersT>(value));
367 return *this;
368 }
370
372
388 inline const Aws::Vector<Aws::String>& GetCallbackURLs() const { return m_callbackURLs; }
389 inline bool CallbackURLsHasBeenSet() const { return m_callbackURLsHasBeenSet; }
390 template <typename CallbackURLsT = Aws::Vector<Aws::String>>
391 void SetCallbackURLs(CallbackURLsT&& value) {
392 m_callbackURLsHasBeenSet = true;
393 m_callbackURLs = std::forward<CallbackURLsT>(value);
394 }
395 template <typename CallbackURLsT = Aws::Vector<Aws::String>>
397 SetCallbackURLs(std::forward<CallbackURLsT>(value));
398 return *this;
399 }
400 template <typename CallbackURLsT = Aws::String>
402 m_callbackURLsHasBeenSet = true;
403 m_callbackURLs.emplace_back(std::forward<CallbackURLsT>(value));
404 return *this;
405 }
407
409
420 inline const Aws::Vector<Aws::String>& GetLogoutURLs() const { return m_logoutURLs; }
421 inline bool LogoutURLsHasBeenSet() const { return m_logoutURLsHasBeenSet; }
422 template <typename LogoutURLsT = Aws::Vector<Aws::String>>
423 void SetLogoutURLs(LogoutURLsT&& value) {
424 m_logoutURLsHasBeenSet = true;
425 m_logoutURLs = std::forward<LogoutURLsT>(value);
426 }
427 template <typename LogoutURLsT = Aws::Vector<Aws::String>>
429 SetLogoutURLs(std::forward<LogoutURLsT>(value));
430 return *this;
431 }
432 template <typename LogoutURLsT = Aws::String>
434 m_logoutURLsHasBeenSet = true;
435 m_logoutURLs.emplace_back(std::forward<LogoutURLsT>(value));
436 return *this;
437 }
439
441
446 inline const Aws::String& GetDefaultRedirectURI() const { return m_defaultRedirectURI; }
447 inline bool DefaultRedirectURIHasBeenSet() const { return m_defaultRedirectURIHasBeenSet; }
448 template <typename DefaultRedirectURIT = Aws::String>
449 void SetDefaultRedirectURI(DefaultRedirectURIT&& value) {
450 m_defaultRedirectURIHasBeenSet = true;
451 m_defaultRedirectURI = std::forward<DefaultRedirectURIT>(value);
452 }
453 template <typename DefaultRedirectURIT = Aws::String>
455 SetDefaultRedirectURI(std::forward<DefaultRedirectURIT>(value));
456 return *this;
457 }
459
461
474 inline const Aws::Vector<OAuthFlowType>& GetAllowedOAuthFlows() const { return m_allowedOAuthFlows; }
475 inline bool AllowedOAuthFlowsHasBeenSet() const { return m_allowedOAuthFlowsHasBeenSet; }
476 template <typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
477 void SetAllowedOAuthFlows(AllowedOAuthFlowsT&& value) {
478 m_allowedOAuthFlowsHasBeenSet = true;
479 m_allowedOAuthFlows = std::forward<AllowedOAuthFlowsT>(value);
480 }
481 template <typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
483 SetAllowedOAuthFlows(std::forward<AllowedOAuthFlowsT>(value));
484 return *this;
485 }
487 m_allowedOAuthFlowsHasBeenSet = true;
488 m_allowedOAuthFlows.push_back(value);
489 return *this;
490 }
492
494
504 inline const Aws::Vector<Aws::String>& GetAllowedOAuthScopes() const { return m_allowedOAuthScopes; }
505 inline bool AllowedOAuthScopesHasBeenSet() const { return m_allowedOAuthScopesHasBeenSet; }
506 template <typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
507 void SetAllowedOAuthScopes(AllowedOAuthScopesT&& value) {
508 m_allowedOAuthScopesHasBeenSet = true;
509 m_allowedOAuthScopes = std::forward<AllowedOAuthScopesT>(value);
510 }
511 template <typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
513 SetAllowedOAuthScopes(std::forward<AllowedOAuthScopesT>(value));
514 return *this;
515 }
516 template <typename AllowedOAuthScopesT = Aws::String>
518 m_allowedOAuthScopesHasBeenSet = true;
519 m_allowedOAuthScopes.emplace_back(std::forward<AllowedOAuthScopesT>(value));
520 return *this;
521 }
523
525
542 inline bool GetAllowedOAuthFlowsUserPoolClient() const { return m_allowedOAuthFlowsUserPoolClient; }
543 inline bool AllowedOAuthFlowsUserPoolClientHasBeenSet() const { return m_allowedOAuthFlowsUserPoolClientHasBeenSet; }
544 inline void SetAllowedOAuthFlowsUserPoolClient(bool value) {
545 m_allowedOAuthFlowsUserPoolClientHasBeenSet = true;
546 m_allowedOAuthFlowsUserPoolClient = value;
547 }
550 return *this;
551 }
553
555
564 inline const AnalyticsConfigurationType& GetAnalyticsConfiguration() const { return m_analyticsConfiguration; }
565 inline bool AnalyticsConfigurationHasBeenSet() const { return m_analyticsConfigurationHasBeenSet; }
566 template <typename AnalyticsConfigurationT = AnalyticsConfigurationType>
567 void SetAnalyticsConfiguration(AnalyticsConfigurationT&& value) {
568 m_analyticsConfigurationHasBeenSet = true;
569 m_analyticsConfiguration = std::forward<AnalyticsConfigurationT>(value);
570 }
571 template <typename AnalyticsConfigurationT = AnalyticsConfigurationType>
572 CreateUserPoolClientRequest& WithAnalyticsConfiguration(AnalyticsConfigurationT&& value) {
573 SetAnalyticsConfiguration(std::forward<AnalyticsConfigurationT>(value));
574 return *this;
575 }
577
579
592 inline PreventUserExistenceErrorTypes GetPreventUserExistenceErrors() const { return m_preventUserExistenceErrors; }
593 inline bool PreventUserExistenceErrorsHasBeenSet() const { return m_preventUserExistenceErrorsHasBeenSet; }
595 m_preventUserExistenceErrorsHasBeenSet = true;
596 m_preventUserExistenceErrors = value;
597 }
600 return *this;
601 }
603
605
612 inline bool GetEnableTokenRevocation() const { return m_enableTokenRevocation; }
613 inline bool EnableTokenRevocationHasBeenSet() const { return m_enableTokenRevocationHasBeenSet; }
614 inline void SetEnableTokenRevocation(bool value) {
615 m_enableTokenRevocationHasBeenSet = true;
616 m_enableTokenRevocation = value;
617 }
620 return *this;
621 }
623
625
636 inline bool GetEnablePropagateAdditionalUserContextData() const { return m_enablePropagateAdditionalUserContextData; }
637 inline bool EnablePropagateAdditionalUserContextDataHasBeenSet() const { return m_enablePropagateAdditionalUserContextDataHasBeenSet; }
639 m_enablePropagateAdditionalUserContextDataHasBeenSet = true;
640 m_enablePropagateAdditionalUserContextData = value;
641 }
644 return *this;
645 }
647
649
655 inline int GetAuthSessionValidity() const { return m_authSessionValidity; }
656 inline bool AuthSessionValidityHasBeenSet() const { return m_authSessionValidityHasBeenSet; }
657 inline void SetAuthSessionValidity(int value) {
658 m_authSessionValidityHasBeenSet = true;
659 m_authSessionValidity = value;
660 }
663 return *this;
664 }
666
668
674 inline const RefreshTokenRotationType& GetRefreshTokenRotation() const { return m_refreshTokenRotation; }
675 inline bool RefreshTokenRotationHasBeenSet() const { return m_refreshTokenRotationHasBeenSet; }
676 template <typename RefreshTokenRotationT = RefreshTokenRotationType>
677 void SetRefreshTokenRotation(RefreshTokenRotationT&& value) {
678 m_refreshTokenRotationHasBeenSet = true;
679 m_refreshTokenRotation = std::forward<RefreshTokenRotationT>(value);
680 }
681 template <typename RefreshTokenRotationT = RefreshTokenRotationType>
683 SetRefreshTokenRotation(std::forward<RefreshTokenRotationT>(value));
684 return *this;
685 }
687 private:
688 Aws::String m_userPoolId;
689
690 Aws::String m_clientName;
691
692 bool m_generateSecret{false};
693
694 int m_refreshTokenValidity{0};
695
696 int m_accessTokenValidity{0};
697
698 int m_idTokenValidity{0};
699
700 TokenValidityUnitsType m_tokenValidityUnits;
701
702 Aws::Vector<Aws::String> m_readAttributes;
703
704 Aws::Vector<Aws::String> m_writeAttributes;
705
706 Aws::Vector<ExplicitAuthFlowsType> m_explicitAuthFlows;
707
708 Aws::Vector<Aws::String> m_supportedIdentityProviders;
709
710 Aws::Vector<Aws::String> m_callbackURLs;
711
712 Aws::Vector<Aws::String> m_logoutURLs;
713
714 Aws::String m_defaultRedirectURI;
715
716 Aws::Vector<OAuthFlowType> m_allowedOAuthFlows;
717
718 Aws::Vector<Aws::String> m_allowedOAuthScopes;
719
720 bool m_allowedOAuthFlowsUserPoolClient{false};
721
722 AnalyticsConfigurationType m_analyticsConfiguration;
723
725
726 bool m_enableTokenRevocation{false};
727
728 bool m_enablePropagateAdditionalUserContextData{false};
729
730 int m_authSessionValidity{0};
731
732 RefreshTokenRotationType m_refreshTokenRotation;
733 bool m_userPoolIdHasBeenSet = false;
734 bool m_clientNameHasBeenSet = false;
735 bool m_generateSecretHasBeenSet = false;
736 bool m_refreshTokenValidityHasBeenSet = false;
737 bool m_accessTokenValidityHasBeenSet = false;
738 bool m_idTokenValidityHasBeenSet = false;
739 bool m_tokenValidityUnitsHasBeenSet = false;
740 bool m_readAttributesHasBeenSet = false;
741 bool m_writeAttributesHasBeenSet = false;
742 bool m_explicitAuthFlowsHasBeenSet = false;
743 bool m_supportedIdentityProvidersHasBeenSet = false;
744 bool m_callbackURLsHasBeenSet = false;
745 bool m_logoutURLsHasBeenSet = false;
746 bool m_defaultRedirectURIHasBeenSet = false;
747 bool m_allowedOAuthFlowsHasBeenSet = false;
748 bool m_allowedOAuthScopesHasBeenSet = false;
749 bool m_allowedOAuthFlowsUserPoolClientHasBeenSet = false;
750 bool m_analyticsConfigurationHasBeenSet = false;
751 bool m_preventUserExistenceErrorsHasBeenSet = false;
752 bool m_enableTokenRevocationHasBeenSet = false;
753 bool m_enablePropagateAdditionalUserContextDataHasBeenSet = false;
754 bool m_authSessionValidityHasBeenSet = false;
755 bool m_refreshTokenRotationHasBeenSet = false;
756};
757
758} // namespace Model
759} // namespace CognitoIdentityProvider
760} // 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 & 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