适用于 .NET 的 AWS SDK的配置文件参考

您可以使用 .NET 项目的 App.config 或 Web.config 文件指定 AWS 设置（如 AWS 凭证、日志记录选项、AWS 服务端点和 AWS 区域）以及某些 AWS 服务设置（例如 Amazon DynamoDB、Amazon EC2 和 Amazon S3）。以下信息介绍了如何正确设置 App.config 或 Web.config 文件的格式，以指定这些设置类型。

声明 AWS 设置部分

您可以通过 <aws> 元素指定 App.config 或 Web.config 文件中的 AWS 设置。在开始使用 <aws> 元素之前，您必须先创建一个 <section> 元素 (<configSections> 元素的子元素) 并将其 name 属性和 aws 属性分别设置为 type 和 Amazon.AWSSection, AWSSDK.Core (如以下示例所示)：

<?xml version="1.0"?>
<configuration>
  ...
  <configSections>
    <section name="aws" type="Amazon.AWSSection, AWSSDK.Core"/>
  </configSections>
  <aws>
    <!-- Add your desired AWS settings declarations here. -->
  </aws>
  ...
</configuration>

Visual Studio 编辑器提供针对 <aws> 元素或其子元素的自动代码完成 (IntelliSense)。

调用 <aws> 方法可帮助您创建 Amazon.AWSConfigs.GenerateConfigTemplate 元素格式正确的版本。这将以美观打印字符串形式输出 <aws> 元素的规范版本，可调整该字符串以满足您的需求。以下部分介绍 <aws> 元素的属性和子元素。

允许的元素

以下是 AWS 设置部分中允许的元素之间的逻辑关系列表。要生成此列表的最新版本，您可以调用 Amazon.AWSConfigs.GenerateConfigTemplate 方法，这将以字符串形式输出 <aws> 元素的规范版本，可调整该字符串以满足您的需求。

<aws
  endpointDefinition="string value"
  region="string value"
  profileName="string value"
  profilesLocation="string value">
  <logging
    logTo="None, Log4Net, SystemDiagnostics"
    logResponses="Never | OnError | Always"
    logMetrics="true | false"
    logMetricsFormat="Standard | JSON"
    logMetricsCustomFormatter="NameSpace.Class, Assembly" />
  <dynamoDB
    conversionSchema="V1 | V2">
    <dynamoDBContext
      tableNamePrefix="string value">
      <tableAliases>
        <alias
          fromTable="string value"
          toTable="string value" />
      </tableAliases>
      <map
        type="NameSpace.Class, Assembly"
        targetTable="string value">
        <property
          name="string value"
          attribute="string value"
          ignore="true | false"
          version="true | false"
          converter="NameSpace.Class, Assembly" />
      </map>
    </dynamoDBContext>
  </dynamoDB>
  <s3
    useSignatureVersion4="true | false" />
  <ec2
    useSignatureVersion4="true | false" />
  <proxy
    host="string value"
    port="1234"
    username="string value"
    password="string value" />
</aws>

元素参考

下面是 AWS 设置部分允许的元素列表。对于每个元素，将列出其允许的属性和父-子元素。

别名

<alias> 元素表示集合中的一个项，该集合包含一个或多个源表到目标表的映射，用于指定与为某一类型配置的表不同的表。此元素将从Amazon.Util.TableAlias中的 Amazon.AWSConfigs.DynamoDBConfig.Context.TableAliases 属性映射到 适用于 .NET 的 AWS SDK 类的实例。在应用表名称前缀之前，将执行重新映射。

此元素可以包含以下属性：

<alias> 元素的父级为 <tableAliases> 元素。

<alias> 元素不包含子元素。

以下是使用中的 <alias> 元素的示例：

<alias
  fromTable="Studio"
  toTable="Studios" />

aws

<aws> 元素表示 AWS 设置部分中的最顶层元素。此元素可以包含以下属性：

<aws> 元素没有父元素。

<aws> 元素可包含以下子元素：

以下是使用中的 <aws> 元素的示例：

<aws
  endpointDefinition="C:\Configs\endpoints.xml"
  region="us-west-2"
  profileName="development"
  profilesLocation="C:\Configs">
  <!-- ... -->
</aws>

dynamoDB

<dynamoDB> 元素表示一组 Amazon DynamoDB 设置。此元素可以包含 conversionSchema 属性，该属性表示在 .NET 和 DynamoDB 对象之间进行转换所用的版本。允许的值包括 V1 和 V2。此属性映射到Amazon.DynamoDBv2.DynamoDBEntryConversion中的 适用于 .NET 的 AWS SDK 类。有关更多信息，请参阅 DynamoDB 系列 - 转换架构。

<dynamoDB> 元素的父级为 <aws> 元素。

<dynamoDB> 元素可以包含 <dynamoDBContext> 子元素。

以下是使用中的 <dynamoDB> 元素的示例：

<dynamoDB
  conversionSchema="V2">
  <!-- ... -->
</dynamoDB>

dynamoDBContext

<dynamoDBContext> 元素表示一组 Amazon DynamoDB 上下文特定的设置。此元素可以包含 tableNamePrefix 属性，它表示 DynamoDB 上下文将使用的默认表名前缀 (如果未手动配置此前缀)。此属性从Amazon.Util.DynamoDBContextConfig.TableNamePrefix中的 Amazon.AWSConfigs.DynamoDBConfig.Context.TableNamePrefix 属性映射到 适用于 .NET 的 AWS SDK 属性。有关更多信息，请参阅 DynamoDB 开发工具包的增强功能。

<dynamoDBContext> 元素的父级为 <dynamoDB> 元素。

<dynamoDBContext> 元素可包含以下子元素：

以下是使用中的 <dynamoDBContext> 元素的示例：

<dynamoDBContext
  tableNamePrefix="Test-">
  <!-- ... -->
</dynamoDBContext>

ec2

<ec2> 元素表示 Amazon EC2 设置的集合。此元素可以包含 useSignatureVersion4 属性，该属性指定签名版本 4 签名用于所有请求 (true) 还是不用于所有请求 (false，默认值)。此属性从Amazon.Util.EC2Config.UseSignatureVersion4中的 Amazon.AWSConfigs.EC2Config.UseSignatureVersion4 属性映射到 适用于 .NET 的 AWS SDK 属性。

<ec2> 元素的父级为该元素。

<ec2> 元素不包含子元素。

以下是使用中的 <ec2> 元素的示例：

<ec2
  useSignatureVersion4="true" />

logging

<logging> 元素表示一组用于响应日志记录和性能指标日志记录的设置。此元素可以包含以下属性：

<logging> 元素的父级为 <aws> 元素。

<logging> 元素不包含子元素。

以下是使用中的 <logging> 元素的示例：

<logging
  logTo="SystemDiagnostics"
  logResponses="OnError"
  logMetrics="true"
  logMetricsFormat="JSON"
  logMetricsCustomFormatter="MyLib.Util.MyMetricsFormatter, MyLib" />

映射

<map> 元素表示从 .NET 类型到 DynamoDB 表的类型-表映射集合中的单个项（从TypeMapping中的 Amazon.AWSConfigs.DynamoDBConfig.Context.TypeMappings 属性映射到 适用于 .NET 的 AWS SDK 类的实例）。有关更多信息，请参阅 DynamoDB 开发工具包的增强功能。

此元素可以包含以下属性：

<map> 元素的父级为 <dynamoDBContext> 元素。

<map> 元素可包含 <property> 子元素的一个或多个实例。

以下是使用中的 <map> 元素的示例：

<map
  type="SampleApp.Models.Movie, SampleDLL"
  targetTable="Movies">
  <!-- ... -->
</map>

property

<property> 元素表示 DynamoDB 属性。（此元素从适用于 .NET 的 AWS SDK中的 AddProperty 方法映射到 Amazon.Util.PropertyConfig 类的实例）有关更多信息，请参阅 DynamoDB 开发工具包的增强功能和 DynamoDB 属性。

此元素可以包含以下属性：

<property> 元素的父级为 <map> 元素。

<property> 元素不包含子元素。

以下是使用中的 <property> 元素的示例：

<property
  name="Rating"
  converter="SampleApp.Models.RatingConverter, SampleDLL" />

proxy

<proxy> 元素表示用于配置代理以供适用于 .NET 的 AWS SDK使用的设置。此元素可以包含以下属性：

<proxy> 元素的父级为 <aws> 元素。

<proxy> 元素不包含子元素。

以下是使用中的 <proxy> 元素的示例：

<proxy
  host="192.0.2.0"
  port="1234"
  username="My-Username-Here"
  password="My-Password-Here" />

S3

<s3> 元素表示 Amazon S3 设置的集合。此元素可以包含 useSignatureVersion4 属性，该属性指定签名版本 4 签名用于所有请求 (true) 还是不用于所有请求 (false，默认值)。此属性映射到Amazon.AWSConfigs.S3Config.UseSignatureVersion4中的 适用于 .NET 的 AWS SDK 属性。

<s3> 元素的父级为 <aws> 元素。

<s3> 元素不包含子元素。

以下是使用中的 <s3> 元素的示例：

<s3 useSignatureVersion4="true" />