AWS SDK for C++  0.12.9
AWS SDK for C++
Public Member Functions | Public Attributes | List of all members
Aws::Client::ClientConfiguration Struct Reference

#include <ClientConfiguration.h>

Public Member Functions

 ClientConfiguration ()

Public Attributes

Aws::String userAgent
Aws::Http::Scheme scheme
Aws::Region region
Aws::String authenticationRegion
unsigned maxConnections
long requestTimeoutMs
long connectTimeoutMs
std::shared_ptr< RetryStrategyretryStrategy
Aws::String endpointOverride
Aws::String proxyHost
unsigned proxyPort
Aws::String proxyUserName
Aws::String proxyPassword
std::shared_ptr< Aws::Utils::Threading::Executorexecutor
bool verifySSL
Aws::String caPath
std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterfacewriteRateLimiter
std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterfacereadRateLimiter
Aws::Http::TransferLibType httpLibOverride
bool followRedirects

Detailed Description

This mutable structure is used to configure any of the AWS clients. Default values can only be overwritten prior to passing to the client constructors.

Definition at line 48 of file ClientConfiguration.h.

Constructor & Destructor Documentation

Aws::Client::ClientConfiguration::ClientConfiguration ( )

Member Data Documentation

Aws::String Aws::Client::ClientConfiguration::authenticationRegion

if customRegion is set you have to also specify an endpoint override, if it is not set, we fallback to region.

Definition at line 66 of file ClientConfiguration.h.

Aws::String Aws::Client::ClientConfiguration::caPath

If your Certificate Authority path is different from the default, you can tell curl where to find your CA trust store.

Definition at line 117 of file ClientConfiguration.h.

long Aws::Client::ClientConfiguration::connectTimeoutMs

Socket connect timeout. Default 1000 ms. Unless you are very far away from your the data center you are talking to. 1000ms is more than sufficient.

Definition at line 79 of file ClientConfiguration.h.

Aws::String Aws::Client::ClientConfiguration::endpointOverride

override the http endpoint used to talk to a service. Use this in conjunction with authenticationRegion.

Definition at line 87 of file ClientConfiguration.h.

std::shared_ptr<Aws::Utils::Threading::Executor> Aws::Client::ClientConfiguration::executor

Threading Executor implementation. Default uses std::thread::detach()

Definition at line 107 of file ClientConfiguration.h.

bool Aws::Client::ClientConfiguration::followRedirects

If set to true the http stack will follow 300 redirect codes.

Definition at line 133 of file ClientConfiguration.h.

Aws::Http::TransferLibType Aws::Client::ClientConfiguration::httpLibOverride

Override the http implementation the default factory returns.

Definition at line 129 of file ClientConfiguration.h.

unsigned Aws::Client::ClientConfiguration::maxConnections

Max concurrent tcp connections for a single http client to use. Default 25.

Definition at line 70 of file ClientConfiguration.h.

Aws::String Aws::Client::ClientConfiguration::proxyHost

If you have users going through a proxy, set the host here.

Definition at line 91 of file ClientConfiguration.h.

Aws::String Aws::Client::ClientConfiguration::proxyPassword

If you have users going through a proxy, set the password here.

Definition at line 103 of file ClientConfiguration.h.

unsigned Aws::Client::ClientConfiguration::proxyPort

If you have users going through a proxy, set the port here.

Definition at line 95 of file ClientConfiguration.h.

Aws::String Aws::Client::ClientConfiguration::proxyUserName

If you have users going through a proxy, set the username here.

Definition at line 99 of file ClientConfiguration.h.

std::shared_ptr<Aws::Utils::RateLimits::RateLimiterInterface> Aws::Client::ClientConfiguration::readRateLimiter

Rate Limiter implementation for incoming bandwidth. Default is wide-open.

Definition at line 125 of file ClientConfiguration.h.

Aws::Region Aws::Client::ClientConfiguration::region

AWS Region to use in signing requests. Default US_EAST_1

Definition at line 62 of file ClientConfiguration.h.

long Aws::Client::ClientConfiguration::requestTimeoutMs

Socket read timeouts. Default 3000 ms. This should be more than adequate for most services. However, if you are transfering large amounts of data or are worried about higher latencies, you should set to something that makes more sense for your use case.

Definition at line 75 of file ClientConfiguration.h.

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

Strategy to use in case of failed requests. Default is DefaultRetryStrategy (e.g. exponential backoff)

Definition at line 83 of file ClientConfiguration.h.

Aws::Http::Scheme Aws::Client::ClientConfiguration::scheme

Http scheme to use. E.g. Http or Https. Default HTTPS

Definition at line 58 of file ClientConfiguration.h.

Aws::String Aws::Client::ClientConfiguration::userAgent

User Agent string user for http calls. This is filled in for you in the constructor. Don't override this unless you have a really good reason.

Definition at line 54 of file ClientConfiguration.h.

bool Aws::Client::ClientConfiguration::verifySSL

If you need to test and want to get around TLS validation errors, do that here. you probably shouldn't use this flag in a production scenario.

Definition at line 112 of file ClientConfiguration.h.

std::shared_ptr<Aws::Utils::RateLimits::RateLimiterInterface> Aws::Client::ClientConfiguration::writeRateLimiter

Rate Limiter implementation for outgoing bandwidth. Default is wide-open.

Definition at line 121 of file ClientConfiguration.h.

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