AWS SDK for .NET Documentation
ClientConfig Class
AmazonAmazon.RuntimeClientConfig Did this page help you?   Yes   No    Tell us about it...
This class is the base class of all the configurations settings to connect to a service.
Declaration Syntax
C#
public abstract class ClientConfig
Members
All MembersMethodsProperties



IconMemberDescription
AuthenticationRegion
Gets and sets the AuthenticationRegion property. Used in AWS4 request signing, this is an optional property; change it only if the region cannot be determined from the service endpoint.

AuthenticationServiceName
Gets and sets the AuthenticationServiceName property. Used in AWS4 request signing, this is the short-form name of the service being called.

BufferSize
Gets and Sets the BufferSize property. The BufferSize controls the buffer used to read in from input streams and write out to the request.

ConnectionLimit
Gets and sets the connection limit set on the ServicePoint for the WebRequest. Default value is 50 connections unless ServicePointManager.DefaultConnectionLimit is set in which case ServicePointManager.DefaultConnectionLimit will be used as the default.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
LogMetrics
Flag on whether to log metrics for service calls. This can be set in the application's configs, as below:
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSLogMetrics" value"true"/>
    </appSettings>
</configuration>

LogResponse
Gets and sets the LogResponse. If this property is set to true, the service response is read in its entirety and logged.

MaxErrorRetry
Gets and sets of the MaxErrorRetry property.

Protocol
Network protocol to use with the request. This value is ignored if the ServiceURL is specified or if RegionEndpoint is set and the service/endpoint does not support the specified protocol. Default is HTTPS.

ProxyCredentials
Credentials to use with a proxy.

ProxyHost
Gets and sets of the ProxyHost property.

ProxyPassword Obsolete.
Gets and sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server.

ProxyPort
Gets and sets of the ProxyPort property.

ProxyUsername Obsolete.
Gets and sets the ProxyUsername property. Used in conjunction with the ProxyPassword property to authenticate requests with the specified Proxy server.

ReadEntireResponse
Gets and sets the ReadEntireResponse. If this property is set to true, the service response is read in its entirety before being processed.

RegionEndpoint
Gets and sets the RegionEndpoint property. This value is the region constant that determines the service endpoint to use. If this value is not set, then the client will use the value of ServiceURL.

ServiceURL
Gets and sets the ServiceURL property. This value specifies the endpoint to access with the client. ServiceURL is ignored if RegionEndpoint is set. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http.

ServiceVersion
Gets Service Version

SignatureMethod
Gets and sets of the signatureMethod property.

SignatureVersion
Gets and sets of the SignatureVersion property.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UseNagleAlgorithm
Gets or sets a Boolean value that determines whether the Nagle algorithm is used on connections managed by the ServicePoint object used for requests to AWS. This is defaulted to false for lower latency with responses that return small amount of data. This is the opposite default then ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images.

UserAgent
Gets and sets of the UserAgent property.

UseSecureStringForAwsSecretKey
Gets and Sets the UseSecureStringForAwsSecretKey property. By default, the AWS Secret Access Key is stored in a SecureString (true) - this is one of the secure ways to store a secret provided by the .NET Framework. But, the use of SecureStrings is not supported in Medium Trust Windows Hosting environments. If you are building an ASP.NET application that needs to run with Medium Trust, set this property to false, and the client will not save your AWS Secret Key in a secure string. Changing the default to false can result in the Secret Key being vulnerable; please use this property judiciously.

Inheritance Hierarchy

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)