AWS SDK for C++
AWS SDK for C++
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Aws::S3Crt::ClientConfiguration Struct Reference

#include <ClientConfiguration.h>

+ Inheritance diagram for Aws::S3Crt::ClientConfiguration:

Public Member Functions

 ClientConfiguration ()
 
- Public Member Functions inherited from Aws::S3Crt::S3CrtClientConfiguration
 S3CrtClientConfiguration ()
 
 S3CrtClientConfiguration (const char *profileName)
 
 S3CrtClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy")
 
 S3CrtClientConfiguration (const Client::ClientConfiguration &config, Client::AWSAuthV4Signer::PayloadSigningPolicy iPayloadSigningPolicy=Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, bool iUseVirtualAddressing=true, US_EAST_1_REGIONAL_ENDPOINT_OPTION iUseUSEast1RegionalEndPointOption=US_EAST_1_REGIONAL_ENDPOINT_OPTION::NOT_SET)
 
- Public Member Functions inherited from Aws::Client::GenericClientConfiguration< true >
 GenericClientConfiguration ()
 
 GenericClientConfiguration (const char *profileName)
 
 GenericClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy")
 
 GenericClientConfiguration (const ClientConfiguration &config)
 
 GenericClientConfiguration (const GenericClientConfiguration &)
 
GenericClientConfigurationoperator= (const GenericClientConfiguration &)
 
- Public Member Functions inherited from Aws::Client::ClientConfiguration
 ClientConfiguration ()
 
 ClientConfiguration (const char *profileName)
 
 ClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy")
 

Public Attributes

std::shared_ptr< Aws::Crt::Io::ClientBootstrap > clientBootstrap
 
size_t partSize = 5 * 1024 * 1024
 
std::shared_ptr< Aws::Crt::Io::TlsConnectionOptions > tlsConnectionOptions
 
double throughputTargetGbps = 2.0
 
std::function< void(void *)> clientShutdownCallback
 
void * shutdownCallbackUserData = nullptr
 
- Public Attributes inherited from Aws::S3Crt::S3CrtClientConfiguration
bool useVirtualAddressing = true
 
US_EAST_1_REGIONAL_ENDPOINT_OPTION useUSEast1RegionalEndPointOption = US_EAST_1_REGIONAL_ENDPOINT_OPTION::NOT_SET
 
bool disableMultiRegionAccessPoints = false
 
bool useArnRegion = false
 
Client::AWSAuthV4Signer::PayloadSigningPolicy payloadSigningPolicy = Client::AWSAuthV4Signer::PayloadSigningPolicy::RequestDependent
 
- Public Attributes inherited from Aws::Client::GenericClientConfiguration< true >
bool & enableHostPrefixInjection
 
Aws::Crt::Optional< bool > & enableEndpointDiscovery
 
- Public Attributes inherited from Aws::Client::ClientConfiguration
Aws::String userAgent
 
Aws::Http::Scheme scheme
 
Aws::String region
 
bool useDualStack
 
bool useFIPS
 
unsigned maxConnections
 
long httpRequestTimeoutMs
 
long requestTimeoutMs
 
long connectTimeoutMs
 
bool enableTcpKeepAlive
 
unsigned long tcpKeepAliveIntervalMs
 
unsigned long lowSpeedLimit
 
std::shared_ptr< RetryStrategyretryStrategy
 
Aws::String endpointOverride
 
Aws::Http::Scheme proxyScheme
 
Aws::String proxyHost
 
unsigned proxyPort
 
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::StringnonProxyHosts
 
std::shared_ptr< Aws::Utils::Threading::Executorexecutor
 
bool verifySSL
 
Aws::String caPath
 
Aws::String caFile
 
std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterfacewriteRateLimiter
 
std::shared_ptr< Aws::Utils::RateLimits::RateLimiterInterfacereadRateLimiter
 
Aws::Http::TransferLibType httpLibOverride
 
FollowRedirectsPolicy followRedirects
 
bool disableExpectHeader
 
bool enableClockSkewAdjustment
 
bool enableHostPrefixInjection
 
Aws::Crt::Optional< bool > enableEndpointDiscovery
 
Aws::String profileName
 

Additional Inherited Members

- Public Types inherited from Aws::S3Crt::S3CrtClientConfiguration
using BaseClientConfigClass = Aws::Client::GenericClientConfiguration< true >
 
- 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 Public Attributes inherited from Aws::Client::GenericClientConfiguration< true >
static const bool EndpointDiscoverySupported
 

Detailed Description

Definition at line 20 of file ClientConfiguration.h.

Constructor & Destructor Documentation

◆ ClientConfiguration()

Aws::S3Crt::ClientConfiguration::ClientConfiguration ( )
inline

Definition at line 22 of file ClientConfiguration.h.

Member Data Documentation

◆ clientBootstrap

std::shared_ptr<Aws::Crt::Io::ClientBootstrap> Aws::S3Crt::ClientConfiguration::clientBootstrap

Client bootstrap used for common staples such as event loop group, host resolver, etc.. If this is nullptr, SDK will create a default one for you.

Definition at line 29 of file ClientConfiguration.h.

◆ clientShutdownCallback

std::function<void(void*)> Aws::S3Crt::ClientConfiguration::clientShutdownCallback

Definition at line 45 of file ClientConfiguration.h.

◆ partSize

size_t Aws::S3Crt::ClientConfiguration::partSize = 5 * 1024 * 1024

Size of parts the files will be downloaded or uploaded in. Useful for Put/GetObject APIs defaults to 5MB, if user set it to be less than 5MB, SDK will set it to 5MB.

Definition at line 34 of file ClientConfiguration.h.

◆ shutdownCallbackUserData

void* Aws::S3Crt::ClientConfiguration::shutdownCallbackUserData = nullptr

Definition at line 46 of file ClientConfiguration.h.

◆ throughputTargetGbps

double Aws::S3Crt::ClientConfiguration::throughputTargetGbps = 2.0

Definition at line 42 of file ClientConfiguration.h.

◆ tlsConnectionOptions

std::shared_ptr<Aws::Crt::Io::TlsConnectionOptions> Aws::S3Crt::ClientConfiguration::tlsConnectionOptions

TLS Options to be used for each connection. If scheme is Https and tlsConnectionOptions is null, SDK will create a default one for you.

Definition at line 39 of file ClientConfiguration.h.


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