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.

A defaults mode determines how certain default configuration options are resolved in the SDK. Based on the provided mode, the SDK will vend sensible default values tailored to the specific Amazon.Runtime.DefaultConfigurationMode.

All options above can be configured by users, and the overridden value will take precedence.

Note: for any mode other than Amazon.Runtime.DefaultConfigurationMode.Legacy, the vended default values might change as best practices may evolve. As a result, it is encouraged to perform testing when upgrading the SDK if you are using a mode other than Amazon.Runtime.DefaultConfigurationMode.Legacy.

While the Amazon.Runtime.DefaultConfigurationMode.Legacy defaults mode is specific to .NET, other modes are standardized across all of the AWS SDKs.

The defaults mode can be configured: When constructing an Amazon.Runtime.AmazonServiceClient implementation by setting Amazon.Runtime.ClientConfig.DefaultConfigurationMode. Globally via the "AWS_DEFAULTS_MODE" environment variable. On a configuration profile via the "defaults_mode" profile file property.

Inheritance Hierarchy

Amazon.Runtime.IDefaultConfiguration

Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C#
public interface IDefaultConfiguration

The IDefaultConfiguration type exposes the following members

Properties

NameTypeDescription
Public Property ConnectTimeout System.Nullable<System.TimeSpan>

The amount of time after making an initial connect attempt on a socket, where if the client does not receive a completion of the connect handshake, the client gives up and fails the operation.

Public Property HttpRequestTimeout System.Nullable<System.TimeSpan>

This timeout measures the time between when the first byte is sent over an established, open connection and when the last byte is received from the service. If the response is not received by the timeout, then the request is considered timed out.

Public Property Name Amazon.Runtime.DefaultConfigurationMode

Identifies a specific configuration mode. Example legacy, mobile, cross-region, etc

Public Property RetryMode Amazon.Runtime.RequestRetryMode

A retry mode specifies how the SDK attempts retries. See https://docs.aws.amazon.com/sdkref/latest/guide/setting-global-retry_mode.html

Public Property S3UsEast1RegionalEndpoint Amazon.Runtime.S3UsEast1RegionalEndpointValue

Specifies how the SDK determines the AWS service endpoint that it uses to talk to the Amazon S3 for the us-east-1 region

Public Property StsRegionalEndpoints Amazon.Runtime.StsRegionalEndpointsValue

Specifies how the SDK determines the AWS service endpoint that it uses to talk to the AWS Security Token Service (AWS STS). See https://docs.aws.amazon.com/sdkref/latest/guide/setting-global-sts_regional_endpoints.html

Public Property TimeToFirstByteTimeout System.Nullable<System.TimeSpan>

How long an application will attempt to read the first byte over an established, open connection after write request before timing out.

Public Property TlsNegotiationTimeout System.Nullable<System.TimeSpan>

The maximum amount of time that a TLS handshake is allowed to take from the time the CLIENT HELLO message is sent to the client and server have fully negotiated ciphers and exchanged keys

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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