S3CrtClientConfiguration.h

 
#pragma once
 
#include <aws/core/auth/signer/AWSAuthV4Signer.h>
#include <aws/core/client/GenericClientConfiguration.h>
#include <aws/crt/io/Bootstrap.h>
#include <aws/crt/io/TlsOptions.h>
#include <aws/io/retry_strategy.h>
#include <aws/s3-crt/S3Crt_EXPORTS.h>
#include <aws/s3-crt/S3ExpressIdentityProvider.h>
 
namespace Aws {
namespace S3Crt {
enum class US_EAST_1_REGIONAL_ENDPOINT_OPTION {
  NOT_SET,
  LEGACY,   // stands for using global endpoint for us-east-1,
  REGIONAL  // stands for using regional endpoint for us-east-1
};
 
struct AWS_S3CRT_API S3CrtClientConfiguration : public Aws::Client::GenericClientConfiguration {
  using BaseClientConfigClass = Aws::Client::GenericClientConfiguration;
 
  S3CrtClientConfiguration(const Client::ClientConfigurationInitValues& configuration = {});
 
  S3CrtClientConfiguration(const char* profileName, bool shouldDisableIMDS = false);
 
  S3CrtClientConfiguration(bool useSmartDefaults, const char* defaultMode = "legacy", bool shouldDisableIMDS = false);
 
  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);
 
  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;
  bool disableS3ExpressAuth = false;
  using IdentityProviderSupplier = std::function<std::shared_ptr<S3ExpressIdentityProvider>(const S3CrtClient&)>;
  IdentityProviderSupplier identityProviderSupplier = [](const S3CrtClient& client) -> std::shared_ptr<S3ExpressIdentityProvider> {
    return Aws::MakeShared<DefaultS3ExpressIdentityProvider>("S3CrtClientConfiguration", client);
  };
 
  /* S3 CRT specifics */
  S3CrtClientConfiguration(const S3CrtClientConfiguration&) = default;
  S3CrtClientConfiguration& operator=(const S3CrtClientConfiguration&) = default;
 
  struct S3CrtConfigFactories {
    std::function<aws_retry_strategy*(const S3Crt::S3CrtClientConfiguration&)> retryStrategyCreateFn;
 
    static S3CrtConfigFactories defaultFactories;
  };
 
  S3CrtConfigFactories crtConfigFactories = S3CrtConfigFactories::defaultFactories;
 
  std::shared_ptr<Aws::Crt::Io::ClientBootstrap> clientBootstrap;
 
  size_t partSize = 8 * 1024 * 1024;
 
  std::shared_ptr<Aws::Crt::Io::TlsConnectionOptions> tlsConnectionOptions;
 
  /* Throughput target in Gbps that we are trying to reach. Normally it's the NIC's throughput */
  double throughputTargetGbps = 10.0;
 
  size_t downloadMemoryUsageWindow = 0;
 
  uint64_t memoryLimitBytes = 0;
 
  /* Callback and associated user data for when the client has completed its shutdown process. */
  std::function<void(void*)> clientShutdownCallback;
  void* shutdownCallbackUserData = nullptr;
 
  struct CrtRetryStrategyConfig {
    enum class CrtRetryStrategyType {
      NOT_SET = 0, /* Defaults to match SDK retry strategy. */
      DEFAULT,
      STANDARD,
      EXPONENTIAL_BACKOFF,
      NO_RETRY = -1,
    } crtRetryStrategyType = CrtRetryStrategyType::NOT_SET;
 
    struct ExponentialBackoffConfig {
      /* Maximum number of request retries. Specifying 0 here will fall back to the default set by aws-c-io. */
      size_t maxRetries = 0;
 
      /* Scale factor (in milliseconds) for the back-off value. */
      uint32_t scaleFactorMs = 500;
 
      /* Maximum delay between retries (in seconds). Specifying 0 here will fall back to the default set by aws-c-io. */
      uint32_t maxBackoffSecs = 20;
    } config;
  } crtRetryStrategyConfig;
 
  size_t multipartUploadThreshold{0};
 
  Aws::Vector<Aws::String> networkInterfaceNames;
 
  enum class CONTENT_LENGTH_CONFIGURATION {
    SEEK_STREAM,
    SKIP_CONTENT_LENGTH,
  } contentLengthConfiguration{CONTENT_LENGTH_CONFIGURATION::SEEK_STREAM};
  /* End of S3 CRT specifics */
 private:
  void LoadS3CrtSpecificConfig(const Aws::String& profileName);
};
}  // namespace S3Crt
}  // namespace Aws