AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
CreateUserPoolClientRequest.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/TokenValidityUnitsType.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/cognito-idp/model/AnalyticsConfigurationType.h>
13#include <aws/cognito-idp/model/PreventUserExistenceErrorTypes.h>
14#include <aws/cognito-idp/model/RefreshTokenRotationType.h>
15#include <aws/cognito-idp/model/ExplicitAuthFlowsType.h>
16#include <aws/cognito-idp/model/OAuthFlowType.h>
17#include <utility>
18
19namespace Aws
20{
21namespace CognitoIdentityProvider
22{
23namespace Model
24{
25
33 {
34 public:
35 AWS_COGNITOIDENTITYPROVIDER_API CreateUserPoolClientRequest() = default;
36
37 // Service request name is the Operation name which will send this request out,
38 // each operation should has unique request name, so that we can get operation's name from this request.
39 // Note: this is not true for response, multiple operations may have the same response name,
40 // so we can not get operation's name from response.
41 inline virtual const char* GetServiceRequestName() const override { return "CreateUserPoolClient"; }
42
43 AWS_COGNITOIDENTITYPROVIDER_API Aws::String SerializePayload() const override;
44
45 AWS_COGNITOIDENTITYPROVIDER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
46
47
49
52 inline const Aws::String& GetUserPoolId() const { return m_userPoolId; }
53 inline bool UserPoolIdHasBeenSet() const { return m_userPoolIdHasBeenSet; }
54 template<typename UserPoolIdT = Aws::String>
55 void SetUserPoolId(UserPoolIdT&& value) { m_userPoolIdHasBeenSet = true; m_userPoolId = std::forward<UserPoolIdT>(value); }
56 template<typename UserPoolIdT = Aws::String>
57 CreateUserPoolClientRequest& WithUserPoolId(UserPoolIdT&& value) { SetUserPoolId(std::forward<UserPoolIdT>(value)); return *this;}
59
61
64 inline const Aws::String& GetClientName() const { return m_clientName; }
65 inline bool ClientNameHasBeenSet() const { return m_clientNameHasBeenSet; }
66 template<typename ClientNameT = Aws::String>
67 void SetClientName(ClientNameT&& value) { m_clientNameHasBeenSet = true; m_clientName = std::forward<ClientNameT>(value); }
68 template<typename ClientNameT = Aws::String>
69 CreateUserPoolClientRequest& WithClientName(ClientNameT&& value) { SetClientName(std::forward<ClientNameT>(value)); return *this;}
71
73
81 inline bool GetGenerateSecret() const { return m_generateSecret; }
82 inline bool GenerateSecretHasBeenSet() const { return m_generateSecretHasBeenSet; }
83 inline void SetGenerateSecret(bool value) { m_generateSecretHasBeenSet = true; m_generateSecret = value; }
84 inline CreateUserPoolClientRequest& WithGenerateSecret(bool value) { SetGenerateSecret(value); return *this;}
86
88
104 inline int GetRefreshTokenValidity() const { return m_refreshTokenValidity; }
105 inline bool RefreshTokenValidityHasBeenSet() const { return m_refreshTokenValidityHasBeenSet; }
106 inline void SetRefreshTokenValidity(int value) { m_refreshTokenValidityHasBeenSet = true; m_refreshTokenValidity = value; }
109
111
124 inline int GetAccessTokenValidity() const { return m_accessTokenValidity; }
125 inline bool AccessTokenValidityHasBeenSet() const { return m_accessTokenValidityHasBeenSet; }
126 inline void SetAccessTokenValidity(int value) { m_accessTokenValidityHasBeenSet = true; m_accessTokenValidity = value; }
129
131
144 inline int GetIdTokenValidity() const { return m_idTokenValidity; }
145 inline bool IdTokenValidityHasBeenSet() const { return m_idTokenValidityHasBeenSet; }
146 inline void SetIdTokenValidity(int value) { m_idTokenValidityHasBeenSet = true; m_idTokenValidity = value; }
147 inline CreateUserPoolClientRequest& WithIdTokenValidity(int value) { SetIdTokenValidity(value); return *this;}
149
151
155 inline const TokenValidityUnitsType& GetTokenValidityUnits() const { return m_tokenValidityUnits; }
156 inline bool TokenValidityUnitsHasBeenSet() const { return m_tokenValidityUnitsHasBeenSet; }
157 template<typename TokenValidityUnitsT = TokenValidityUnitsType>
158 void SetTokenValidityUnits(TokenValidityUnitsT&& value) { m_tokenValidityUnitsHasBeenSet = true; m_tokenValidityUnits = std::forward<TokenValidityUnitsT>(value); }
159 template<typename TokenValidityUnitsT = TokenValidityUnitsType>
160 CreateUserPoolClientRequest& WithTokenValidityUnits(TokenValidityUnitsT&& value) { SetTokenValidityUnits(std::forward<TokenValidityUnitsT>(value)); return *this;}
162
164
176 inline const Aws::Vector<Aws::String>& GetReadAttributes() const { return m_readAttributes; }
177 inline bool ReadAttributesHasBeenSet() const { return m_readAttributesHasBeenSet; }
178 template<typename ReadAttributesT = Aws::Vector<Aws::String>>
179 void SetReadAttributes(ReadAttributesT&& value) { m_readAttributesHasBeenSet = true; m_readAttributes = std::forward<ReadAttributesT>(value); }
180 template<typename ReadAttributesT = Aws::Vector<Aws::String>>
181 CreateUserPoolClientRequest& WithReadAttributes(ReadAttributesT&& value) { SetReadAttributes(std::forward<ReadAttributesT>(value)); return *this;}
182 template<typename ReadAttributesT = Aws::String>
183 CreateUserPoolClientRequest& AddReadAttributes(ReadAttributesT&& value) { m_readAttributesHasBeenSet = true; m_readAttributes.emplace_back(std::forward<ReadAttributesT>(value)); return *this; }
185
187
205 inline const Aws::Vector<Aws::String>& GetWriteAttributes() const { return m_writeAttributes; }
206 inline bool WriteAttributesHasBeenSet() const { return m_writeAttributesHasBeenSet; }
207 template<typename WriteAttributesT = Aws::Vector<Aws::String>>
208 void SetWriteAttributes(WriteAttributesT&& value) { m_writeAttributesHasBeenSet = true; m_writeAttributes = std::forward<WriteAttributesT>(value); }
209 template<typename WriteAttributesT = Aws::Vector<Aws::String>>
210 CreateUserPoolClientRequest& WithWriteAttributes(WriteAttributesT&& value) { SetWriteAttributes(std::forward<WriteAttributesT>(value)); return *this;}
211 template<typename WriteAttributesT = Aws::String>
212 CreateUserPoolClientRequest& AddWriteAttributes(WriteAttributesT&& value) { m_writeAttributesHasBeenSet = true; m_writeAttributes.emplace_back(std::forward<WriteAttributesT>(value)); return *this; }
214
216
258 inline const Aws::Vector<ExplicitAuthFlowsType>& GetExplicitAuthFlows() const { return m_explicitAuthFlows; }
259 inline bool ExplicitAuthFlowsHasBeenSet() const { return m_explicitAuthFlowsHasBeenSet; }
260 template<typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
261 void SetExplicitAuthFlows(ExplicitAuthFlowsT&& value) { m_explicitAuthFlowsHasBeenSet = true; m_explicitAuthFlows = std::forward<ExplicitAuthFlowsT>(value); }
262 template<typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
263 CreateUserPoolClientRequest& WithExplicitAuthFlows(ExplicitAuthFlowsT&& value) { SetExplicitAuthFlows(std::forward<ExplicitAuthFlowsT>(value)); return *this;}
264 inline CreateUserPoolClientRequest& AddExplicitAuthFlows(ExplicitAuthFlowsType value) { m_explicitAuthFlowsHasBeenSet = true; m_explicitAuthFlows.push_back(value); return *this; }
266
268
283 inline const Aws::Vector<Aws::String>& GetSupportedIdentityProviders() const { return m_supportedIdentityProviders; }
284 inline bool SupportedIdentityProvidersHasBeenSet() const { return m_supportedIdentityProvidersHasBeenSet; }
285 template<typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
286 void SetSupportedIdentityProviders(SupportedIdentityProvidersT&& value) { m_supportedIdentityProvidersHasBeenSet = true; m_supportedIdentityProviders = std::forward<SupportedIdentityProvidersT>(value); }
287 template<typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
288 CreateUserPoolClientRequest& WithSupportedIdentityProviders(SupportedIdentityProvidersT&& value) { SetSupportedIdentityProviders(std::forward<SupportedIdentityProvidersT>(value)); return *this;}
289 template<typename SupportedIdentityProvidersT = Aws::String>
290 CreateUserPoolClientRequest& AddSupportedIdentityProviders(SupportedIdentityProvidersT&& value) { m_supportedIdentityProvidersHasBeenSet = true; m_supportedIdentityProviders.emplace_back(std::forward<SupportedIdentityProvidersT>(value)); return *this; }
292
294
310 inline const Aws::Vector<Aws::String>& GetCallbackURLs() const { return m_callbackURLs; }
311 inline bool CallbackURLsHasBeenSet() const { return m_callbackURLsHasBeenSet; }
312 template<typename CallbackURLsT = Aws::Vector<Aws::String>>
313 void SetCallbackURLs(CallbackURLsT&& value) { m_callbackURLsHasBeenSet = true; m_callbackURLs = std::forward<CallbackURLsT>(value); }
314 template<typename CallbackURLsT = Aws::Vector<Aws::String>>
315 CreateUserPoolClientRequest& WithCallbackURLs(CallbackURLsT&& value) { SetCallbackURLs(std::forward<CallbackURLsT>(value)); return *this;}
316 template<typename CallbackURLsT = Aws::String>
317 CreateUserPoolClientRequest& AddCallbackURLs(CallbackURLsT&& value) { m_callbackURLsHasBeenSet = true; m_callbackURLs.emplace_back(std::forward<CallbackURLsT>(value)); return *this; }
319
321
332 inline const Aws::Vector<Aws::String>& GetLogoutURLs() const { return m_logoutURLs; }
333 inline bool LogoutURLsHasBeenSet() const { return m_logoutURLsHasBeenSet; }
334 template<typename LogoutURLsT = Aws::Vector<Aws::String>>
335 void SetLogoutURLs(LogoutURLsT&& value) { m_logoutURLsHasBeenSet = true; m_logoutURLs = std::forward<LogoutURLsT>(value); }
336 template<typename LogoutURLsT = Aws::Vector<Aws::String>>
337 CreateUserPoolClientRequest& WithLogoutURLs(LogoutURLsT&& value) { SetLogoutURLs(std::forward<LogoutURLsT>(value)); return *this;}
338 template<typename LogoutURLsT = Aws::String>
339 CreateUserPoolClientRequest& AddLogoutURLs(LogoutURLsT&& value) { m_logoutURLsHasBeenSet = true; m_logoutURLs.emplace_back(std::forward<LogoutURLsT>(value)); return *this; }
341
343
348 inline const Aws::String& GetDefaultRedirectURI() const { return m_defaultRedirectURI; }
349 inline bool DefaultRedirectURIHasBeenSet() const { return m_defaultRedirectURIHasBeenSet; }
350 template<typename DefaultRedirectURIT = Aws::String>
351 void SetDefaultRedirectURI(DefaultRedirectURIT&& value) { m_defaultRedirectURIHasBeenSet = true; m_defaultRedirectURI = std::forward<DefaultRedirectURIT>(value); }
352 template<typename DefaultRedirectURIT = Aws::String>
353 CreateUserPoolClientRequest& WithDefaultRedirectURI(DefaultRedirectURIT&& value) { SetDefaultRedirectURI(std::forward<DefaultRedirectURIT>(value)); return *this;}
355
357
370 inline const Aws::Vector<OAuthFlowType>& GetAllowedOAuthFlows() const { return m_allowedOAuthFlows; }
371 inline bool AllowedOAuthFlowsHasBeenSet() const { return m_allowedOAuthFlowsHasBeenSet; }
372 template<typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
373 void SetAllowedOAuthFlows(AllowedOAuthFlowsT&& value) { m_allowedOAuthFlowsHasBeenSet = true; m_allowedOAuthFlows = std::forward<AllowedOAuthFlowsT>(value); }
374 template<typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
375 CreateUserPoolClientRequest& WithAllowedOAuthFlows(AllowedOAuthFlowsT&& value) { SetAllowedOAuthFlows(std::forward<AllowedOAuthFlowsT>(value)); return *this;}
376 inline CreateUserPoolClientRequest& AddAllowedOAuthFlows(OAuthFlowType value) { m_allowedOAuthFlowsHasBeenSet = true; m_allowedOAuthFlows.push_back(value); return *this; }
378
380
390 inline const Aws::Vector<Aws::String>& GetAllowedOAuthScopes() const { return m_allowedOAuthScopes; }
391 inline bool AllowedOAuthScopesHasBeenSet() const { return m_allowedOAuthScopesHasBeenSet; }
392 template<typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
393 void SetAllowedOAuthScopes(AllowedOAuthScopesT&& value) { m_allowedOAuthScopesHasBeenSet = true; m_allowedOAuthScopes = std::forward<AllowedOAuthScopesT>(value); }
394 template<typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
395 CreateUserPoolClientRequest& WithAllowedOAuthScopes(AllowedOAuthScopesT&& value) { SetAllowedOAuthScopes(std::forward<AllowedOAuthScopesT>(value)); return *this;}
396 template<typename AllowedOAuthScopesT = Aws::String>
397 CreateUserPoolClientRequest& AddAllowedOAuthScopes(AllowedOAuthScopesT&& value) { m_allowedOAuthScopesHasBeenSet = true; m_allowedOAuthScopes.emplace_back(std::forward<AllowedOAuthScopesT>(value)); return *this; }
399
401
418 inline bool GetAllowedOAuthFlowsUserPoolClient() const { return m_allowedOAuthFlowsUserPoolClient; }
419 inline bool AllowedOAuthFlowsUserPoolClientHasBeenSet() const { return m_allowedOAuthFlowsUserPoolClientHasBeenSet; }
420 inline void SetAllowedOAuthFlowsUserPoolClient(bool value) { m_allowedOAuthFlowsUserPoolClientHasBeenSet = true; m_allowedOAuthFlowsUserPoolClient = value; }
423
425
434 inline const AnalyticsConfigurationType& GetAnalyticsConfiguration() const { return m_analyticsConfiguration; }
435 inline bool AnalyticsConfigurationHasBeenSet() const { return m_analyticsConfigurationHasBeenSet; }
436 template<typename AnalyticsConfigurationT = AnalyticsConfigurationType>
437 void SetAnalyticsConfiguration(AnalyticsConfigurationT&& value) { m_analyticsConfigurationHasBeenSet = true; m_analyticsConfiguration = std::forward<AnalyticsConfigurationT>(value); }
438 template<typename AnalyticsConfigurationT = AnalyticsConfigurationType>
439 CreateUserPoolClientRequest& WithAnalyticsConfiguration(AnalyticsConfigurationT&& value) { SetAnalyticsConfiguration(std::forward<AnalyticsConfigurationT>(value)); return *this;}
441
443
456 inline PreventUserExistenceErrorTypes GetPreventUserExistenceErrors() const { return m_preventUserExistenceErrors; }
457 inline bool PreventUserExistenceErrorsHasBeenSet() const { return m_preventUserExistenceErrorsHasBeenSet; }
458 inline void SetPreventUserExistenceErrors(PreventUserExistenceErrorTypes value) { m_preventUserExistenceErrorsHasBeenSet = true; m_preventUserExistenceErrors = value; }
461
463
470 inline bool GetEnableTokenRevocation() const { return m_enableTokenRevocation; }
471 inline bool EnableTokenRevocationHasBeenSet() const { return m_enableTokenRevocationHasBeenSet; }
472 inline void SetEnableTokenRevocation(bool value) { m_enableTokenRevocationHasBeenSet = true; m_enableTokenRevocation = value; }
475
477
488 inline bool GetEnablePropagateAdditionalUserContextData() const { return m_enablePropagateAdditionalUserContextData; }
489 inline bool EnablePropagateAdditionalUserContextDataHasBeenSet() const { return m_enablePropagateAdditionalUserContextDataHasBeenSet; }
490 inline void SetEnablePropagateAdditionalUserContextData(bool value) { m_enablePropagateAdditionalUserContextDataHasBeenSet = true; m_enablePropagateAdditionalUserContextData = value; }
493
495
501 inline int GetAuthSessionValidity() const { return m_authSessionValidity; }
502 inline bool AuthSessionValidityHasBeenSet() const { return m_authSessionValidityHasBeenSet; }
503 inline void SetAuthSessionValidity(int value) { m_authSessionValidityHasBeenSet = true; m_authSessionValidity = value; }
506
508
514 inline const RefreshTokenRotationType& GetRefreshTokenRotation() const { return m_refreshTokenRotation; }
515 inline bool RefreshTokenRotationHasBeenSet() const { return m_refreshTokenRotationHasBeenSet; }
516 template<typename RefreshTokenRotationT = RefreshTokenRotationType>
517 void SetRefreshTokenRotation(RefreshTokenRotationT&& value) { m_refreshTokenRotationHasBeenSet = true; m_refreshTokenRotation = std::forward<RefreshTokenRotationT>(value); }
518 template<typename RefreshTokenRotationT = RefreshTokenRotationType>
519 CreateUserPoolClientRequest& WithRefreshTokenRotation(RefreshTokenRotationT&& value) { SetRefreshTokenRotation(std::forward<RefreshTokenRotationT>(value)); return *this;}
521 private:
522
523 Aws::String m_userPoolId;
524 bool m_userPoolIdHasBeenSet = false;
525
526 Aws::String m_clientName;
527 bool m_clientNameHasBeenSet = false;
528
529 bool m_generateSecret{false};
530 bool m_generateSecretHasBeenSet = false;
531
532 int m_refreshTokenValidity{0};
533 bool m_refreshTokenValidityHasBeenSet = false;
534
535 int m_accessTokenValidity{0};
536 bool m_accessTokenValidityHasBeenSet = false;
537
538 int m_idTokenValidity{0};
539 bool m_idTokenValidityHasBeenSet = false;
540
541 TokenValidityUnitsType m_tokenValidityUnits;
542 bool m_tokenValidityUnitsHasBeenSet = false;
543
544 Aws::Vector<Aws::String> m_readAttributes;
545 bool m_readAttributesHasBeenSet = false;
546
547 Aws::Vector<Aws::String> m_writeAttributes;
548 bool m_writeAttributesHasBeenSet = false;
549
550 Aws::Vector<ExplicitAuthFlowsType> m_explicitAuthFlows;
551 bool m_explicitAuthFlowsHasBeenSet = false;
552
553 Aws::Vector<Aws::String> m_supportedIdentityProviders;
554 bool m_supportedIdentityProvidersHasBeenSet = false;
555
556 Aws::Vector<Aws::String> m_callbackURLs;
557 bool m_callbackURLsHasBeenSet = false;
558
559 Aws::Vector<Aws::String> m_logoutURLs;
560 bool m_logoutURLsHasBeenSet = false;
561
562 Aws::String m_defaultRedirectURI;
563 bool m_defaultRedirectURIHasBeenSet = false;
564
565 Aws::Vector<OAuthFlowType> m_allowedOAuthFlows;
566 bool m_allowedOAuthFlowsHasBeenSet = false;
567
568 Aws::Vector<Aws::String> m_allowedOAuthScopes;
569 bool m_allowedOAuthScopesHasBeenSet = false;
570
571 bool m_allowedOAuthFlowsUserPoolClient{false};
572 bool m_allowedOAuthFlowsUserPoolClientHasBeenSet = false;
573
574 AnalyticsConfigurationType m_analyticsConfiguration;
575 bool m_analyticsConfigurationHasBeenSet = false;
576
578 bool m_preventUserExistenceErrorsHasBeenSet = false;
579
580 bool m_enableTokenRevocation{false};
581 bool m_enableTokenRevocationHasBeenSet = false;
582
583 bool m_enablePropagateAdditionalUserContextData{false};
584 bool m_enablePropagateAdditionalUserContextDataHasBeenSet = false;
585
586 int m_authSessionValidity{0};
587 bool m_authSessionValidityHasBeenSet = false;
588
589 RefreshTokenRotationType m_refreshTokenRotation;
590 bool m_refreshTokenRotationHasBeenSet = false;
591 };
592
593} // namespace Model
594} // namespace CognitoIdentityProvider
595} // 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