AWSClientAuth::IAWSClientAuthRequests Class Reference

Abstract class for AWS client auth requests. More...

#include <AWSClientAuthBus.h>

Public Member Functions
	AZ_TYPE_INFO (IAWSClientAuthRequests, "{1798CB8B-A334-40BD-913A-4739BF939201}")
virtual std::shared_ptr< Aws::CognitoIdentityProvider::CognitoIdentityProviderClient >	GetCognitoIDPClient ()=0
virtual std::shared_ptr< Aws::CognitoIdentity::CognitoIdentityClient >	GetCognitoIdentityClient ()=0
virtual bool	HasCognitoControllers () const =0

Detailed Description

Abstract class for AWS client auth requests.

Member Function Documentation

GetCognitoIdentityClient()

virtual std::shared_ptr< Aws::CognitoIdentity::CognitoIdentityClient > AWSClientAuth::IAWSClientAuthRequests::GetCognitoIdentityClient ( )

pure virtual

std shared_ptr as the ownership has to be shared with AWS Native SDK.

Returns

AWS Native SDK Cognito Identity client

GetCognitoIDPClient()

virtual std::shared_ptr< Aws::CognitoIdentityProvider::CognitoIdentityProviderClient > AWSClientAuth::IAWSClientAuthRequests::GetCognitoIDPClient ( )

pure virtual

std shared_ptr as the ownership has to be shared with AWS Native SDK.

Returns

AWS Native SDK Cognito IDP client

HasCognitoControllers()

virtual bool AWSClientAuth::IAWSClientAuthRequests::HasCognitoControllers ( ) const

pure virtual

Sanity check for Cognito identity and user controllers to see if they have been configured. Gem will skip set up of controllers when configuration is missing to avoid making calls to Cognito that are guaranteed to fail.

Returns

True, the controllers configured to support user and identify management have been initialized. If False, then either user pool or identity pool configuration is missing. Refer to the Gem documentation about how to provide this configuration.

---

The documentation for this class was generated from the following file:

• Gems/AWSClientAuth/Code/Source/AWSClientAuthBus.h