ClientConfiguration.h

Go to the documentation of this file.

 
#pragma once
 
#include <aws/core/Core_EXPORTS.h>
#include <aws/core/http/Scheme.h>
#include <aws/core/Region.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/http/HttpTypes.h>
#include <aws/core/utils/Array.h>
#include <aws/crt/Optional.h>
#include <memory>
 
namespace Aws
{
    namespace Utils
    {
        namespace Threading
        {
            class Executor;
        } // namespace Threading
 
        namespace RateLimits
        {
            class RateLimiterInterface;
        } // namespace RateLimits
    } // namespace Utils
    namespace Client
    {
        class RetryStrategy; // forward declare
 
        enum class FollowRedirectsPolicy
        {
            DEFAULT,
            ALWAYS,
            NEVER
        };
 
        struct AWS_CORE_API ClientConfiguration
        {
            ClientConfiguration();
 
            ClientConfiguration(const char* profileName);
 
            explicit ClientConfiguration(bool useSmartDefaults, const char* defaultMode = "legacy");
 
            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;
            Aws::String endpointOverride;
            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;
            bool verifySSL = true;
            Aws::String caPath;
             Aws::String caFile;
            std::shared_ptr<Aws::Utils::RateLimits::RateLimiterInterface> writeRateLimiter;
            std::shared_ptr<Aws::Utils::RateLimits::RateLimiterInterface> readRateLimiter;
            Aws::Http::TransferLibType httpLibOverride;
            FollowRedirectsPolicy followRedirects;
 
            bool disableExpectHeader = false;
 
            bool enableClockSkewAdjustment = true;
 
            bool enableHostPrefixInjection = true;
 
            Aws::Crt::Optional<bool> enableEndpointDiscovery;
 
            Aws::String profileName;
 
            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);
        };
 
        std::shared_ptr<RetryStrategy> InitRetryStrategy(Aws::String retryMode = "");
 
    } // namespace Client
} // namespace Aws