AWS SDK Version 3 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.

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.Core.dll
Version: 3.x.y.z

Syntax

C#
public abstract class ClientConfig
         IClientConfig

The ClientConfig type exposes the following members

Constructors

NameDescription
Public Method ClientConfig()

Properties

NameTypeDescription
Public Property AllowAutoRedirect System.Boolean

This flag controls if .NET HTTP infrastructure should follow redirection responses (e.g. HTTP 307 - temporary redirect).

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 DisableLogging System.Boolean

Gets and sets the DisableLogging. If true logging for this client will be disabled.

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:



    
        
    

            

Public Property LogResponse System.Boolean

Gets and sets the LogResponse property. If this property is set to true, the service response is logged. The size of response being logged is controlled by the AWSConfigs.LoggingConfig.LogResponsesSizeLimit property.

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 ProxyBypassList System.Collections.Generic.List<System.String>

Gets and sets the ProxyBypassList property; a collection of regular expressions denoting the set of endpoints for which the configured proxy host will be bypassed.

Public Property ProxyBypassOnLocal System.Boolean

Gets and sets the ProxyBypassOnLocal property. If set true requests to local addresses bypass the configured proxy.

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 the ProxyPort property.

Public Property ReadEntireResponse System.Boolean

Gets and sets the ReadEntireResponse property. NOTE: This property does not effect response processing and is deprecated. To enable response logging, the ClientConfig.LogResponse and AWSConfigs.LoggingConfig properties can be used.

Public Property ReadWriteTimeout System.Nullable<System.TimeSpan>

Overrides the default read-write timeout value. On Unity platform, this value is not used as Unity HTTP client does not support timeouts, so

Public Property RegionEndpoint Amazon.RegionEndpoint

Gets and sets the RegionEndpoint property. The region constant that determines the endpoint to use. Setting this property to null will force the SDK to recaculate the RegionEndpoint value based on App/WebConfig, environment ariables, profile, etc.

Public Property RegionEndpointServiceName System.String

The constant used to lookup in the region hash the endpoint.

Public Property ResignRetries System.Boolean

Flag on whether to resign requests on retry or not.

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. Note: This property exists for backward compatibility but is no longer used by any service other than S3.

Public Property ThrottleRetries System.Boolean

Enable or disable the Retry Throttling feature by setting the ThrottleRetries flag to True/False resepctively. Retry Throttling is a feature that intelligently throttles retry attempts when a large precentage of requests are failing and retries are unsuccessful as well. In such situations the allotted retry capacity for the service URL will be drained until requests start to succeed again. Once the requisite capacity is available, retries would be permitted again. When retries are throttled, the service enters a fail-fast behaviour as the traditional retry attempt for the request would be circumvented. Hence, errors will resurface quickly. This will result in a greated number of exceptions but prevents requests being tied up in unsuccessful retry attempts. Note: Retry Throttling is enabled by default. Set the ThrottleRetries flag to false to switch off this feature.

Public Property Timeout System.Nullable<System.TimeSpan>
Public Property UseDualstackEndpoint System.Boolean

Configures the endpoint calculation for a service to go to a dual stack (ipv6 enabled) endpoint for the configured region.

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.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DetermineServiceURL()
Public Method Static Method GetTimeoutValue(Nullable<TimeSpan>, Nullable<TimeSpan>)

Returns the request timeout value if its value is set, else returns client timeout value.

Public Method GetWebProxy()

Returns a WebProxy instance configured to match the proxy settings in the client configuration.

Public Method SetUseNagleIfAvailable(bool)

Enable or disable the Nagle algorithm on the underlying http client. This method is not intended to be called by consumers of the AWS SDK for .NET

Public Method SetWebProxy(WebProxy)

Unpacks the host, port and any credentials info into the instance's proxy-related fields.

Public Method Validate()

Performs validation on this config object. Throws exception if any of the required values are missing/invalid.

Public Method Static Method ValidateTimeout(Nullable<TimeSpan>)

Fields

NameTypeDescription
Field Static Field MaxTimeout System.TimeSpan

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone