Open 3D Engine AWSClientAuth Gem API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AWSClientAuth::IAWSCognitoAuthorizationRequests Class Referenceabstract

Abstract class for AWS Cognito authorization requests. More...

#include <AWSCognitoAuthorizationBus.h>

Public Member Functions

 AZ_TYPE_INFO (IAWSCognitoAuthorizationRequests, "{F60A2C40-48F5-49A1-ABFA-A08D0DD4ECCC}")
 
virtual bool Initialize ()=0
 
virtual void Reset ()=0
 
virtual AZStd::string GetIdentityId ()=0
 
virtual bool HasPersistedLogins ()=0
 
virtual std::shared_ptr< Aws::Auth::AWSCredentialsProvider > GetCognitoCredentialsProvider ()=0
 
virtual std::shared_ptr< Aws::Auth::AWSCredentialsProvider > GetAnonymousCognitoCredentialsProvider ()=0
 
virtual void RequestAWSCredentialsAsync ()=0
 

Detailed Description

Abstract class for AWS Cognito authorization requests.

Member Function Documentation

◆ GetAnonymousCognitoCredentialsProvider()

virtual std::shared_ptr<Aws::Auth::AWSCredentialsProvider> AWSClientAuth::IAWSCognitoAuthorizationRequests::GetAnonymousCognitoCredentialsProvider ( )
pure virtual

Returns anonymous AWSCredentialsProvider to initialize up AWS Native SDK clients. std::shared_ptr to allow sharing ownership with AWS Native SDK.

Returns
std::shared_ptr for Aws::Auth::AWSCredentialProvider.

◆ GetCognitoCredentialsProvider()

virtual std::shared_ptr<Aws::Auth::AWSCredentialsProvider> AWSClientAuth::IAWSCognitoAuthorizationRequests::GetCognitoCredentialsProvider ( )
pure virtual

Returns AWSCredentialsProvider to initialize up AWS Native SDK clients. std::shared_ptr to allow sharing ownership with AWS Native SDK.

Returns
std::shared_ptr for Aws::Auth::AWSCredentialProvider.

◆ GetIdentityId()

virtual AZStd::string AWSClientAuth::IAWSCognitoAuthorizationRequests::GetIdentityId ( )
pure virtual

Get cached Cognito identity id from last successful GetId call to Cognito.

Returns
Cognito identity id

◆ HasPersistedLogins()

virtual bool AWSClientAuth::IAWSCognitoAuthorizationRequests::HasPersistedLogins ( )
pure virtual

Checks if logins are persisted.

Returns
True if logins persists else false.

◆ Initialize()

virtual bool AWSClientAuth::IAWSCognitoAuthorizationRequests::Initialize ( )
pure virtual

Initializes settings for Cognito identity pool from settings registry.

Parameters
settingsRegistryPathPath for the settings registry file to use.

◆ RequestAWSCredentialsAsync()

virtual void AWSClientAuth::IAWSCognitoAuthorizationRequests::RequestAWSCredentialsAsync ( )
pure virtual

Get cached AWS credentials or fetch credentials from Cognito. Will fetch authenticated role credentials if login are cached else fetches unauthenticated role credentials if enabled in Cognito Identity pool. If multiple logins are persisted and no cached credentials found, GetId call to Cognito will link the login provider to same identity.

◆ Reset()

virtual void AWSClientAuth::IAWSCognitoAuthorizationRequests::Reset ( )
pure virtual

Once credentials provider are set they cannot be reset. So recreates new Cognito credentials provider on reset. Service clients need to be created with the new AWSCredentialsProvider after reset.


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