AWSConfigs

The unique application name for the current application. This values is currently used by high level APIs (Mobile Analytics Manager and Cognito Sync Manager) to create a unique file path to store local database files. Changes to this setting will only take effect in newly-constructed objects using this property.

<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK.Core"/>
</configSections>
<aws applicationName="" />
            

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>
            

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>
            

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.Core"/>
</configSections>
<aws region="us-west-2" />
            

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.

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. Ignored if Amazon.AWSConfigs.ManualClockCorrection is set.

Configures if the SDK should use a custom configuration file that defines the regions and endpoints.

<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK.Core"/>
</configSections>
<aws endpointDefinition="c:\config\endpoints.json" />
            

When true the collections used on the service API request and response objects are initialized to an empty collection. The collections are sent as part of requests when a collection is non-empty. Setting InitializeCollections to false means all collections used on the service API request and response objects are initialized to null. The collections are sent as part of requests when the collection non-null including an empty collection. The default value is true. In the next major version of the SDK the default will change to false. This will improve performance not creating unnecessary collection instances and provide more control when the collection is sent to the service. Setting this property is not thread safe and should only be set at application startup.

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>
            

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.Core"/>
</configSections>
<aws>
  <logging logTo="Log4Net, SystemDiagnostics" logResponses="Always" logMetrics="true" />
</aws>
            

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>
            

Manual offset to apply to client clock. This is a global setting that overrides ClockOffset value calculated for all service endpoints.

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.Core"/>
</configSections>
<aws>
  <proxy host="localhost" port="8888" username="1" password="1" bypassList="addressexpr1;addressexpr2;..." bypassOnLocal="true" />
</aws>
            

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.Core"/>
</configSections>
<aws region="us-west-2" />
            

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>
            

Gets or sets the global Amazon.AWSConfigs.TelemetryProvider instance.

This global telemetry provider is used to collect and report telemetry data (such as traces and metrics) for all AWS SDK operations.

When set to true, the service client will use the x-amz-user-agent header instead of the User-Agent header to report version and environment information to the AWS service. Note: This is especially useful when using a platform like WebAssembly which doesn't allow to specify the User-Agent header.

Configures if the SDK Cache should be used, the default value is true.

<configSections>
  <section name="aws" type="Amazon.AWSSection, AWSSDK.Core"/>
</configSections>
<aws useSdkCache="true" />
            

Add a listener for SDK logging.

Generates a sample XML representation of the SDK configuration section.

Remove a trace listener from SDK logging.

Key for the AWSProfileName property. Amazon.AWSConfigs.AWSProfileName

Key for the AWSProfilesLocation property. Amazon.AWSConfigs.LogMetrics

Key for the AWSRegion property. Amazon.AWSConfigs.AWSRegion

Key for the EndpointDefinition property. Amazon.AWSConfigs.EndpointDefinition

Key for the InitializeCollections property. Amazon.AWSConfigs.InitializeCollections

Key for the Logging property. Amazon.AWSConfigs.Logging

Key for the LogMetrics property. Amazon.AWSConfigs.LogMetrics

Key for the ResponseLogging property. Amazon.AWSConfigs.ResponseLogging

Key for the UseSdkCache property. Amazon.AWSConfigs.UseSdkCache