

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.

# Configuration des mises à jour automatiques
<a name="update-configuration-options"></a>

Utilisation de l'`appsettings.json`Pour permettre la mise à jour automatique d'Amazon Kinesis Agent for Microsoft Windows et du fichier de configuration de Kinesis Agent for Windows. Pour contrôler le comportement de mise à jour, spécifiez la paire clé-valeur `Plugins` au même niveau du fichier de configuration que `Sources`, `Sinks` et `Pipes`.

La paire clé-valeur `Plugins` spécifie les fonctionnalités générales supplémentaires à utiliser et qui ne relèvent pas spécifiquement des catégories sources, récepteurs (sinks) et canaux (pipes). Par exemple, il existe un plug-in pour la mise à jour de Kinesis Agent pour Windows et un plug-in pour la mise à jour de`appsettings.json`Fichier de configuration. Les plug-ins sont représentés en tant qu'objets JSON et ont toujours une paire clé-valeur `Type`. La paire `Type` détermine les autres paires clé-valeur qui peuvent être spécifiées pour le plug-in. Les types de plug-ins suivants sont pris en charge :

`PackageUpdate`  
Spécifie que l'agent Kinesis pour Windows doit vérifier périodiquement le fichier de configuration de la version du package. Si le fichier de la version du package indique qu'une autre version de Kinesis Agent pour Windows doit être installée, Kinesis Agent pour Windows la télécharge et l'installe. Les paires clé-valeur du plug-in `PackageUpdate` incluent :    
`Type`  
La valeur est obligatoire et doit être la chaîne `PackageUpdate`.  
`Interval`  
Spécifie en minutes (sous forme de chaîne) la fréquence à laquelle le fichier de la version du package doit être contrôlé en cas de modifications éventuelles. La paire clé-valeur est facultative. Si elle n'est pas spécifiée, la valeur par défaut est 60 minutes. Si la valeur est inférieure à 1, il n'est procédé à aucun contrôle de mise à jour.  
`PackageVersion`  
Spécifie l'emplacement du fichier JSON de la version du package. Le fichier peut résider sur un partage de fichiers (`file://`), un site web (`http://`) ou Amazon S3 (`s3://`). Par exemple, une valeur de`s3://mycompany/config/agent-package-version.json`indique que Kinesis Agent pour Windows doit vérifier le contenu de la`config/agent-package-version.json`Dans le fichier`mycompany`Compartiment Amazon S3. Il doit effectuer les mises à jour en fonction du contenu de ce fichier.   
La valeur de la propriété`PackageVersion`La paire clé-valeur est sensible à la casse pour Amazon S3.
L'exemple suivant est celui du contenu du fichier d'une version de package :   

```
{
    "Name": "AWSKinesisTap",
    "Version": "1.0.0.106",
    "PackageUrl": "https://s3-us-west-2.amazonaws.com/kinesis-agent-windows/downloads/AWSKinesisTap.{Version}.nupkg"
}
```
La .`Version`Spécifie la version de Kinesis Agent pour Windows à installer si elle n'est pas déjà installée. La référence de la variable `{Version}` dans `PackageUrl` résout la valeur que vous spécifiez pour la paire clé-valeur `Version`. Dans cet exemple, la variable est résolue dans la chaîne `1.0.0.106`. Cette résolution de variable est fournie de telle sorte qu'il y ait un seul emplacement dans le fichier de la version du package où la version spécifique souhaitée est stockée. Vous pouvez utiliser plusieurs fichiers de la version du package pour contrôler le rythme du déploiement de nouvelles versions de Kinesis Agent pour Windows afin de valider une nouvelle version avant un déploiement plus important. Pour restaurer un déploiement de Kinesis Agent pour Windows, modifiez un ou plusieurs fichiers de la version du package afin de spécifier une version antérieure de Kinesis Agent pour Windows connue pour fonctionner dans votre environnement.  
La valeur de la paire clé-valeur `PackageVersion` est affectée par la substitution de variable afin de faciliter la sélection automatique des différents fichiers de version du package. Pour plus d'informations sur la substitution de variable, consultez [Configuration des substitutions de variables de récepteur](sink-object-declarations.md#configuring-kinesis-agent-windows-sink-variable-substitution).  
`AccessKey`  
Spécifie la clé d'accès à utiliser lors de l'authentification de l'accès au fichier de la version du package dans Amazon S3. La paire clé-valeur est facultative. Il est déconseillé d'utiliser cette paire clé-valeur. Pour obtenir les autres méthodes d'authentification recommandées, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication).   
`SecretKey`  
Spécifie la clé secrète à utiliser lors de l'authentification de l'accès au fichier de la version du package dans Amazon S3. La paire clé-valeur est facultative. Il est déconseillé d'utiliser cette paire clé-valeur. Pour obtenir les autres méthodes d'authentification recommandées, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication).  
`Region`  
Spécifie le point de terminaison de la région à utiliser lors de l'accès au fichier de la version du package depuis Amazon S3. La paire clé-valeur est facultative.  
`ProfileName`  
Spécifie le profil de sécurité à utiliser lors de l'authentification de l'accès au fichier de la version du package dans Amazon S3. Pour plus d'informations, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication). La paire clé-valeur est facultative.  
`RoleARN`  
Spécifie le rôle à endosser lors de l'authentification de l'accès au fichier de la version du package dans Amazon S3 dans au sein d'un scénario entre comptes. Pour plus d'informations, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication). La paire clé-valeur est facultative.
S'il n'est pas spécifié de plug-in `PackageUpdate`, aucun fichier de la version du package n'est vérifié pour déterminer si une mise à jour est requise.

`ConfigUpdate`  
Spécifie que Kinesis Agent pour Windows doit vérifier périodiquement la présence d'un`appsettings.json`Fichier de configuration stocké dans un partage de fichiers, sur un site web ou sur Amazon S3. S'il existe un fichier de configuration mis à jour, il est téléchargé et installé par Kinesis Agent pour Windows.`ConfigUpdate`Les paires clé-valeur incluent les informations suivantes :    
`Type`  
La valeur est obligatoire et doit être la chaîne `ConfigUpdate`.  
`Interval`  
Spécifie en minutes (sous la forme d'une chaîne) la fréquence à laquelle un nouveau fichier de configuration doit être recherché. Cette paire clé-valeur est facultative, et si elle n'est pas spécifiée, la valeur par défaut est de 5 minutes. Si la valeur est inférieure à 1, la mise à jour du fichier de configuration n'est pas contrôlée.  
`Source`  
Spécifie à quel emplacement rechercher un fichier de configuration mis à jour. Le fichier peut résider sur un partage de fichiers (`file://`), un site web (`http://`) ou Amazon S3 (`s3://`). Par exemple, une valeur de`s3://mycompany/config/appsettings.json`indique que Kinesis Agent pour Windows doit rechercher les mises à jour de la`config/appsettings.json`Dans le fichier`mycompany`Compartiment Amazon S3.  
La valeur de la propriété`Source`La paire clé-valeur est sensible à la casse pour Amazon S3.
La valeur de la paire clé-valeur `Source` est affectée par la substitution de variable afin de faciliter la sélection automatique des différents fichiers de configuration. Pour plus d'informations sur la substitution de variable, consultez [Configuration des substitutions de variables de récepteur](sink-object-declarations.md#configuring-kinesis-agent-windows-sink-variable-substitution).  
`Destination`  
Spécifie à quel emplacement le fichier de configuration doit être stocké sur l'ordinateur local. Il peut s'agir d'un chemin relatif, d'un chemin absolu ou d'un chemin contenant les références de variables d'environnement telles que `%PROGRAMDATA%`. Si le chemin est relatif, il l'est à l'emplacement où Kinesis Agent pour Windows est installé. Généralement, la valeur est `.\appsettings.json`. Cette paire clé-valeur est requise.   
`AccessKey`  
Spécifie la clé d'accès à utiliser lors de l'authentification de l'accès au fichier de configuration dans Amazon S3. La paire clé-valeur est facultative. Il est déconseillé d'utiliser cette paire clé-valeur. Pour obtenir les autres méthodes d'authentification recommandées, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication).   
`SecretKey`  
Spécifie la clé secrète à utiliser lors de l'authentification de l'accès au fichier de configuration dans Amazon S3. La paire clé-valeur est facultative. Il est déconseillé d'utiliser cette paire clé-valeur. Pour obtenir les autres méthodes d'authentification recommandées, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication).  
`Region`  
Spécifie le point de terminaison de la région à utiliser lors de l'accès au fichier de configuration à partir d'Amazon S3. La paire clé-valeur est facultative.  
`ProfileName`  
Spécifie le profil de sécurité à utiliser lors de l'authentification de l'accès au fichier de configuration dans Amazon S3. Pour plus d'informations, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication). La paire clé-valeur est facultative.  
`RoleARN`  
Spécifie le rôle à endosser lors de l'authentification de l'accès au fichier de configuration dans Amazon S3 dans au sein d'un scénario entre comptes. Pour plus d'informations, consultez [Configuration de l'authentification](sink-object-declarations.md#configuring-kinesis-agent-windows-authentication). La paire clé-valeur est facultative.
S'il n'est pas spécifié de plug-in `ConfigUpdate`, aucun fichier de configuration n'est vérifié pour déterminer si une mise à jour du fichier de configuration est requise.

L'exemple suivant présente un fichier de configuration `appsettings.json` qui illustre l'utilisation des plug-ins `PackageUpdate` et `ConfigUpdate`. Dans cet exemple, il existe un fichier de la version du package situé dans le`mycompany`Compartiment Amazon S3 nommé`config/agent-package-version.json`. Le fichier est vérifié en quête de modification éventuelle toutes les 2 heures environ. Si une autre version de Kinesis Agent pour Windows est mentionnée dans le fichier, la version de l'agent spécifiée est installée à partir de l'emplacement indiqué dans le fichier de la version du package. 

De plus, il existe un`appsettings.json`stocké dans le fichier de configuration`mycompany`Compartiment Amazon S3 nommé`config/appsettings.json`. Environ toutes les 30 minutes, le fichier est comparé au fichier de configuration actuel. S'ils sont différents, le fichier de configuration mis à jour est téléchargé à partir d'Amazon S3 et installé à l'emplacement local standard pour le`appsettings.json`Fichier de configuration.

```
{
  "Sources": [
    {
      "Id": "ApplicationLogSource",
      "SourceType": "DirectorySource",
      "Directory": "C:\\LogSource\\",
      "FileNameFilter": "*.log",
      "RecordParser": "SingleLine"
    }
  ],
  "Sinks": [
    {
       "Id": "ApplicationLogKinesisFirehoseSink",
       "SinkType": "KinesisFirehose",
       "StreamName": "ApplicationLogFirehoseDeliveryStream",
       "Region": "us-east-1"
    }  
    ],
  "Pipes": [
    {
      "Id": "ApplicationLogSourceToApplicationLogKinesisFirehoseSink",
      "SourceRef": "ApplicationLogSource",
      "SinkRef": "ApplicationLogKinesisFirehoseSink"
    }
  ],
  "Plugins": [
    {
      "Type": "PackageUpdate"
      "Interval": "120",
      "PackageVersion": "s3://mycompany/config/agent-package-version.json"
    },
    {
      "Type": "ConfigUpdate",
      "Interval": "30", 
      "Source": "s3://mycompany/config/appsettings.json",
      "Destination": ".\appSettings.json"      
    }
  ]
}
```