AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
UpdateUserPoolClientRequest.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 UpdateUserPoolClientRequest() = 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 "UpdateUserPoolClient"; }
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 UpdateUserPoolClientRequest& WithUserPoolId(UserPoolIdT&& value) { SetUserPoolId(std::forward<UserPoolIdT>(value)); return *this;}
59
61
64 inline const Aws::String& GetClientId() const { return m_clientId; }
65 inline bool ClientIdHasBeenSet() const { return m_clientIdHasBeenSet; }
66 template<typename ClientIdT = Aws::String>
67 void SetClientId(ClientIdT&& value) { m_clientIdHasBeenSet = true; m_clientId = std::forward<ClientIdT>(value); }
68 template<typename ClientIdT = Aws::String>
69 UpdateUserPoolClientRequest& WithClientId(ClientIdT&& value) { SetClientId(std::forward<ClientIdT>(value)); return *this;}
71
73
76 inline const Aws::String& GetClientName() const { return m_clientName; }
77 inline bool ClientNameHasBeenSet() const { return m_clientNameHasBeenSet; }
78 template<typename ClientNameT = Aws::String>
79 void SetClientName(ClientNameT&& value) { m_clientNameHasBeenSet = true; m_clientName = std::forward<ClientNameT>(value); }
80 template<typename ClientNameT = Aws::String>
81 UpdateUserPoolClientRequest& WithClientName(ClientNameT&& value) { SetClientName(std::forward<ClientNameT>(value)); return *this;}
83
85
101 inline int GetRefreshTokenValidity() const { return m_refreshTokenValidity; }
102 inline bool RefreshTokenValidityHasBeenSet() const { return m_refreshTokenValidityHasBeenSet; }
103 inline void SetRefreshTokenValidity(int value) { m_refreshTokenValidityHasBeenSet = true; m_refreshTokenValidity = value; }
106
108
121 inline int GetAccessTokenValidity() const { return m_accessTokenValidity; }
122 inline bool AccessTokenValidityHasBeenSet() const { return m_accessTokenValidityHasBeenSet; }
123 inline void SetAccessTokenValidity(int value) { m_accessTokenValidityHasBeenSet = true; m_accessTokenValidity = value; }
126
128
141 inline int GetIdTokenValidity() const { return m_idTokenValidity; }
142 inline bool IdTokenValidityHasBeenSet() const { return m_idTokenValidityHasBeenSet; }
143 inline void SetIdTokenValidity(int value) { m_idTokenValidityHasBeenSet = true; m_idTokenValidity = value; }
144 inline UpdateUserPoolClientRequest& WithIdTokenValidity(int value) { SetIdTokenValidity(value); return *this;}
146
148
152 inline const TokenValidityUnitsType& GetTokenValidityUnits() const { return m_tokenValidityUnits; }
153 inline bool TokenValidityUnitsHasBeenSet() const { return m_tokenValidityUnitsHasBeenSet; }
154 template<typename TokenValidityUnitsT = TokenValidityUnitsType>
155 void SetTokenValidityUnits(TokenValidityUnitsT&& value) { m_tokenValidityUnitsHasBeenSet = true; m_tokenValidityUnits = std::forward<TokenValidityUnitsT>(value); }
156 template<typename TokenValidityUnitsT = TokenValidityUnitsType>
157 UpdateUserPoolClientRequest& WithTokenValidityUnits(TokenValidityUnitsT&& value) { SetTokenValidityUnits(std::forward<TokenValidityUnitsT>(value)); return *this;}
159
161
173 inline const Aws::Vector<Aws::String>& GetReadAttributes() const { return m_readAttributes; }
174 inline bool ReadAttributesHasBeenSet() const { return m_readAttributesHasBeenSet; }
175 template<typename ReadAttributesT = Aws::Vector<Aws::String>>
176 void SetReadAttributes(ReadAttributesT&& value) { m_readAttributesHasBeenSet = true; m_readAttributes = std::forward<ReadAttributesT>(value); }
177 template<typename ReadAttributesT = Aws::Vector<Aws::String>>
178 UpdateUserPoolClientRequest& WithReadAttributes(ReadAttributesT&& value) { SetReadAttributes(std::forward<ReadAttributesT>(value)); return *this;}
179 template<typename ReadAttributesT = Aws::String>
180 UpdateUserPoolClientRequest& AddReadAttributes(ReadAttributesT&& value) { m_readAttributesHasBeenSet = true; m_readAttributes.emplace_back(std::forward<ReadAttributesT>(value)); return *this; }
182
184
202 inline const Aws::Vector<Aws::String>& GetWriteAttributes() const { return m_writeAttributes; }
203 inline bool WriteAttributesHasBeenSet() const { return m_writeAttributesHasBeenSet; }
204 template<typename WriteAttributesT = Aws::Vector<Aws::String>>
205 void SetWriteAttributes(WriteAttributesT&& value) { m_writeAttributesHasBeenSet = true; m_writeAttributes = std::forward<WriteAttributesT>(value); }
206 template<typename WriteAttributesT = Aws::Vector<Aws::String>>
207 UpdateUserPoolClientRequest& WithWriteAttributes(WriteAttributesT&& value) { SetWriteAttributes(std::forward<WriteAttributesT>(value)); return *this;}
208 template<typename WriteAttributesT = Aws::String>
209 UpdateUserPoolClientRequest& AddWriteAttributes(WriteAttributesT&& value) { m_writeAttributesHasBeenSet = true; m_writeAttributes.emplace_back(std::forward<WriteAttributesT>(value)); return *this; }
211
213
255 inline const Aws::Vector<ExplicitAuthFlowsType>& GetExplicitAuthFlows() const { return m_explicitAuthFlows; }
256 inline bool ExplicitAuthFlowsHasBeenSet() const { return m_explicitAuthFlowsHasBeenSet; }
257 template<typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
258 void SetExplicitAuthFlows(ExplicitAuthFlowsT&& value) { m_explicitAuthFlowsHasBeenSet = true; m_explicitAuthFlows = std::forward<ExplicitAuthFlowsT>(value); }
259 template<typename ExplicitAuthFlowsT = Aws::Vector<ExplicitAuthFlowsType>>
260 UpdateUserPoolClientRequest& WithExplicitAuthFlows(ExplicitAuthFlowsT&& value) { SetExplicitAuthFlows(std::forward<ExplicitAuthFlowsT>(value)); return *this;}
261 inline UpdateUserPoolClientRequest& AddExplicitAuthFlows(ExplicitAuthFlowsType value) { m_explicitAuthFlowsHasBeenSet = true; m_explicitAuthFlows.push_back(value); return *this; }
263
265
280 inline const Aws::Vector<Aws::String>& GetSupportedIdentityProviders() const { return m_supportedIdentityProviders; }
281 inline bool SupportedIdentityProvidersHasBeenSet() const { return m_supportedIdentityProvidersHasBeenSet; }
282 template<typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
283 void SetSupportedIdentityProviders(SupportedIdentityProvidersT&& value) { m_supportedIdentityProvidersHasBeenSet = true; m_supportedIdentityProviders = std::forward<SupportedIdentityProvidersT>(value); }
284 template<typename SupportedIdentityProvidersT = Aws::Vector<Aws::String>>
285 UpdateUserPoolClientRequest& WithSupportedIdentityProviders(SupportedIdentityProvidersT&& value) { SetSupportedIdentityProviders(std::forward<SupportedIdentityProvidersT>(value)); return *this;}
286 template<typename SupportedIdentityProvidersT = Aws::String>
287 UpdateUserPoolClientRequest& AddSupportedIdentityProviders(SupportedIdentityProvidersT&& value) { m_supportedIdentityProvidersHasBeenSet = true; m_supportedIdentityProviders.emplace_back(std::forward<SupportedIdentityProvidersT>(value)); return *this; }
289
291
307 inline const Aws::Vector<Aws::String>& GetCallbackURLs() const { return m_callbackURLs; }
308 inline bool CallbackURLsHasBeenSet() const { return m_callbackURLsHasBeenSet; }
309 template<typename CallbackURLsT = Aws::Vector<Aws::String>>
310 void SetCallbackURLs(CallbackURLsT&& value) { m_callbackURLsHasBeenSet = true; m_callbackURLs = std::forward<CallbackURLsT>(value); }
311 template<typename CallbackURLsT = Aws::Vector<Aws::String>>
312 UpdateUserPoolClientRequest& WithCallbackURLs(CallbackURLsT&& value) { SetCallbackURLs(std::forward<CallbackURLsT>(value)); return *this;}
313 template<typename CallbackURLsT = Aws::String>
314 UpdateUserPoolClientRequest& AddCallbackURLs(CallbackURLsT&& value) { m_callbackURLsHasBeenSet = true; m_callbackURLs.emplace_back(std::forward<CallbackURLsT>(value)); return *this; }
316
318
329 inline const Aws::Vector<Aws::String>& GetLogoutURLs() const { return m_logoutURLs; }
330 inline bool LogoutURLsHasBeenSet() const { return m_logoutURLsHasBeenSet; }
331 template<typename LogoutURLsT = Aws::Vector<Aws::String>>
332 void SetLogoutURLs(LogoutURLsT&& value) { m_logoutURLsHasBeenSet = true; m_logoutURLs = std::forward<LogoutURLsT>(value); }
333 template<typename LogoutURLsT = Aws::Vector<Aws::String>>
334 UpdateUserPoolClientRequest& WithLogoutURLs(LogoutURLsT&& value) { SetLogoutURLs(std::forward<LogoutURLsT>(value)); return *this;}
335 template<typename LogoutURLsT = Aws::String>
336 UpdateUserPoolClientRequest& AddLogoutURLs(LogoutURLsT&& value) { m_logoutURLsHasBeenSet = true; m_logoutURLs.emplace_back(std::forward<LogoutURLsT>(value)); return *this; }
338
340
345 inline const Aws::String& GetDefaultRedirectURI() const { return m_defaultRedirectURI; }
346 inline bool DefaultRedirectURIHasBeenSet() const { return m_defaultRedirectURIHasBeenSet; }
347 template<typename DefaultRedirectURIT = Aws::String>
348 void SetDefaultRedirectURI(DefaultRedirectURIT&& value) { m_defaultRedirectURIHasBeenSet = true; m_defaultRedirectURI = std::forward<DefaultRedirectURIT>(value); }
349 template<typename DefaultRedirectURIT = Aws::String>
350 UpdateUserPoolClientRequest& WithDefaultRedirectURI(DefaultRedirectURIT&& value) { SetDefaultRedirectURI(std::forward<DefaultRedirectURIT>(value)); return *this;}
352
354
366 inline const Aws::Vector<OAuthFlowType>& GetAllowedOAuthFlows() const { return m_allowedOAuthFlows; }
367 inline bool AllowedOAuthFlowsHasBeenSet() const { return m_allowedOAuthFlowsHasBeenSet; }
368 template<typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
369 void SetAllowedOAuthFlows(AllowedOAuthFlowsT&& value) { m_allowedOAuthFlowsHasBeenSet = true; m_allowedOAuthFlows = std::forward<AllowedOAuthFlowsT>(value); }
370 template<typename AllowedOAuthFlowsT = Aws::Vector<OAuthFlowType>>
371 UpdateUserPoolClientRequest& WithAllowedOAuthFlows(AllowedOAuthFlowsT&& value) { SetAllowedOAuthFlows(std::forward<AllowedOAuthFlowsT>(value)); return *this;}
372 inline UpdateUserPoolClientRequest& AddAllowedOAuthFlows(OAuthFlowType value) { m_allowedOAuthFlowsHasBeenSet = true; m_allowedOAuthFlows.push_back(value); return *this; }
374
376
386 inline const Aws::Vector<Aws::String>& GetAllowedOAuthScopes() const { return m_allowedOAuthScopes; }
387 inline bool AllowedOAuthScopesHasBeenSet() const { return m_allowedOAuthScopesHasBeenSet; }
388 template<typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
389 void SetAllowedOAuthScopes(AllowedOAuthScopesT&& value) { m_allowedOAuthScopesHasBeenSet = true; m_allowedOAuthScopes = std::forward<AllowedOAuthScopesT>(value); }
390 template<typename AllowedOAuthScopesT = Aws::Vector<Aws::String>>
391 UpdateUserPoolClientRequest& WithAllowedOAuthScopes(AllowedOAuthScopesT&& value) { SetAllowedOAuthScopes(std::forward<AllowedOAuthScopesT>(value)); return *this;}
392 template<typename AllowedOAuthScopesT = Aws::String>
393 UpdateUserPoolClientRequest& AddAllowedOAuthScopes(AllowedOAuthScopesT&& value) { m_allowedOAuthScopesHasBeenSet = true; m_allowedOAuthScopes.emplace_back(std::forward<AllowedOAuthScopesT>(value)); return *this; }
395
397
414 inline bool GetAllowedOAuthFlowsUserPoolClient() const { return m_allowedOAuthFlowsUserPoolClient; }
415 inline bool AllowedOAuthFlowsUserPoolClientHasBeenSet() const { return m_allowedOAuthFlowsUserPoolClientHasBeenSet; }
416 inline void SetAllowedOAuthFlowsUserPoolClient(bool value) { m_allowedOAuthFlowsUserPoolClientHasBeenSet = true; m_allowedOAuthFlowsUserPoolClient = value; }
419
421
430 inline const AnalyticsConfigurationType& GetAnalyticsConfiguration() const { return m_analyticsConfiguration; }
431 inline bool AnalyticsConfigurationHasBeenSet() const { return m_analyticsConfigurationHasBeenSet; }
432 template<typename AnalyticsConfigurationT = AnalyticsConfigurationType>
433 void SetAnalyticsConfiguration(AnalyticsConfigurationT&& value) { m_analyticsConfigurationHasBeenSet = true; m_analyticsConfiguration = std::forward<AnalyticsConfigurationT>(value); }
434 template<typename AnalyticsConfigurationT = AnalyticsConfigurationType>
435 UpdateUserPoolClientRequest& WithAnalyticsConfiguration(AnalyticsConfigurationT&& value) { SetAnalyticsConfiguration(std::forward<AnalyticsConfigurationT>(value)); return *this;}
437
439
452 inline PreventUserExistenceErrorTypes GetPreventUserExistenceErrors() const { return m_preventUserExistenceErrors; }
453 inline bool PreventUserExistenceErrorsHasBeenSet() const { return m_preventUserExistenceErrorsHasBeenSet; }
454 inline void SetPreventUserExistenceErrors(PreventUserExistenceErrorTypes value) { m_preventUserExistenceErrorsHasBeenSet = true; m_preventUserExistenceErrors = value; }
457
459
464 inline bool GetEnableTokenRevocation() const { return m_enableTokenRevocation; }
465 inline bool EnableTokenRevocationHasBeenSet() const { return m_enableTokenRevocationHasBeenSet; }
466 inline void SetEnableTokenRevocation(bool value) { m_enableTokenRevocationHasBeenSet = true; m_enableTokenRevocation = value; }
469
471
482 inline bool GetEnablePropagateAdditionalUserContextData() const { return m_enablePropagateAdditionalUserContextData; }
483 inline bool EnablePropagateAdditionalUserContextDataHasBeenSet() const { return m_enablePropagateAdditionalUserContextDataHasBeenSet; }
484 inline void SetEnablePropagateAdditionalUserContextData(bool value) { m_enablePropagateAdditionalUserContextDataHasBeenSet = true; m_enablePropagateAdditionalUserContextData = value; }
487
489
495 inline int GetAuthSessionValidity() const { return m_authSessionValidity; }
496 inline bool AuthSessionValidityHasBeenSet() const { return m_authSessionValidityHasBeenSet; }
497 inline void SetAuthSessionValidity(int value) { m_authSessionValidityHasBeenSet = true; m_authSessionValidity = value; }
500
502
508 inline const RefreshTokenRotationType& GetRefreshTokenRotation() const { return m_refreshTokenRotation; }
509 inline bool RefreshTokenRotationHasBeenSet() const { return m_refreshTokenRotationHasBeenSet; }
510 template<typename RefreshTokenRotationT = RefreshTokenRotationType>
511 void SetRefreshTokenRotation(RefreshTokenRotationT&& value) { m_refreshTokenRotationHasBeenSet = true; m_refreshTokenRotation = std::forward<RefreshTokenRotationT>(value); }
512 template<typename RefreshTokenRotationT = RefreshTokenRotationType>
513 UpdateUserPoolClientRequest& WithRefreshTokenRotation(RefreshTokenRotationT&& value) { SetRefreshTokenRotation(std::forward<RefreshTokenRotationT>(value)); return *this;}
515 private:
516
517 Aws::String m_userPoolId;
518 bool m_userPoolIdHasBeenSet = false;
519
520 Aws::String m_clientId;
521 bool m_clientIdHasBeenSet = false;
522
523 Aws::String m_clientName;
524 bool m_clientNameHasBeenSet = false;
525
526 int m_refreshTokenValidity{0};
527 bool m_refreshTokenValidityHasBeenSet = false;
528
529 int m_accessTokenValidity{0};
530 bool m_accessTokenValidityHasBeenSet = false;
531
532 int m_idTokenValidity{0};
533 bool m_idTokenValidityHasBeenSet = false;
534
535 TokenValidityUnitsType m_tokenValidityUnits;
536 bool m_tokenValidityUnitsHasBeenSet = false;
537
538 Aws::Vector<Aws::String> m_readAttributes;
539 bool m_readAttributesHasBeenSet = false;
540
541 Aws::Vector<Aws::String> m_writeAttributes;
542 bool m_writeAttributesHasBeenSet = false;
543
544 Aws::Vector<ExplicitAuthFlowsType> m_explicitAuthFlows;
545 bool m_explicitAuthFlowsHasBeenSet = false;
546
547 Aws::Vector<Aws::String> m_supportedIdentityProviders;
548 bool m_supportedIdentityProvidersHasBeenSet = false;
549
550 Aws::Vector<Aws::String> m_callbackURLs;
551 bool m_callbackURLsHasBeenSet = false;
552
553 Aws::Vector<Aws::String> m_logoutURLs;
554 bool m_logoutURLsHasBeenSet = false;
555
556 Aws::String m_defaultRedirectURI;
557 bool m_defaultRedirectURIHasBeenSet = false;
558
559 Aws::Vector<OAuthFlowType> m_allowedOAuthFlows;
560 bool m_allowedOAuthFlowsHasBeenSet = false;
561
562 Aws::Vector<Aws::String> m_allowedOAuthScopes;
563 bool m_allowedOAuthScopesHasBeenSet = false;
564
565 bool m_allowedOAuthFlowsUserPoolClient{false};
566 bool m_allowedOAuthFlowsUserPoolClientHasBeenSet = false;
567
568 AnalyticsConfigurationType m_analyticsConfiguration;
569 bool m_analyticsConfigurationHasBeenSet = false;
570
572 bool m_preventUserExistenceErrorsHasBeenSet = false;
573
574 bool m_enableTokenRevocation{false};
575 bool m_enableTokenRevocationHasBeenSet = false;
576
577 bool m_enablePropagateAdditionalUserContextData{false};
578 bool m_enablePropagateAdditionalUserContextDataHasBeenSet = false;
579
580 int m_authSessionValidity{0};
581 bool m_authSessionValidityHasBeenSet = false;
582
583 RefreshTokenRotationType m_refreshTokenRotation;
584 bool m_refreshTokenRotationHasBeenSet = false;
585 };
586
587} // namespace Model
588} // namespace CognitoIdentityProvider
589} // 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