ClientConfiguration.h

 
#pragma once
 
#include <aws/core/Core_EXPORTS.h>
#include <aws/core/Region.h>
#include <aws/core/http/HttpTypes.h>
#include <aws/core/http/Scheme.h>
#include <aws/core/http/Version.h>
#include <aws/core/utils/Array.h>
#include <aws/core/utils/StringUtils.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/crt/Optional.h>
#include <smithy/tracing/TelemetryProvider.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
        };
 
        enum class UseRequestCompression
        {
          DISABLE,
          ENABLE,
        };
 
        enum class RequestChecksumCalculation {
          WHEN_SUPPORTED,
          WHEN_REQUIRED,
        };
 
        enum class ResponseChecksumValidation {
          WHEN_SUPPORTED,
          WHEN_REQUIRED,
        };
 
        enum class HttpClientChunkedMode {
          DEFAULT,
          CLIENT_IMPLEMENTATION,
        };
 
        struct RequestCompressionConfig {
          UseRequestCompression useRequestCompression=UseRequestCompression::ENABLE;
          size_t requestMinCompressionSizeBytes = 10240;
        };
        struct ClientConfigurationInitValues {
            bool shouldDisableIMDS = false;
        };
 
        struct AWS_CORE_API ClientConfiguration
        {
            struct ProviderFactories
            {
                std::function<std::shared_ptr<RetryStrategy>()> retryStrategyCreateFn;
                std::function<std::shared_ptr<Utils::Threading::Executor>()> executorCreateFn;
                std::function<std::shared_ptr<Utils::RateLimits::RateLimiterInterface>()> writeRateLimiterCreateFn;
                std::function<std::shared_ptr<Utils::RateLimits::RateLimiterInterface>()> readRateLimiterCreateFn;
                std::function<std::shared_ptr<smithy::components::tracing::TelemetryProvider>()> telemetryProviderCreateFn;
 
                static ProviderFactories defaultFactories;
            };
 
            ClientConfiguration();
 
            ClientConfiguration(const ClientConfigurationInitValues &configuration);
 
            ClientConfiguration(const char* profileName, bool shouldDisableIMDS = false);
 
            explicit ClientConfiguration(bool useSmartDefaults, const char* defaultMode = "legacy", bool shouldDisableIMDS = false);
 
            virtual ~ClientConfiguration() = default;
 
            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;
 
            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);
 
            std::shared_ptr<smithy::components::tracing::TelemetryProvider> telemetryProvider;
 
            struct WinHTTPOptions {
              bool useAnonymousAuth = false;
            } winHTTPOptions;
 
          Aws::String accountId;
 
          Aws::String accountIdEndpointMode = "preferred";
 
          HttpClientChunkedMode httpClientChunkedMode = HttpClientChunkedMode::CLIENT_IMPLEMENTATION;
          struct CredentialProviderConfiguration {
            Aws::String profile;
 
            Aws::String region;
 
            struct {
              long metadataServiceNumAttempts = 1;
              
              long metadataServiceTimeout = 1;
 
              std::shared_ptr<RetryStrategy> imdsRetryStrategy;
              bool disableImdsV1;
              bool disableImds;
            } imdsConfig;
 
            struct STSCredentialsCredentialProviderConfiguration {
              STSCredentialsCredentialProviderConfiguration() = default;
              STSCredentialsCredentialProviderConfiguration(const Aws::String& role, const Aws::String& session, const String& tokenFile)
                  : roleArn(role), sessionName(session), tokenFilePath(tokenFile) {};
              Aws::String roleArn;
              Aws::String sessionName;
              Aws::String tokenFilePath;
 
              std::chrono::milliseconds retrieveCredentialsFutureTimeout = std::chrono::seconds(10);
 
              std::chrono::milliseconds credentialCacheCacheTTL = std::chrono::minutes(50);
            } stsCredentialsProviderConfig;
            struct LoginProviderConfig {
              Aws::String loginSession{};
 
              Aws::String loginCacheOverride{};
 
              std::chrono::milliseconds retrieveCredentialsFutureTimeout = std::chrono::seconds(10);
            } loginCredentialProviderConfig;
          } credentialProviderConfig;
 
          Aws::Vector<Aws::String> authPreferences;
        };
 
        AWS_CORE_API std::shared_ptr<RetryStrategy> InitRetryStrategy(Aws::String retryMode = "");
        AWS_CORE_API std::shared_ptr<RetryStrategy> InitRetryStrategy(int maxRetries, Aws::String retryMode = "");
 
        AWS_CORE_API Aws::String ComputeUserAgentString(ClientConfiguration const * const pConfig = nullptr);
 
        AWS_CORE_API Aws::String FilterUserAgentToken(char const * const token);
    } // namespace Client
} // namespace Aws