Reference - Amazon ElastiCache for Redis

Reference

Les rubriques de cette section présentent l'utilisation de l'API Amazon ElastiCache et de la section ElastiCache de la AWS CLI. Sont également présentés les messages d'erreur et les notifications de service courants.

Configuration de l'interface de ligne de commande ElastiCache

Cette section décrit les conditions requises pour exécuter les outils de ligne de commande, explique où trouver ces outils, comment définir les outils et leur environnement, et propose différents exemples courants d'utilisation.

Suivez les instructions de cette rubrique uniquement si vous envisagez d'utiliser la AWS CLI pour ElastiCache.

Important

L'interface de ligne de commande (CLI) d'Amazon ElastiCache ne prend en charge aucune amélioration d'ElastiCache après la version d'API 2014-09-30. Pour utiliser les nouvelles fonctionnalités d'ElastiCache à partir de la ligne de commande, utilisez l'interface de ligne de commande AWS.

Prerequisites

Ce document suppose que vous pouvez travailler dans un environnement Windows ou Linux/UNIX. Les outils de ligne de commande Amazon ElastiCache fonctionnent également sur Mac OS X, qui est un environnement basé sur UNIX ; toutefois, aucune instruction propre à Mac OS X n'est incluse dans ce manuel.

En guise de convention, tout le texte de ligne de commande est préfixé d'une invite de ligne de commande PROMPT> générique. Il est probable que la demande de ligne de commande de votre machine soit différente. Nous utilisons également $ pour désigner une commande propre à Linux/UNIX et C:\> pour une commande propre à Windows. L'exemple de sortie résultant de la commande s'affiche immédiatement après, sans préfixe.

Java Runtime Environment

Les outils de ligne de commande utilisés dans ce manuel nécessitent l'exécution de Java version 5 ou suivante. Une installation JRE ou JDK est acceptable. Pour consulter et télécharger les clients JRE pour différentes plateformes, y compris Linux/UNIX et Windows, consultez Java SE Downloads.

Définition de la variable Home de Java

Les outils de ligne de commande dépendant d'une variable d'environnement (JAVA_HOME) pour localiser Java Runtime. Cette variable d'environnement doit être définie sur le chemin d'accès complet du répertoire contenant un sous-répertoire nommé bin lequel contient l'exécutable java (sur Linux et UNIX) ou l'exécutable java.exe (sur Windows).

Pour définir la variable Home de Java

  1. Définissez la variable Home de Java.

    • Sur Linux et UNIX, entrez la commande suivante :

      $ export JAVA_HOME=<PATH>
    • Sur Windows, entrez la commande suivante:

      C:\> set JAVA_HOME=<PATH>
  2. Confirmez le paramètre de chemin en exécutant $JAVA_HOME/bin/java -version et en vérifiant la sortie.

    • Sur Linux/UNIX, vous verrez des résultats similaires à ce qui suit :

      $ $JAVA_HOME/bin/java -version java version "1.6.0_23" Java(TM) SE Runtime Environment (build 1.6.0_23-b05) Java HotSpot(TM) Client VM (build 19.0-b09, mixed mode, sharing)
    • Sur Windows, vous verrez des résultats similaires à ce qui suit :

      C:\> %JAVA_HOME%\bin\java -version java version "1.6.0_23" Java(TM) SE Runtime Environment (build 1.6.0_23-b05) Java HotSpot(TM) Client VM (build 19.0-b09, mixed mode, sharing)

Téléchargement des outils de ligne de commande

Les outils de ligne de commande sont disponibles sous la forme d'un fichier ZIP, sur le site Web ElastiCache Developer Tools. Ces outils sont écrits en Java, et ils comportent des scripts pour Windows 2000/XP/Vista/Windows 7, Linux/UNIX et Mac OSX. Le fichier ZIP file est autonome et aucune installation n'est requise ; téléchargez simplement le fichier zip et décompressez-le dans un répertoire sur votre machine locale.

Installation des outils

Les outils de ligne de commande dépendant d'une variable d'environnement (AWS_ELASTICACHE_HOME) pour localiser les bibliothèques prises en charge. Vous devez définir cette variable d'environnement avant d'utiliser ces outils. Définissez-la sur le chemin du répertoire dans lequel vous avez décompressé ces outils de ligne de commande. Ce répertoire est nommé ElastiCacheCli-A.B.nnnn (A, B et n sont les numéros de version/édition), et il contient les sous-répertoires nommés bin et lib.

Pour définir la AWSvariable d'environnement AWS_ELASTICACHE_HOME

  • Ouvrez une fenêtre de ligne de commande et entrez l'une des commandes suivantes pour définir la variable d'environnement AWS_ELASTICACHE_HOME.

    • Sur Linux et UNIX, entrez la commande suivante :

      $ export &AWS;_ELASTICACHE_HOME=<path-to-tools>
    • Sur Windows, entrez la commande suivante:

      C:\> set &AWS;_ELASTICACHE_HOME=<path-to-tools>

Pour simplifier l'utilisation des outils, nous vous recommandons d'ajouter le répertoire BIN des outils à votre variable PATH système. Le reste de ce guide suppose que le répertoire BIN se trouve dans votre chemin système.

Pour ajouter le répertoire BIN des outils à votre chemin système

  • Entrez les commandes suivantes pour ajouter le répertoire BIN des outils à votre chemin système PATH.

    • Sur Linux et UNIX, entrez la commande suivante :

      $ export PATH=$PATH:$&AWS;_ELASTICACHE_HOME/bin
    • Sur Windows, entrez la commande suivante:

      C:\> set PATH=%PATH%;%&AWS;_ELASTICACHE_HOME%\bin
Note

Les variables d'environnement Windows sont réinitialisées lorsque vous fermez la fenêtre de commande. Vous pouvez également si vous le souhaitez les configurer définitivement. Pour plus d'informations, consultez la documentation relative à votre version de Windows.

Note

Les chemins qui comportent un espace doivent être indiqués entre guillemets, par exemple :

"C:\Program Files\Java"

Indication des informations d'identification pour les outils

Les outils de ligne de commande ont besoin de la clé d'accès AWS et de la clé d'accès secrète fournies avec votre compte AWS. Vous pouvez les obtenir en utilisant la ligne de commande ou à partir du fichier d'informations d'identification situé sur votre système local.

Le déploiement inclut un fichier modèle ${AWS_ELASTICACHE_HOME}/credential-file-path.template que vous devez modifier avec vos informations. Voici le contenu du fichier modèle :

AWSAccessKeyId=<Write your AWS access ID> AWSSecretKey=<Write your AWS secret key>
Important

Sous UNIX, limitez les autorisations au propriétaire du fichier d'identification :

$ chmod 600 <the file created above>

Une fois le fichier d'identification configuré, vous devez définir la variable d'environnement AWS_CREDENTIAL_FILE de sorte que les outils ElastiCache puissent trouver vos informations.

Pour régler la variable d'environnement AWS_CREDENTIAL_FILE

  1. Définissez la variable d'environnement :

    • Sur Linux et UNIX, mettez à jour la variable à l'aide de la commande suivante :

      $ export &AWS;_CREDENTIAL_FILE=<the file created above>
    • Sous Windows, définissez la variable à l'aide de la commande suivante :

      C:\> set &AWS;_CREDENTIAL_FILE=<the file created above>
  2. Vérifiez que votre configuration fonctionne correctement, exécutez la commande suivante :

    elasticache --help

    Vous devriez voir la page d'utilisation pour toutes les commandes ElastiCache.

Variables d'environnement

Les variables d'environnement peuvent être utiles pour le scripting, la configuration de valeurs par défaut ou leur substitution temporaire.

Outre la variable d'environnement AWS_CREDENTIAL_FILE, la plupart des outils API inclus avec l'interface de ligne de commande ElastiCache prennent en charge les variables suivantes :

  • EC2_REGION – région AWS à utiliser.

  • AWS_ELASTICACHE_URL — URL à utiliser pour l'appel du service. Il n'est pas nécessaire d'indiquer un point de terminaison régional différent si EC2_REGION est spécifié ou si le paramètre --region est transmis.

Les exemples ci-après illustrent comment définir la variable d'environnement EC2_REGION pour configurer la région utilisée par les outils d'API :

Linux, OS X ou Unix

$ export EC2_REGION=us-west-1

Windows

$ set EC2_REGION=us-west-1