Référence des fichiers de configuration pour AWS SDK pour .NET - AWS SDK pour .NET (V3)

La version 4 (V4) du AWS SDK pour .NET est sortie !

Pour commencer à utiliser la nouvelle version du SDK, consultez le guide du développeur AWS SDK pour .NET (V4), en particulier la rubrique relative à la migration vers la version 4.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Référence des fichiers de configuration pour AWS SDK pour .NET

Note

Les informations contenues dans cette rubrique sont spécifiques aux projets basés sur .NET Framework. Les Web.config fichiers App.config et ne sont pas présents par défaut dans les projets basés sur .NET Core.

Vous pouvez utiliser un projet App.config ou un Web.config fichier .NET pour spécifier des AWS paramètres, tels que les AWS informations d'identification, les options de journalisation, les points de terminaison de AWS service et AWS les régions, ainsi que certains paramètres pour AWS des services tels qu'Amazon DynamoDB EC2, Amazon et Amazon S3. Vous trouverez ci-dessous des informations expliquant comment mettre correctement en forme un fichier App.config ou Web.config pour spécifier ces types de paramètres.

Note

Bien que vous puissiez continuer à utiliser l'<appSettings>élément dans un Web.config fichier App.config OR pour spécifier des AWS paramètres, nous vous recommandons d'utiliser les <aws> éléments <configSections> et comme décrit plus loin dans cette rubrique. Pour plus d'informations sur l'<appSettings>élément, consultez les exemples d'<appSettings>éléments dans Configuration de votre AWS SDK pour .NET application.

Note

Bien que vous puissiez continuer à utiliser les propriétés de AWSConfigsclasse suivantes dans un fichier de code pour spécifier des AWS paramètres, les propriétés suivantes sont obsolètes et ne seront peut-être pas prises en charge dans les versions futures :

  • DynamoDBContextTableNamePrefix

  • EC2UseSignatureVersion4

  • LoggingOptions

  • LogMetrics

  • ResponseLoggingOption

  • S3UseSignatureVersion4

En général, nous recommandons qu'au lieu d'utiliser les propriétés de AWSConfigs classe d'un fichier de code pour spécifier AWS les paramètres, vous utilisiez les <aws> éléments <configSections> et d'un Web.config fichier App.config or pour spécifier AWS les paramètres, comme décrit plus loin dans cette rubrique. Pour plus d'informations sur les propriétés précédentes, consultez les exemples de AWSConfigs code dans Configuration de votre AWS SDK pour .NET application.

Déclarer une section AWS de paramètres

Vous définissez AWS les paramètres dans un Web.config fichier App.config or à partir de l'<aws>élément. Avant de commencer à utiliser l'élément <aws>, vous devez créer un élément <section> (qui est un élément enfant de l'élément <configSections>) et affecter à son attribut name la valeur aws et à son attribut type la valeur Amazon.AWSSection, AWSSDK.Core, comme dans l'exemple suivant :

<?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>

L'éditeur Visual Studio ne fournit pas de saisie automatique du code (IntelliSense) pour l'<aws>élément ou ses éléments enfants.

Pour vous aider à créer une version correctement mise en forme de l'élément <aws>, appelez la méthode Amazon.AWSConfigs.GenerateConfigTemplate. Celle-ci génère une version canonique de l'élément <aws> sous la forme d'une chaîne bien formée, que vous pouvez adapter à vos besoins. Les sections suivantes décrivent les attributs et les éléments enfants de l'élément <aws>.

Éléments autorisés

Voici une liste des relations logiques entre les éléments autorisés dans une section de AWS paramètres. Vous pouvez générer la dernière version de cette liste en appelant la méthode Amazon.AWSConfigs.GenerateConfigTemplate, qui génère une version canonique de l'élément <aws> sous la forme d'une chaîne que vous pouvez adapter à vos besoins.

<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>

Informations de référence sur les éléments

Voici une liste des éléments autorisés dans une section de AWS paramètres. Pour chaque élément, ses attributs autorisés et éléments parents-enfants sont répertoriés.

alias

L'élément <alias> représente un élément unique dans une collection d'un ou plusieurs mappages entre la table de départ et la table d'arrivée qui spécifie une table différente de celle configurée pour un type. Cet élément est mappé à une instance de la classe Amazon.Util.TableAlias à partir de la propriété Amazon.AWSConfigs.DynamoDBConfig.Context.TableAliases du AWS SDK pour .NET. Le remappage intervient avant l'application d'un préfixe de nom de table.

Cet élément peut inclure les attributs suivants :

fromTable

Partie « table de départ » du mappage entre la table de départ et la table d'arrivée. Cet attribut est mappé à la propriété Amazon.Util.TableAlias.FromTable du AWS SDK pour .NET.

toTable

Partie « table d'arrivée » du mappage entre la table de départ et la table d'arrivée. Cet attribut est mappé à la propriété Amazon.Util.TableAlias.ToTable du AWS SDK pour .NET.

Le parent de l'élément <alias> est l'élément <tableAliases>.

L'élément <alias> ne contient aucun élément enfant.

Voici un exemple de l'élément <alias> utilisé :

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

aws

L'<aws>élément représente l'élément le plus haut d'une section de AWS paramètres. Cet élément peut inclure les attributs suivants :

endpointDefinition

Le chemin absolu vers un fichier de configuration personnalisé qui définit les AWS régions et les points de terminaison à utiliser. Cet attribut est mappé à la propriété Amazon.AWSConfigs.EndpointDefinition du AWS SDK pour .NET.

profileName

Le nom du profil pour les AWS informations d'identification stockées qui seront utilisées pour effectuer des appels de service. Cet attribut est mappé à la propriété Amazon.AWSConfigs.AWSProfileName du AWS SDK pour .NET.

profilesLocation

Le chemin absolu vers l'emplacement du fichier d'informations d'identification partagé avec d'autres AWS SDKs. Par défaut, le fichier d'informations d'identification est stocké dans le répertoire .aws situé dans le répertoire de base de l'utilisateur actif. Cet attribut est mappé à la propriété Amazon.AWSConfigs.AWSProfilesLocation du AWS SDK pour .NET.

region

L'ID de AWS région par défaut pour les clients qui n'ont pas explicitement spécifié de région. Cet attribut est mappé à la propriété Amazon.AWSConfigs.AWSRegion du AWS SDK pour .NET.

L'élément <aws> n'a pas d'élément parent.

L'élément <aws> peut inclure les éléments enfants suivants :

  • <dynamoDB>

  • <ec2>

  • <logging>

  • <proxy>

  • <s3>

Voici un exemple de l'élément <aws> utilisé :

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

dynamoDB

L'élément <dynamoDB> représente un ensemble de paramètres pour Amazon DynamoDB. Cet élément peut inclure l'attribut conversionSchema, qui représente la version à utiliser pour la conversion entre des objets .NET et des objets DynamoDB. Les valeurs autorisées sont notamment V1 et V2. Cet attribut est mappé à la classe Amazon.DynamoDBv2.DynamoDBEntryConversion du AWS SDK pour .NET. Pour plus d'informations, consultez DynamoDB Series – Conversion Schemas.

Le parent de l'élément <dynamoDB> est l'élément <aws>.

L'élément <dynamoDB> peut inclure l'élément enfant <dynamoDBContext>.

Voici un exemple de l'élément <dynamoDB> utilisé :

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

dynamo DBContext

L'élément <dynamoDBContext> représente un ensemble de paramètres propres au contexte Amazon DynamoDB. Cet élément peut inclure l'tableNamePrefixattribut, qui représente le préfixe de nom de table par défaut que le contexte DynamoDB utilisera s'il n'est pas configuré manuellement. Cet attribut est mappé à la propriété Amazon.Util.DynamoDBContextConfig.TableNamePrefix à partir de la propriété Amazon.AWSConfigs.DynamoDBConfig.Context.TableNamePrefix du AWS SDK pour .NET. Pour plus d'informations, consultez Enhancements to the DynamoDB SDK.

Le parent de l'élément <dynamoDBContext> est l'élément <dynamoDB>.

L'élément <dynamoDBContext> peut inclure les éléments enfants suivants :

  • <alias> (une ou plusieurs instances)

  • <map> (une ou plusieurs instances)

Voici un exemple de l'élément <dynamoDBContext> utilisé :

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

ec2

L'<ec2>élément représente un ensemble de EC2 paramètres Amazon. Cet élément peut inclure l'attribut useSignatureVersion4, qui indique si la signature version 4 sera utilisée pour toutes les demandes (vrai) ou si la signature version 4 ne sera pas utilisée pour toutes les demandes (faux, valeur par défaut). Cet attribut est mappé à la propriété Amazon.Util.EC2Config.UseSignatureVersion4 à partir de la propriété Amazon.AWSConfigs.EC2Config.UseSignatureVersion4 du AWS SDK pour .NET.

Le parent de l'<ec2>élément est l'élément.

L'élément <ec2> ne contient aucun élément enfant.

Voici un exemple de l'élément <ec2> utilisé :

<ec2
  useSignatureVersion4="true" />

journalisation

L'élément <logging> représente un ensemble de paramètres pour la journalisation des réponses et la journalisation des métriques de performance. Cet élément peut inclure les attributs suivants :

logMetrics

Indique si les métriques de performance sont journalisées pour tous les clients et toutes les configurations (true) ; sinon, false. Cet attribut est mappé à la propriété Amazon.Util.LoggingConfig.LogMetrics à partir de la propriété Amazon.AWSConfigs.LoggingConfig.LogMetrics du AWS SDK pour .NET.

logMetricsCustomFormatter

Type de données et nom d'assembly d'un formateur personnalisé pour les métriques de performance. Cet attribut est mappé à la propriété Amazon.Util.LoggingConfig.LogMetricsCustomFormatter à partir de la propriété Amazon.AWSConfigs.LoggingConfig.LogMetricsCustomFormatter du AWS SDK pour .NET.

logMetricsFormat

Format sous lequel se présentent les métriques de journalisation (mappé à la propriété Amazon.Util.LoggingConfig.LogMetricsFormat à partir de la propriété Amazon.AWSConfigs.LoggingConfig.LogMetricsFormat du AWS SDK pour .NET).

Les valeurs autorisées sont les suivantes :

JSON

Utilise le format JSON.

Standard

Utilise le format par défaut.

logResponses

Indique à quel moment les réponses du service sont journalisées (mappé à la propriété Amazon.Util.LoggingConfig.LogResponses à partir de la propriété Amazon.AWSConfigs.LoggingConfig.LogResponses du AWS SDK pour .NET).

Les valeurs autorisées sont les suivantes :

Always

Les réponses du service sont toujours journalisées.

Never

Les réponses du service ne sont jamais journalisées.

OnError

Les réponse du service sont journalisées uniquement en cas d'erreur.

logTo

Où se connecter (cartes de la LogTo propriété depuis la Amazon.AWSConfigs.LoggingConfig.LogTo propriété dans le AWS SDK pour .NET).

Les valeurs autorisées comprennent une ou plusieurs des valeurs suivantes :

Log4Net

Journalisation dans log4net.

None

Désactivation de la journalisation.

SystemDiagnostics

Journalisation dans System.Diagnostics.

Le parent de l'élément <logging> est l'élément <aws>.

L'élément <logging> ne contient aucun élément enfant.

Voici un exemple de l'élément <logging> utilisé :

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

map

L'<map>élément représente un élément unique d'une collection de type-to-table mappages entre les types .NET et les tables DynamoDB (correspond à une instance de TypeMapping la classe à partir de la propriété Amazon.AWSConfigs.DynamoDBConfig.Context.TypeMappings du). AWS SDK pour .NET Pour plus d'informations, consultez Enhancements to the DynamoDB SDK.

Cet élément peut inclure les attributs suivants :

targetTable

Table DynamoDB à laquelle le mappage s'applique. Cet attribut est mappé à la propriété Amazon.Util.TypeMapping.TargetTable du AWS SDK pour .NET.

type

Type et nom d'assembly auxquels le mappage s'applique. Cet attribut est mappé à la propriété Amazon.Util.TypeMapping.Type du AWS SDK pour .NET.

Le parent de l'élément <map> est l'élément <dynamoDBContext>.

L'élément <map> peut inclure une ou plusieurs instances de l'élément enfant <property>.

Voici un exemple de l'élément <map> utilisé :

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

property

L'élément <property> représente une propriété DynamoDB. (Cet élément correspond à une instance d'Amazon.Util. PropertyConfig classe issue de la AddProperty méthode décrite dans le AWS SDK pour .NET) Pour plus d'informations, consultez Améliorations apportées au SDK DynamoDB et aux attributs DynamoDB.

Cet élément peut inclure les attributs suivants :

attribute

Nom d'un attribut de la propriété, par exemple le nom d'une clé de plage. Cet attribut est mappé à la propriété Amazon.Util.PropertyConfig.Attribute du AWS SDK pour .NET.

converter

Type du convertisseur qui doit être utilisé pour cette propriété. Cet attribut est mappé à la propriété Amazon.Util.PropertyConfig.Converter du AWS SDK pour .NET.

ignore

Indique si la propriété associée doit être ignorée (true) ; sinon, false. Cet attribut est mappé à la propriété Amazon.Util.PropertyConfig.Ignore du AWS SDK pour .NET.

name

Le nom de la propriété. Cet attribut est mappé à la propriété Amazon.Util.PropertyConfig.Name du AWS SDK pour .NET.

version

Indique si cette propriété doit stocker le numéro de version de l'élément (true) ; sinon, false. Cet attribut est mappé à la propriété Amazon.Util.PropertyConfig.Version du AWS SDK pour .NET.

Le parent de l'élément <property> est l'élément <map>.

L'élément <property> ne contient aucun élément enfant.

Voici un exemple de l'élément <property> utilisé :

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

proxy

L'élément <proxy> représente les paramètres de configuration d'un proxy pour le AWS SDK pour .NET à utiliser. Cet élément peut inclure les attributs suivants :

hôte

Nom d'hôte ou adresse IP du serveur proxy. Cet attribut est mappé à la propriété Amazon.Util.ProxyConfig.Host à partir de la propriété Amazon.AWSConfigs.ProxyConfig.Host du AWS SDK pour .NET.

mot de passe

Mot de passe permettant de s'authentifier auprès du serveur proxy. Cet attribut est mappé à la propriété Amazon.Util.ProxyConfig.Password à partir de la propriété Amazon.AWSConfigs.ProxyConfig.Password du AWS SDK pour .NET.

port

Numéro de port du proxy. Cet attribut est mappé à la propriété Amazon.Util.ProxyConfig.Port à partir de la propriété Amazon.AWSConfigs.ProxyConfig.Port du AWS SDK pour .NET.

nom d’utilisateur

Nom d'utilisateur permettant de s'authentifier auprès du serveur proxy. Cet attribut est mappé à la propriété Amazon.Util.ProxyConfig.Username à partir de la propriété Amazon.AWSConfigs.ProxyConfig.Username du AWS SDK pour .NET.

Le parent de l'élément <proxy> est l'élément <aws>.

L'élément <proxy> ne contient aucun élément enfant.

Voici un exemple de l'élément <proxy> utilisé :

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

s3

L'élément <s3> représente un ensemble de paramètres Amazon S3. Cet élément peut inclure l'attribut useSignatureVersion4, qui indique si la signature version 4 sera utilisée pour toutes les demandes (vrai) ou si la signature version 4 ne sera pas utilisée pour toutes les demandes (faux, valeur par défaut). Cet attribut est mappé à la propriété Amazon.AWSConfigs.S3Config.UseSignatureVersion4 du AWS SDK pour .NET.

Le parent de l'élément <s3> est l'élément <aws>.

L'élément <s3> ne contient aucun élément enfant.

Voici un exemple de l'élément <s3> utilisé :

<s3 useSignatureVersion4="true" />