AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
This class is the base class of all the configurations settings to connect to a service.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.ClientConfig

Namespace: Amazon.Runtime
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public abstract class ClientConfig : Object

The ClientConfig type exposes the following members

Constructors

NameDescription
Public Method ClientConfig()

Properties

NameTypeDescription
Public Property AuthenticationRegion System.String 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.
Public Property AuthenticationServiceName System.String Gets and sets the AuthenticationServiceName property. Used in AWS4 request signing, this is the short-form name of the service being called.
Public Property BufferSize System.Int32 Gets and Sets the BufferSize property. The BufferSize controls the buffer used to read in from input streams and write out to the request.
Public Property ConnectionLimit System.Int32 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.
Public Property LogMetrics System.Boolean Flag on whether to log metrics for service calls. This can be set in the application's configs, as below:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSLogMetrics" value"true"/>
    </appSettings>
</configuration>
            
Public Property LogResponse System.Boolean Gets and sets the LogResponse. If this property is set to true, the service response is read in its entirety and logged.
Public Property MaxErrorRetry System.Int32 Gets and sets of the MaxErrorRetry property.
Public Property MaxIdleTime System.Int32 Gets and sets the max idle time set on the ServicePoint for the WebRequest. Default value is 50 seconds (50,000 ms) unless ServicePointManager.MaxServicePointIdleTime is set, in which case ServicePointManager.MaxServicePointIdleTime will be used as the default.
Public Property ProgressUpdateInterval System.Int64

Gets or sets the interval at which progress update events are raised for upload operations. By default, the progress update events are raised at every 100KB of data transferred.

If the value of this property is set less than ClientConfig.BufferSize, progress updates events will be raised at the interval specified by ClientConfig.BufferSize.

Public Property ProxyCredentials System.Net.ICredentials Credentials to use with a proxy.
Public Property ProxyHost System.String Gets and sets of the ProxyHost property.
Public Property ProxyPort System.Int32 Gets and sets of the ProxyPort property.
Public Property ReadEntireResponse System.Boolean Gets and sets the ReadEntireResponse. If this property is set to true, the service response is read in its entirety before being processed.
Public Property ReadWriteTimeout System.Nullable<System.TimeSpan> Overrides the default read-write timeout value.
Public Property RegionEndpoint Amazon.RegionEndpoint Gets and sets the RegionEndpoint property. The region constant to use that determines the endpoint to use. If this is not set then the client will fallback to the value of ServiceURL.
Public Property ServiceURL System.String Gets and sets of the ServiceURL property. This is an optional property; change it only if you want to try a different service endpoint.
Public Property ServiceVersion System.String Gets Service Version
Public Property SignatureMethod Amazon.Runtime.SigningAlgorithm Gets and sets of the signatureMethod property.
Public Property SignatureVersion System.String Gets and sets of the SignatureVersion property.
Public Property Timeout System.Nullable<System.TimeSpan> Overrides the default request timeout value.
Public Property UseHttp System.Boolean Gets and sets the UseHttp. If this property is set to true, the client attempts to use HTTP protocol, if the target endpoint supports it. By default, this property is set to false.
Public Property UseNagleAlgorithm System.Boolean 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 than ServicePoint.UseNagleAlgorithm which is optimized for large responses like web pages or images.
Public Property UserAgent System.String Gets and sets of the UserAgent property.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8