#include <AWSApiJobConfig.h>

Inherited by AWSCore::AwsApiClientJobConfig< ClientType >, and AWSCore::HttpRequestJobConfig.

Public Types
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 (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

Public Attributes
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

Protected Member Functions
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

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

Detailed Description

Encapsulates all the properties that can be used to configured the operation of AWS jobs.

Constructor & Destructor Documentation

◆ AwsApiJobConfig()

AWSCore::AwsApiJobConfig::AwsApiJobConfig	(	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()

virtual void AWSCore::AwsApiJobConfig::ApplySettings ( )

virtual

Applies settings changes made after first use.

Reimplemented in AWSCore::AwsApiClientJobConfig< ClientType >, AWSCore::HttpRequestJobConfig, AWSCore::ServiceJobConfig, and AWSCore::ServiceRequestJobConfig< RequestType >.

◆ GetClientConfiguration()

Aws::Client::ClientConfiguration AWSCore::AwsApiJobConfig::GetClientConfiguration ( ) const

Get a ClientConfiguration object initialized using the current settings. The base settings object's overrides are applied first, then this objects overrides are applied. By default all ClientConfiguration members will have default values (as set by the

◆ GetCredentialsProvider()

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

protected

Get the CredentialsProvider from this settings object, if set, or from the base settings object. By default a nullptr is returned.

◆ GetJobContext()

AZ::JobContext * AWSCore::AwsApiJobConfig::GetJobContext ( )

overridevirtual

Implements AWSCore::IAwsApiJobConfig.

◆ Visit()

template<class ConfigType >

void AWSCore::AwsApiJobConfig::Visit ( AZStd::function< void(const ConfigType &)> visitor ) const

inlineprotected

Call Visit for m_defaultConfig, then call visitor for this object. Is templated so that it can be used to visit derived types as long as they define an m_defaultConfig of that type.

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

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions