Aws::S3::S3ClientConfiguration Struct Reference

#include <S3ClientConfiguration.h>

Inheritance diagram for Aws::S3::S3ClientConfiguration:

Public Types

using BaseClientConfigClass = Aws::Client::GenericClientConfiguration

 

using IdentityProviderSupplier = std::function< std::shared_ptr< S3ExpressIdentityProvider >(const S3Client &)>

 

Public Member Functions

 S3ClientConfiguration (const Aws::Client::ClientConfigurationInitValues &configuration={})

 

 S3ClientConfiguration (const char *profileName, bool shouldDisableIMDS=false)

 

 S3ClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy", bool shouldDisableIMDS=false)

 

 S3ClientConfiguration (const Aws::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

 GenericClientConfiguration (const ClientConfigurationInitValues &configuration={})

 

 GenericClientConfiguration (const char *inputProfileName, bool shouldDisableIMDS=false)

 

 GenericClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy", bool shouldDisableIMDS=false)

 

 GenericClientConfiguration (const ClientConfiguration &config)

 

Public Member Functions inherited from Aws::Client::ClientConfiguration

 ClientConfiguration ()

 

 ClientConfiguration (const ClientConfigurationInitValues &configuration)

 

 ClientConfiguration (const char *profileName, bool shouldDisableIMDS=false)

 

 ClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy", bool shouldDisableIMDS=false)

 

virtual ~ClientConfiguration ()=default

 

Public Attributes

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

 

IdentityProviderSupplier identityProviderSupplier

 

Public Attributes inherited from Aws::Client::ClientConfiguration

ProviderFactories configFactories

 

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< RetryStrategy > retryStrategy

 

Aws::String endpointOverride

 

bool allowSystemProxy

 

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::String > nonProxyHosts

 

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

 

bool verifySSL

 

Aws::String caPath

 

Aws::String proxyCaPath

 

Aws::String caFile

 

Aws::String proxyCaFile

 

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

 

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

 

Aws::Http::TransferLibType httpLibOverride

 

Aws::Http::TransferLibPerformanceMode httpLibPerfMode

 

FollowRedirectsPolicy followRedirects

 

bool disableExpectHeader

 

bool enableClockSkewAdjustment

 

bool enableHostPrefixInjection

 

Aws::Crt::Optional< bool > enableEndpointDiscovery

 

bool enableHttpClientTrace

 

Aws::String profileName

 

Aws::Client::RequestCompressionConfig requestCompressionConfig

 

bool disableIMDS

 

Aws::Http::Version version

 

bool disableImdsV1

 

Aws::String appId

 

RequestChecksumCalculation requestChecksumCalculation

 

ResponseChecksumValidation responseChecksumValidation

 

struct Aws::Client::ClientConfiguration:: { ... }  checksumConfig

 

std::shared_ptr< smithy::components::tracing::TelemetryProvider > telemetryProvider

 

struct Aws::Client::ClientConfiguration::WinHTTPOptions winHTTPOptions

 

Aws::String accountId

 

Aws::String accountIdEndpointMode

 

HttpClientChunkedMode httpClientChunkedMode

 

struct Aws::Client::ClientConfiguration::CredentialProviderConfiguration credentialProviderConfig

 

Aws::Vector< Aws::String > authPreferences

 

size_t awsChunkedBufferSize

 

Additional Inherited Members

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 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)

 

Detailed Description

Definition at line 21 of file S3ClientConfiguration.h.

Member Typedef Documentation

BaseClientConfigClass

using Aws::S3::S3ClientConfiguration::BaseClientConfigClass = Aws::Client::GenericClientConfiguration

Definition at line 22 of file S3ClientConfiguration.h.

IdentityProviderSupplier

using Aws::S3::S3ClientConfiguration::IdentityProviderSupplier = std::function<std::shared_ptr<S3ExpressIdentityProvider>(const S3Client&)>

Definition at line 57 of file S3ClientConfiguration.h.

Constructor & Destructor Documentation

S3ClientConfiguration() [1/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration ( const Aws::Client::ClientConfigurationInitValues &  configuration = {})

S3ClientConfiguration() [2/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration ( const char *  profileName,

bool  shouldDisableIMDS = false 

)

Create a configuration based on settings in the aws configuration file for the given profile name. The configuration file location can be set via the environment variable AWS_CONFIG_FILE

Parameters

profileName	the aws profile name.
shouldDisableIMDS	whether or not to disable IMDS calls.

S3ClientConfiguration() [3/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration ( bool  useSmartDefaults,

const char *  defaultMode = "legacy",

bool  shouldDisableIMDS = false 

)

Create a configuration with a predefined smart defaults

Parameters

useSmartDefaults,required	to differentiate c-tors
defaultMode,default	mode to use
shouldDisableIMDS	whether or not to disable IMDS calls.

S3ClientConfiguration() [4/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration ( const Aws::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 

)

Converting constructors for compatibility with a legacy code

Member Data Documentation

disableMultiRegionAccessPoints

bool Aws::S3::S3ClientConfiguration::disableMultiRegionAccessPoints = false

Definition at line 53 of file S3ClientConfiguration.h.

disableS3ExpressAuth

bool Aws::S3::S3ClientConfiguration::disableS3ExpressAuth = false

Definition at line 56 of file S3ClientConfiguration.h.

identityProviderSupplier

IdentityProviderSupplier Aws::S3::S3ClientConfiguration::identityProviderSupplier

Initial value:

= [](const S3Client& client) -> std::shared_ptr<S3ExpressIdentityProvider> {
    return Aws::MakeShared<DefaultS3ExpressIdentityProvider>("S3ClientConfiguration", client);
  }

Definition at line 58 of file S3ClientConfiguration.h.

payloadSigningPolicy

Client::AWSAuthV4Signer::PayloadSigningPolicy Aws::S3::S3ClientConfiguration::payloadSigningPolicy = Client::AWSAuthV4Signer::PayloadSigningPolicy::RequestDependent

Definition at line 55 of file S3ClientConfiguration.h.

useArnRegion

bool Aws::S3::S3ClientConfiguration::useArnRegion = false

Definition at line 54 of file S3ClientConfiguration.h.

useUSEast1RegionalEndPointOption

US_EAST_1_REGIONAL_ENDPOINT_OPTION Aws::S3::S3ClientConfiguration::useUSEast1RegionalEndPointOption = US_EAST_1_REGIONAL_ENDPOINT_OPTION::NOT_SET

Definition at line 52 of file S3ClientConfiguration.h.

useVirtualAddressing

bool Aws::S3::S3ClientConfiguration::useVirtualAddressing = true

Definition at line 51 of file S3ClientConfiguration.h.

---

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

• generated/src/aws-cpp-sdk-s3/include/aws/s3/S3ClientConfiguration.h