/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace CognitoIdentity { namespace Model { /** *

An object representing an Amazon Cognito identity pool.

See * Also:

AWS * API Reference

*/ class DescribeIdentityPoolResult { public: AWS_COGNITOIDENTITY_API DescribeIdentityPoolResult(); AWS_COGNITOIDENTITY_API DescribeIdentityPoolResult(const Aws::AmazonWebServiceResult& result); AWS_COGNITOIDENTITY_API DescribeIdentityPoolResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

An identity pool ID in the format REGION:GUID.

*/ inline const Aws::String& GetIdentityPoolId() const{ return m_identityPoolId; } /** *

An identity pool ID in the format REGION:GUID.

*/ inline void SetIdentityPoolId(const Aws::String& value) { m_identityPoolId = value; } /** *

An identity pool ID in the format REGION:GUID.

*/ inline void SetIdentityPoolId(Aws::String&& value) { m_identityPoolId = std::move(value); } /** *

An identity pool ID in the format REGION:GUID.

*/ inline void SetIdentityPoolId(const char* value) { m_identityPoolId.assign(value); } /** *

An identity pool ID in the format REGION:GUID.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolId(const Aws::String& value) { SetIdentityPoolId(value); return *this;} /** *

An identity pool ID in the format REGION:GUID.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolId(Aws::String&& value) { SetIdentityPoolId(std::move(value)); return *this;} /** *

An identity pool ID in the format REGION:GUID.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolId(const char* value) { SetIdentityPoolId(value); return *this;} /** *

A string that you provide.

*/ inline const Aws::String& GetIdentityPoolName() const{ return m_identityPoolName; } /** *

A string that you provide.

*/ inline void SetIdentityPoolName(const Aws::String& value) { m_identityPoolName = value; } /** *

A string that you provide.

*/ inline void SetIdentityPoolName(Aws::String&& value) { m_identityPoolName = std::move(value); } /** *

A string that you provide.

*/ inline void SetIdentityPoolName(const char* value) { m_identityPoolName.assign(value); } /** *

A string that you provide.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolName(const Aws::String& value) { SetIdentityPoolName(value); return *this;} /** *

A string that you provide.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolName(Aws::String&& value) { SetIdentityPoolName(std::move(value)); return *this;} /** *

A string that you provide.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolName(const char* value) { SetIdentityPoolName(value); return *this;} /** *

TRUE if the identity pool supports unauthenticated logins.

*/ inline bool GetAllowUnauthenticatedIdentities() const{ return m_allowUnauthenticatedIdentities; } /** *

TRUE if the identity pool supports unauthenticated logins.

*/ inline void SetAllowUnauthenticatedIdentities(bool value) { m_allowUnauthenticatedIdentities = value; } /** *

TRUE if the identity pool supports unauthenticated logins.

*/ inline DescribeIdentityPoolResult& WithAllowUnauthenticatedIdentities(bool value) { SetAllowUnauthenticatedIdentities(value); return *this;} /** *

Enables or disables the Basic (Classic) authentication flow. For more * information, see Identity * Pools (Federated Identities) Authentication Flow in the Amazon Cognito * Developer Guide.

*/ inline bool GetAllowClassicFlow() const{ return m_allowClassicFlow; } /** *

Enables or disables the Basic (Classic) authentication flow. For more * information, see Identity * Pools (Federated Identities) Authentication Flow in the Amazon Cognito * Developer Guide.

*/ inline void SetAllowClassicFlow(bool value) { m_allowClassicFlow = value; } /** *

Enables or disables the Basic (Classic) authentication flow. For more * information, see Identity * Pools (Federated Identities) Authentication Flow in the Amazon Cognito * Developer Guide.

*/ inline DescribeIdentityPoolResult& WithAllowClassicFlow(bool value) { SetAllowClassicFlow(value); return *this;} /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline const Aws::Map& GetSupportedLoginProviders() const{ return m_supportedLoginProviders; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline void SetSupportedLoginProviders(const Aws::Map& value) { m_supportedLoginProviders = value; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline void SetSupportedLoginProviders(Aws::Map&& value) { m_supportedLoginProviders = std::move(value); } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& WithSupportedLoginProviders(const Aws::Map& value) { SetSupportedLoginProviders(value); return *this;} /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& WithSupportedLoginProviders(Aws::Map&& value) { SetSupportedLoginProviders(std::move(value)); return *this;} /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(const Aws::String& key, const Aws::String& value) { m_supportedLoginProviders.emplace(key, value); return *this; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(Aws::String&& key, const Aws::String& value) { m_supportedLoginProviders.emplace(std::move(key), value); return *this; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(const Aws::String& key, Aws::String&& value) { m_supportedLoginProviders.emplace(key, std::move(value)); return *this; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(Aws::String&& key, Aws::String&& value) { m_supportedLoginProviders.emplace(std::move(key), std::move(value)); return *this; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(const char* key, Aws::String&& value) { m_supportedLoginProviders.emplace(key, std::move(value)); return *this; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(Aws::String&& key, const char* value) { m_supportedLoginProviders.emplace(std::move(key), value); return *this; } /** *

Optional key:value pairs mapping provider names to provider app IDs.

*/ inline DescribeIdentityPoolResult& AddSupportedLoginProviders(const char* key, const char* value) { m_supportedLoginProviders.emplace(key, value); return *this; } /** *

The "domain" by which Cognito will refer to your users.

*/ inline const Aws::String& GetDeveloperProviderName() const{ return m_developerProviderName; } /** *

The "domain" by which Cognito will refer to your users.

*/ inline void SetDeveloperProviderName(const Aws::String& value) { m_developerProviderName = value; } /** *

The "domain" by which Cognito will refer to your users.

*/ inline void SetDeveloperProviderName(Aws::String&& value) { m_developerProviderName = std::move(value); } /** *

The "domain" by which Cognito will refer to your users.

*/ inline void SetDeveloperProviderName(const char* value) { m_developerProviderName.assign(value); } /** *

The "domain" by which Cognito will refer to your users.

*/ inline DescribeIdentityPoolResult& WithDeveloperProviderName(const Aws::String& value) { SetDeveloperProviderName(value); return *this;} /** *

The "domain" by which Cognito will refer to your users.

*/ inline DescribeIdentityPoolResult& WithDeveloperProviderName(Aws::String&& value) { SetDeveloperProviderName(std::move(value)); return *this;} /** *

The "domain" by which Cognito will refer to your users.

*/ inline DescribeIdentityPoolResult& WithDeveloperProviderName(const char* value) { SetDeveloperProviderName(value); return *this;} /** *

The ARNs of the OpenID Connect providers.

*/ inline const Aws::Vector& GetOpenIdConnectProviderARNs() const{ return m_openIdConnectProviderARNs; } /** *

The ARNs of the OpenID Connect providers.

*/ inline void SetOpenIdConnectProviderARNs(const Aws::Vector& value) { m_openIdConnectProviderARNs = value; } /** *

The ARNs of the OpenID Connect providers.

*/ inline void SetOpenIdConnectProviderARNs(Aws::Vector&& value) { m_openIdConnectProviderARNs = std::move(value); } /** *

The ARNs of the OpenID Connect providers.

*/ inline DescribeIdentityPoolResult& WithOpenIdConnectProviderARNs(const Aws::Vector& value) { SetOpenIdConnectProviderARNs(value); return *this;} /** *

The ARNs of the OpenID Connect providers.

*/ inline DescribeIdentityPoolResult& WithOpenIdConnectProviderARNs(Aws::Vector&& value) { SetOpenIdConnectProviderARNs(std::move(value)); return *this;} /** *

The ARNs of the OpenID Connect providers.

*/ inline DescribeIdentityPoolResult& AddOpenIdConnectProviderARNs(const Aws::String& value) { m_openIdConnectProviderARNs.push_back(value); return *this; } /** *

The ARNs of the OpenID Connect providers.

*/ inline DescribeIdentityPoolResult& AddOpenIdConnectProviderARNs(Aws::String&& value) { m_openIdConnectProviderARNs.push_back(std::move(value)); return *this; } /** *

The ARNs of the OpenID Connect providers.

*/ inline DescribeIdentityPoolResult& AddOpenIdConnectProviderARNs(const char* value) { m_openIdConnectProviderARNs.push_back(value); return *this; } /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline const Aws::Vector& GetCognitoIdentityProviders() const{ return m_cognitoIdentityProviders; } /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline void SetCognitoIdentityProviders(const Aws::Vector& value) { m_cognitoIdentityProviders = value; } /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline void SetCognitoIdentityProviders(Aws::Vector&& value) { m_cognitoIdentityProviders = std::move(value); } /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline DescribeIdentityPoolResult& WithCognitoIdentityProviders(const Aws::Vector& value) { SetCognitoIdentityProviders(value); return *this;} /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline DescribeIdentityPoolResult& WithCognitoIdentityProviders(Aws::Vector&& value) { SetCognitoIdentityProviders(std::move(value)); return *this;} /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline DescribeIdentityPoolResult& AddCognitoIdentityProviders(const CognitoIdentityProvider& value) { m_cognitoIdentityProviders.push_back(value); return *this; } /** *

A list representing an Amazon Cognito user pool and its client ID.

*/ inline DescribeIdentityPoolResult& AddCognitoIdentityProviders(CognitoIdentityProvider&& value) { m_cognitoIdentityProviders.push_back(std::move(value)); return *this; } /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline const Aws::Vector& GetSamlProviderARNs() const{ return m_samlProviderARNs; } /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline void SetSamlProviderARNs(const Aws::Vector& value) { m_samlProviderARNs = value; } /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline void SetSamlProviderARNs(Aws::Vector&& value) { m_samlProviderARNs = std::move(value); } /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline DescribeIdentityPoolResult& WithSamlProviderARNs(const Aws::Vector& value) { SetSamlProviderARNs(value); return *this;} /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline DescribeIdentityPoolResult& WithSamlProviderARNs(Aws::Vector&& value) { SetSamlProviderARNs(std::move(value)); return *this;} /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline DescribeIdentityPoolResult& AddSamlProviderARNs(const Aws::String& value) { m_samlProviderARNs.push_back(value); return *this; } /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline DescribeIdentityPoolResult& AddSamlProviderARNs(Aws::String&& value) { m_samlProviderARNs.push_back(std::move(value)); return *this; } /** *

An array of Amazon Resource Names (ARNs) of the SAML provider for your * identity pool.

*/ inline DescribeIdentityPoolResult& AddSamlProviderARNs(const char* value) { m_samlProviderARNs.push_back(value); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline const Aws::Map& GetIdentityPoolTags() const{ return m_identityPoolTags; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline void SetIdentityPoolTags(const Aws::Map& value) { m_identityPoolTags = value; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline void SetIdentityPoolTags(Aws::Map&& value) { m_identityPoolTags = std::move(value); } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolTags(const Aws::Map& value) { SetIdentityPoolTags(value); return *this;} /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& WithIdentityPoolTags(Aws::Map&& value) { SetIdentityPoolTags(std::move(value)); return *this;} /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(const Aws::String& key, const Aws::String& value) { m_identityPoolTags.emplace(key, value); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(Aws::String&& key, const Aws::String& value) { m_identityPoolTags.emplace(std::move(key), value); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(const Aws::String& key, Aws::String&& value) { m_identityPoolTags.emplace(key, std::move(value)); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(Aws::String&& key, Aws::String&& value) { m_identityPoolTags.emplace(std::move(key), std::move(value)); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(const char* key, Aws::String&& value) { m_identityPoolTags.emplace(key, std::move(value)); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(Aws::String&& key, const char* value) { m_identityPoolTags.emplace(std::move(key), value); return *this; } /** *

The tags that are assigned to the identity pool. A tag is a label that you * can apply to identity pools to categorize and manage them in different ways, * such as by purpose, owner, environment, or other criteria.

*/ inline DescribeIdentityPoolResult& AddIdentityPoolTags(const char* key, const char* value) { m_identityPoolTags.emplace(key, value); return *this; } inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline DescribeIdentityPoolResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline DescribeIdentityPoolResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline DescribeIdentityPoolResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_identityPoolId; Aws::String m_identityPoolName; bool m_allowUnauthenticatedIdentities; bool m_allowClassicFlow; Aws::Map m_supportedLoginProviders; Aws::String m_developerProviderName; Aws::Vector m_openIdConnectProviderARNs; Aws::Vector m_cognitoIdentityProviders; Aws::Vector m_samlProviderARNs; Aws::Map m_identityPoolTags; Aws::String m_requestId; }; } // namespace Model } // namespace CognitoIdentity } // namespace Aws