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
 
Configuration options that apply to the entire SDK.

Inheritance Hierarchy

System.Object
  Amazon.AWSConfigs

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

Syntax

C#
public static class AWSConfigs : Object

The AWSConfigs type exposes the following members

Properties

NameTypeDescription
Public Property Static Property AWSProfileName System.String Profile name for stored AWS credentials that will be used to make service calls. Changes to this setting will only take effect in newly-constructed clients.

To reference the account from an application's App.config or Web.config use the AWSProfileName setting.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="development"/>
    </appSettings>
</configuration>
            

Public Property Static Property AWSProfilesLocation System.String Location of the credentials file shared with other AWS SDKs. By default, the credentials file is stored in the .aws directory in the current user's home directory. Changes to this setting will only take effect in newly-constructed clients.

To reference the profile from an application's App.config or Web.config use the AWSProfileName setting.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfilesLocation" value="c:\config"/>
    </appSettings>
</configuration>
            

Public Property Static Property AWSRegion System.String Configures the default AWS region for clients which have not explicitly specified a region. Changes to this setting will only take effect for newly constructed instances of AWS clients. This setting can be configured through the App.config. For example:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws region="us-west-2" />
            
Public Property Static Property ClockOffset System.TimeSpan The calculated clock skew correction, if there is one. This field will be set if a service call resulted in an exception and the SDK has determined that there is a difference between local and server times. If Amazon.AWSConfigs.CorrectForClockSkew is set to true, this value will be set to the correction, but it will not be used by the SDK and clock skew errors will not be retried.
Public Property Static Property CorrectForClockSkew System.Boolean Determines if the SDK should correct for client clock skew by determining the correct server time and reissuing the request with the correct time. Default value of this field is True. Amazon.AWSConfigs.ClockOffset will be updated with the calculated offset even if this field is set to false, though requests will not be corrected or retried.
Public Property Static Property DynamoDBConfig Amazon.Util.DynamoDBConfig Configuration for the DynamoDB section of AWS configuration. Changes to some settings may not take effect until a new client or context is constructed. Example section:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
  <dynamoDB>
    <dynamoDBContext tableNamePrefix="Prod-">
            
      <tableAliases>
        <alias fromTable="FakeTable" toTable="People" />
        <alias fromTable="Persons" toTable="People" />
      </tableAliases>
            
      <mappings>
        <map type="Sample.Tests.Author, SampleDLL" targetTable="People" />
        <map type="Sample.Tests.Editor, SampleDLL" targetTable="People">
          <property name="FullName" attribute="Name" />
          <property name="EmployeeId" attribute="Id" />
          <property name="ComplexData" converter="Sample.Tests.ComplexDataConverter, SampleDLL" />
          <property name="Version" version="true" />
          <property name="Password" ignore="true" />
        </map>
      </mappings>
            
    </dynamoDBContext>
  </dynamoDB>
</aws>
            
Public Property Static Property DynamoDBContextTableNamePrefix System.String Configures the default TableNamePrefix that the DynamoDBContext will use if not manually configured. Changes to this setting will only take effect in newly-constructed instances of DynamoDBContextConfig and DynamoDBContext. The setting can be configured through App.config, for example:
<appSettings>
  <add key="AWS.DynamoDBContext.TableNamePrefix" value="Test-"/>
</appSettings>
            
Public Property Static Property EC2Config Amazon.Util.EC2Config Configuration for the EC2 section of AWS configuration. Changes to some settings may not take effect until a new client is constructed. Example section:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
  <ec2 useSignatureVersion4="true" />
</aws>
            
Public Property Static Property EC2UseSignatureVersion4 System.Boolean Configures if the EC2 client should use Signature Version 4 signing with requests. By default, this setting is false, though Signature Version 4 may be used by default in some cases or with some regions. When the setting is true, Signature Version 4 will be used for all requests. Changes to this setting will only take effect in newly-constructed clients. The setting can be configured through App.config, for example:
<appSettings>
  <add key="AWS.EC2.UseSignatureVersion4" value="true"/>
</appSettings>
            
Public Property Static Property EndpointDefinition System.String Configures if the SDK should use a custom configuration file that defines the regions and endpoints.
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws endpointDefinition="c:\config\endpoints.xml" />
            
Public Property Static Property Logging Amazon.LoggingOptions Configures how the SDK should log events, if at all. Changes to this setting will only take effect in newly-constructed clients. The setting can be configured through App.config, for example:
<appSettings>
  <add key="AWSLogging" value="log4net"/>
</appSettings>
            
Public Property Static Property LoggingConfig Amazon.Util.LoggingConfig Configuration for the Logging section of AWS configuration. Changes to some settings may not take effect until a new client is constructed. Example section:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
  <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" />
</aws>
            
Public Property Static Property LogMetrics System.Boolean Configures if the SDK should log performance metrics. This setting configures the default LogMetrics property for all clients/configs. Changes to this setting will only take effect in newly-constructed clients. The setting can be configured through App.config, for example:
<appSettings>
  <add key="AWSLogMetrics" value="true"/>
</appSettings>
            
Public Property Static Property ProxyConfig Amazon.Util.ProxyConfig Configuration for the Proxy section of AWS configuration. Changes to some settings may not take effect until a new client is constructed. Example section:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
  <proxy host="localhost" port="8888" username="1" password="1" />
</aws>
            
Public Property Static Property RegionEndpoint Amazon.RegionEndpoint Configuration for the region endpoint section of AWS configuration. Changes may not take effect until a new client is constructed. Example section:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws region="us-west-2" />
            
Public Property Static Property ResponseLogging Amazon.ResponseLoggingOption Configures when the SDK should log service responses. Changes to this setting will take effect immediately. The setting can be configured through App.config, for example:
<appSettings>
  <add key="AWSResponseLogging" value="OnError"/>
</appSettings>
            
Public Property Static Property S3Config Amazon.Util.S3Config Configuration for the S3 section of AWS configuration. Changes to some settings may not take effect until a new client is constructed. Example section:
<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK"/>
</configSections>
<aws>
  <s3 useSignatureVersion4="true" />
</aws>
            
Public Property Static Property S3UseSignatureVersion4 System.Boolean Configures if the S3 client should use Signature Version 4 signing with requests. By default, this setting is false, though Signature Version 4 may be used by default in some cases or with some regions. When the setting is true, Signature Version 4 will be used for all requests. Changes to this setting will only take effect in newly-constructed clients. The setting can be configured through App.config, for example:
<appSettings>
  <add key="AWS.S3.UseSignatureVersion4" value="true"/>
</appSettings>
            

Methods

NameDescription
Public Method Static Method AddTraceListener(string, TraceListener) Add a listener for SDK logging.
Public Method Static Method GenerateConfigTemplate() Generates a sample XML representation of the SDK condiguration section.
Public Method Static Method RemoveTraceListener(string, string) Remove a trace listener from SDK logging.

Fields

NameTypeDescription
Field Static Field AWSProfileNameKey System.String Key for the AWSProfileName property. Amazon.AWSConfigs.AWSProfileName
Field Static Field AWSProfilesLocationKey System.String Key for the AWSProfilesLocation property. Amazon.AWSConfigs.LogMetrics
Field Static Field AWSRegionKey System.String Key for the AWSRegion property. Amazon.AWSConfigs.AWSRegion
Field Static Field DynamoDBContextTableNamePrefixKey System.String Key for the DynamoDBContextTableNamePrefix property. Amazon.AWSConfigs.DynamoDBContextTableNamePrefix
Field Static Field EC2UseSignatureVersion4Key System.String Key for the EC2UseSignatureVersion4 property. Amazon.AWSConfigs.EC2UseSignatureVersion4
Field Static Field EndpointDefinitionKey System.String Key for the EndpointDefinition property. Amazon.AWSConfigs.LogMetrics
Field Static Field LoggingKey System.String Key for the Logging property. Amazon.AWSConfigs.Logging
Field Static Field LogMetricsKey System.String Key for the LogMetrics property. Amazon.AWSConfigs.LogMetrics
Field Static Field ResponseLoggingKey System.String Key for the ResponseLogging property. Amazon.AWSConfigs.ResponseLogging
Field Static Field S3UseSignatureVersion4Key System.String Key for the S3UseSignatureVersion4 property. Amazon.AWSConfigs.S3UseSignatureVersion4

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