Aws::S3::S3ClientConfiguration Struct Reference

#include <S3ClientConfiguration.h>

Inheritance diagram for Aws::S3::S3ClientConfiguration:

Public Types
using	BaseClientConfigClass = Aws::Client::GenericClientConfiguration< true >

Public Member Functions
	S3ClientConfiguration ()
	S3ClientConfiguration (const char *profileName)
	S3ClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy")
	S3ClientConfiguration (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 &)
GenericClientConfiguration &	operator= (const GenericClientConfiguration &)
Public Member Functions inherited from Aws::Client::ClientConfiguration
	ClientConfiguration ()
	ClientConfiguration (const char *profileName)
	ClientConfiguration (bool useSmartDefaults, const char *defaultMode="legacy")

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
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< RetryStrategy >	retryStrategy
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::String >	nonProxyHosts
std::shared_ptr< Aws::Utils::Threading::Executor >	executor
bool	verifySSL
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
bool	enableClockSkewAdjustment
bool	enableHostPrefixInjection
Aws::Crt::Optional< bool >	enableEndpointDiscovery
Aws::String	profileName

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 Public Attributes inherited from Aws::Client::GenericClientConfiguration< true >
static const bool	EndpointDiscoverySupported

Detailed Description

Definition at line 24 of file S3ClientConfiguration.h.

Member Typedef Documentation

BaseClientConfigClass

using Aws::S3::S3ClientConfiguration::BaseClientConfigClass = Aws::Client::GenericClientConfiguration<true>

Definition at line 26 of file S3ClientConfiguration.h.

Constructor & Destructor Documentation

S3ClientConfiguration() [1/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration

(

)

S3ClientConfiguration() [2/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration

(

const char *

profileName

)

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

S3ClientConfiguration() [3/4]

Aws::S3::S3ClientConfiguration::S3ClientConfiguration	(	bool	useSmartDefaults,
		const char *	defaultMode = "legacy"
	)

Create a configuration with a predefined smart defaults

Parameters

useSmartDefaults,required	to differentiate c-tors
defaultMode,default	mode to use

S3ClientConfiguration() [4/4]

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

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.

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:

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