AWS SDK for .NET Documentation
AmazonS3Config Class
AmazonAmazon.S3AmazonS3Config Did this page help you?   Yes   No    Tell us about it...
Configuration for Amazon S3 Client.
Declaration Syntax
C#
public class AmazonS3Config
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
AmazonS3Config()()()()
Initializes a new instance of the AmazonS3Config class

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.

CommunicationProtocol
Gets and Sets the property that determines whether the HTTP or HTTPS protocol is used to make requests to the S3 service. By default Protocol.HTTPS is used to communicate with S3.

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.)
MaxErrorRetry
Gets and sets the MaxErrorRetry property.

ProxyCredentials
Credentials to use with a proxy.

ProxyHost
Gets and sets 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 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.

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.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UserAgent
Gets and sets the UserAgent property.

UseSecureStringForAwsSecretKey
Gets and Sets the UseSecureString 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.

WithCommunicationProtocol(Protocol) Obsolete.
Sets the Protocol property. Valid values are Protocol.HTTP and Protocol.HTTPS. Default is Protocol.HTTPS.

WithMaxErrorRetry(Int32) Obsolete.
Sets the MaxErrorRetry property

WithProxyCredentials(ICredentials) Obsolete.
Sets the ProxyCredentials property.

WithProxyHost(String) Obsolete.
Sets the ProxyHost property

WithProxyPassword(String) Obsolete.
Sets the ProxyPassword property. Used in conjunction with the ProxyUsername property to authenticate requests with the specified Proxy server.

WithProxyPort(Int32) Obsolete.
Sets the ProxyPort property

WithProxyUsername(String) Obsolete.
Sets the ProxyUsername property

WithServiceURL(String) Obsolete.
Sets the ServiceURL property

WithUserAgent(String) Obsolete.
Sets the UserAgent property

WithUseSecureStringForAwsSecretKey(Boolean) Obsolete.
Sets the UseSecureString 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
Object
AmazonS3Config

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