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.

Configuration for accessing AmazonS3 service

Inheritance Hierarchy

System.Object
  Amazon.Runtime.ClientConfig
    Amazon.S3.AmazonS3Config

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

Syntax

C#
public class AmazonS3Config : ClientConfig
         IClientConfig

The AmazonS3Config type exposes the following members

Constructors

NameDescription
Public Method AmazonS3Config()

Default constructor

Properties

NameTypeDescription
Public Property AllowAutoRedirect System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property AuthenticationRegion System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property AuthenticationServiceName System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property BufferSize System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property ClockOffset System.TimeSpan Inherited from Amazon.Runtime.ClientConfig.
Public Property ConnectionLimit System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property CorrectedUtcNow System.DateTime Inherited from Amazon.Runtime.ClientConfig.
Public Property DisableHostPrefixInjection System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property DisableLogging System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property EndpointDiscoveryCacheLimit System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property EndpointDiscoveryEnabled System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property FastFailRequests System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property ForcePathStyle System.Boolean

When true, requests will always use path style addressing.

Public Property IsMaxErrorRetrySet System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property LogMetrics System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property LogResponse System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property MaxErrorRetry System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property MaxIdleTime System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property ProgressUpdateInterval System.Int64 Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyBypassList System.Collections.Generic.List<System.String> Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyBypassOnLocal System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyCredentials System.Net.ICredentials Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyHost System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property ProxyPort System.Int32 Inherited from Amazon.Runtime.ClientConfig.
Public Property ReadEntireResponse System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property ReadWriteTimeout System.Nullable<System.TimeSpan> Inherited from Amazon.Runtime.ClientConfig.
Public Property RegionEndpoint Amazon.RegionEndpoint Inherited from Amazon.Runtime.ClientConfig.
Public Property RegionEndpointServiceName System.String

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

Public Property ResignRetries System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property RetryMode Amazon.Runtime.RequestRetryMode Inherited from Amazon.Runtime.ClientConfig.
Public Property ServiceURL System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property ServiceVersion System.String

Gets the ServiceVersion property.

Public Property SignatureMethod Amazon.Runtime.SigningAlgorithm Inherited from Amazon.Runtime.ClientConfig.
Public Property SignatureVersion System.String Inherited from Amazon.Runtime.ClientConfig.
Public Property TcpKeepAlive Amazon.Runtime.TcpKeepAlive Inherited from Amazon.Runtime.ClientConfig.
Public Property ThrottleRetries System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property Timeout System.Nullable<System.TimeSpan> Inherited from Amazon.Runtime.ClientConfig.
Public Property UseAccelerateEndpoint System.Boolean

Enables S3 accelerate by sending requests to the accelerate endpoint instead of the regular region endpoint. To use this feature, the bucket name should be DNS compliant names and should not contain periods (.). The following APIs are not supported and are sent to the regular region endpoint, even if this option is enabled:

  1. PutBucket
  2. ListBuckets
  3. DeleteBucket

Public Property UseAlternateUserAgentHeader System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseArnRegion System.Boolean

If set to true and the service package supports it the region identified in the arn for a resource will be used when making the service request.

Public Property USEast1RegionalEndpointValue System.Nullable<Amazon.Runtime.S3UsEast1RegionalEndpointValue>

USEast1RegionalEndpointValue determines wheter or not to send the us-east-1 s3 requests to the regional endpoint or to the legacy global endpoint. This flags takes precedence over the AWS_S3_US_EAST_1_REGIONAL_ENDPOINT environment variable and the credential file.

Public Property UseDualstackEndpoint System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseHttp System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UseNagleAlgorithm System.Boolean Inherited from Amazon.Runtime.ClientConfig.
Public Property UserAgent System.String

Gets the value of 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()

Given this client configuration, returns the service url

Public Method GetWebProxy() Inherited from Amazon.Runtime.ClientConfig.
Public Method SetUseNagleIfAvailable(bool) Inherited from Amazon.Runtime.ClientConfig.
Public Method SetWebProxy(WebProxy) Inherited from Amazon.Runtime.ClientConfig.
Public Method Validate()

Validate that the config object is properly configured.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0, 1.3

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