Configuration for AWS jobs using a specific client type. More...

#include <AWSApiClientJobConfig.h>

Inherits AWSCore::AwsApiJobConfig, and AWSCore::IAwsApiClientJobConfig< ClientType >.

Public Types
using	AwsApiClientJobConfigType = AwsApiClientJobConfig< ClientType >

using	InitializerFunction = AZStd::function< void(AwsApiClientJobConfigType &config)>

Public Types inherited from AWSCore::AwsApiJobConfig
using	InitializerFunction = AZStd::function< void(AwsApiJobConfig &config)>

template<typename T >
using	Override = AZStd::optional< T >
	Type used to encapsulate override values.

Public Member Functions
	AZ_CLASS_ALLOCATOR (AwsApiClientJobConfig, AZ::SystemAllocator)

	AwsApiClientJobConfig (AwsApiJobConfig *defaultConfig=nullptr, InitializerFunction initializer=nullptr)

std::shared_ptr< ClientType >	GetClient () override

Public Member Functions inherited from AWSCore::AwsApiJobConfig
	AZ_CLASS_ALLOCATOR (AwsApiJobConfig, AZ::SystemAllocator)

	AwsApiJobConfig (AwsApiJobConfig *defaultConfig=nullptr, InitializerFunction initializer=nullptr)

virtual void	ApplySettings ()
	Applies settings changes made after first use.

AZ::JobContext *	GetJobContext () override

Aws::Client::ClientConfiguration	GetClientConfiguration () const

virtual AZ::JobContext *	GetJobContext ()=0

virtual std::shared_ptr< ClientType >	GetClient ()=0
	Returns the created AWS client for the Job.

Protected Member Functions
void	ApplySettings () override
	Applies settings changes made after first use.

std::shared_ptr< ClientType >	CreateClient () const

Protected Member Functions inherited from AWSCore::AwsApiJobConfig
void	EnsureSettingsApplied ()
	Ensures that ApplySettings has been called.

template<class ConfigType >
void	Visit (AZStd::function< void(const ConfigType &)> visitor) const

std::shared_ptr< Aws::Auth::AWSCredentialsProvider >	GetCredentialsProvider () const

Additional Inherited Members
Public Attributes inherited from AWSCore::AwsApiJobConfig
Override< AZ::JobContext * >	jobContext

Override< std::shared_ptr< Aws::Auth::AWSCredentialsProvider > >	credentialsProvider

Override< Aws::String >	userAgent

Override< Aws::Http::Scheme >	scheme

Override< Aws::String >	region

Override< unsigned >	maxConnections

Override< long >	requestTimeoutMs

Override< long >	connectTimeoutMs

Override< std::shared_ptr< Aws::Client::RetryStrategy > >	retryStrategy

Override< Aws::String >	endpointOverride

Override< Aws::String >	proxyHost

Override< unsigned >	proxyPort

Override< Aws::String >	proxyUserName

Override< Aws::String >	proxyPassword

Override< std::shared_ptr< Aws::Utils::Threading::Executor > >	executor

Override< bool >	verifySSL

Override< std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > >	writeRateLimiter

Override< std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > >	readRateLimiter

Override< Aws::Http::TransferLibType >	httpLibOverride

Override< bool >	followRedirects

Override< Aws::String >	caFile

Static Protected Member Functions inherited from AWSCore::AwsApiJobConfig
template<typename T >
static void	CheckAndSet (const Override< T > &src, T &dst)
	Helper function for applying Override typed members.

Detailed Description

template<class ClientType>
class AWSCore::AwsApiClientJobConfig< ClientType >

Configuration for AWS jobs using a specific client type.

Constructor & Destructor Documentation

◆ AwsApiClientJobConfig()

template<class ClientType >

AWSCore::AwsApiClientJobConfig< ClientType >::AwsApiClientJobConfig	(	AwsApiJobConfig *	defaultConfig = `nullptr`,
		InitializerFunction	initializer = `nullptr`
	)

inline

Initialize an AwsApiClientJobConfig object.

Parameters

defaultConfig	- the config object that provides values when no override has been set in this object. The default is nullptr, which will cause a default value to be used.
initializer	- a function called to initialize this object. This simplifies the initialization of static instances. The default value is nullptr, in which case no initializer will be called.

Member Function Documentation

◆ ApplySettings()

template<class ClientType >

void AWSCore::AwsApiClientJobConfig< ClientType >::ApplySettings ( )

inlineoverrideprotectedvirtual

Applies settings changes made after first use.

Reimplemented from AWSCore::AwsApiJobConfig.

◆ CreateClient()

template<class ClientType >

std::shared_ptr< ClientType > AWSCore::AwsApiClientJobConfig< ClientType >::CreateClient ( ) const

inlineprotected

Create a client configured using this object's settings. ClientType can be any of the AWS API service clients (e.g. LambdaClient, etc.).

◆ GetClient()

template<class ClientType >

std::shared_ptr< ClientType > AWSCore::AwsApiClientJobConfig< ClientType >::GetClient ( )

inlineoverridevirtual

Gets a client initialized used currently applied settings. If any settings change after first use, code must call ApplySettings before those changes will take effect.

Implements AWSCore::IAwsApiClientJobConfig< ClientType >.

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

Gems/AWSCore/Code/Include/Framework/AWSApiClientJobConfig.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AwsApiClientJobConfig()

Member Function Documentation

◆ ApplySettings()

◆ CreateClient()

◆ GetClient()