Aws::Client::GenericClientConfiguration Struct Reference

#include <GenericClientConfiguration.h>

Inheritance diagram for Aws::Client::GenericClientConfiguration:

Public Member Functions

 GenericClientConfiguration (const ClientConfigurationInitValues &configuration={})

 

 GenericClientConfiguration (const char *inputProfileName, bool shouldDisableIMDS=false)

 

 GenericClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy", bool shouldDisableIMDS=false)

 

 GenericClientConfiguration (const ClientConfiguration &config)

 

Public Member Functions inherited from Aws::Client::ClientConfiguration

 ClientConfiguration ()

 

 ClientConfiguration (const ClientConfigurationInitValues &configuration)

 

 ClientConfiguration (const char *profileName, bool shouldDisableIMDS=false)

 

 ClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy", bool shouldDisableIMDS=false)

 

virtual ~ClientConfiguration ()=default

 

CredentialProviderConfiguration ResolveCredentialProviderConfig () const

 

Additional Inherited Members

Static Public Member Functions inherited from Aws::Client::ClientConfiguration

static Aws::String LoadConfigFromEnvOrProfile (const Aws::String &envKey, const Aws::String &profile, const Aws::String &profileProperty, const Aws::Vector< Aws::String > &allowedValues, const Aws::String &defaultValue)

 

static Aws::String LoadConfigFromEnvOrProfileCaseSensitive (const Aws::String &envKey, const Aws::String &profile, const Aws::String &profileProperty, const Aws::Vector< Aws::String > &allowedValues, const Aws::String &defaultValue, const std::function< Aws::String(const char *)> &envValueMapping=Utils::StringUtils::ToLower)

 

Public Attributes inherited from Aws::Client::ClientConfiguration

ProviderFactories configFactories = ProviderFactories::defaultFactories

 

Aws::String userAgent

 

Aws::Http::Scheme scheme

 

Aws::String region

 

bool useDualStack = false

 

bool useFIPS = false

 

unsigned maxConnections = 25

 

long httpRequestTimeoutMs = 0

 

long requestTimeoutMs = 0

 

long connectTimeoutMs = 1000

 

bool enableTcpKeepAlive = true

 

unsigned long tcpKeepAliveIntervalMs = 30000

 

unsigned long lowSpeedLimit = 1

 

std::shared_ptr< RetryStrategy > retryStrategy = nullptr

 

Aws::String endpointOverride

 

bool allowSystemProxy = false

 

Aws::Http::Scheme proxyScheme

 

Aws::String proxyHost

 

unsigned proxyPort = 0

 

Aws::String proxyUserName

 

Aws::String proxyPassword

 

Aws::String proxySSLCertPath

 

Aws::String proxySSLCertType

 

Aws::String proxySSLKeyPath

 

Aws::String proxySSLKeyType

 

Aws::String proxySSLKeyPassword

 

Aws::Utils::Array< Aws::String > nonProxyHosts

 

std::shared_ptr< Aws::Utils::Threading::Executor > executor = nullptr

 

bool verifySSL = true

 

Aws::String caPath

 

Aws::String proxyCaPath

 

Aws::String caFile

 

Aws::String proxyCaFile

 

std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > writeRateLimiter = nullptr

 

std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterface > readRateLimiter = nullptr

 

Aws::Http::TransferLibType httpLibOverride

 

Aws::Http::TransferLibPerformanceMode httpLibPerfMode = Http::TransferLibPerformanceMode::LOW_LATENCY

 

FollowRedirectsPolicy followRedirects

 

bool disableExpectHeader = false

 

bool enableClockSkewAdjustment = true

 

bool enableHostPrefixInjection = true

 

Aws::Crt::Optional< bool > enableEndpointDiscovery

 

bool enableHttpClientTrace = false

 

Aws::String profileName

 

Aws::Client::RequestCompressionConfig requestCompressionConfig

 

bool disableIMDS = false

 

Aws::Http::Version version = Http::Version::HTTP_VERSION_2TLS

 

bool disableImdsV1 = false

 

Aws::String appId

 

struct { 

 

   RequestChecksumCalculation   requestChecksumCalculation = RequestChecksumCalculation::WHEN_SUPPORTED 

 

   ResponseChecksumValidation   responseChecksumValidation = ResponseChecksumValidation::WHEN_SUPPORTED 

 

} checksumConfig 

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > telemetryProvider

 

struct Aws::Client::ClientConfiguration::WinHTTPOptions winHTTPOptions

 

struct Aws::Client::ClientConfiguration::CurlOptions curlOptions

 

Aws::String accountId

 

Aws::String accountIdEndpointMode = "preferred"

 

HttpClientChunkedMode httpClientChunkedMode = HttpClientChunkedMode::CLIENT_IMPLEMENTATION

 

struct Aws::Client::ClientConfiguration::CredentialProviderConfiguration credentialProviderConfig

 

Aws::Vector< Aws::String > authPreferences

 

Aws::Vector< Aws::String > sigV4aSigningRegionSet

 

size_t awsChunkedBufferSize = 64UL * 1024

 

Detailed Description

This mutable structure is used to configure a regular AWS client.

Definition at line 18 of file GenericClientConfiguration.h.

Constructor & Destructor Documentation

GenericClientConfiguration() [1/4]

Aws::Client::GenericClientConfiguration::GenericClientConfiguration ( const ClientConfigurationInitValues &  configuration = {})

inline

Definition at line 20 of file GenericClientConfiguration.h.

GenericClientConfiguration() [2/4]

Aws::Client::GenericClientConfiguration::GenericClientConfiguration ( const char *  inputProfileName,

bool  shouldDisableIMDS = false 

)

inline

Create a configuration based on settings in the aws configuration file for the given profile name. The configuration file location can be set via the environment variable AWS_CONFIG_FILE

Parameters

profileName	the aws profile name.
shouldDisableIMDS	whether or not to disable IMDS calls.

Definition at line 30 of file GenericClientConfiguration.h.

GenericClientConfiguration() [3/4]

Aws::Client::GenericClientConfiguration::GenericClientConfiguration ( bool  useSmartDefaults,

const char *  defaultMode = "legacy",

bool  shouldDisableIMDS = false 

)

inlineexplicit

Create a configuration with a predefined smart defaults

Parameters

useSmartDefaults,required	to differentiate c-tors
defaultMode,default	mode to use
shouldDisableIMDS	whether or not to disable IMDS calls.

Definition at line 40 of file GenericClientConfiguration.h.

GenericClientConfiguration() [4/4]

Aws::Client::GenericClientConfiguration::GenericClientConfiguration ( const ClientConfiguration &  config)

inline

Definition at line 44 of file GenericClientConfiguration.h.

---

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

• src/aws-cpp-sdk-core/include/aws/core/client/GenericClientConfiguration.h