Referenz

Die Themen in diesem Abschnitt beschreiben die Arbeit mit der Amazon-ElastiCache-API und dem ElastiCache-Abschnitt der AWS CLI. In diesem Abschnitt sind auch allgemeine Fehlermeldungen und Servicemeldungen enthalten.

• Verwenden der ElastiCache-API

• ElastiCache-API-Referenz

• ElastiCache-Abschnitt der AWS CLI-Referenz

• Amazon-ElastiCache-Fehlermeldungen

• Benachrichtigungen

Einrichten der ElastiCache-Befehlszeilenschnittstelle

In diesem Abschnitt wird beschrieben, welche Voraussetzungen für die Ausführung der Befehlszeilen-Tools erforderlich sind, wo Sie die Befehlszeilen-Tools herunterladen können und wie die Tools und die Umgebung eingerichtet werden. Zudem werden gängige Beispiele für die Nutzung der Tools vorgestellt.

Folgen Sie den Anweisungen in diesem Thema nur, wenn Sie zur AWS CLI für ElastiCache gehen.

Wichtig

Das Amazon ElastiCache Command Line Interface (CLI) unterstützt keine ElastiCache-Verbesserungen nach API-Version 2014-09-30. Um neuere ElastiCache-Funktionalität über die Befehlszeile zu nutzen, verwenden Sie die AWS Command Line Interface.

Voraussetzungen

In diesem Dokument wird vorausgesetzt, dass Sie in einer Linux/UNIX- oder Windows-Umgebung arbeiten. Die Amazon-ElastiCache-Befehlszeilen-Tools funktionieren auch mit Mac OS X, wobei es sich um eine auf UNIX basierende Umgebung handelt, jedoch sind in diesem Handbuch keine besonderen Anweisungen für Mac OS X enthalten.

Als Konvention wird jeglichem Befehlszeilentext die generische Eingabeaufforderung PROMPT> vorangestellt. Der auf dem Rechner tatsächlich angezeigte Prompt sieht wahrscheinlich anders aus. Zudem wird $ zur Angabe eines Linux/UNIX-spezifischen Befehls und C:\> für einen Windows-spezifischen Befehl verwendet. Die Beispielausgabe des Befehls wird direkt im Anschluss ohne Präfix angezeigt.

Die Java-Laufzeitumgebung

Für die in diesem Handbuch verwendeten Befehlszeilen-Tools muss Java Version 5 oder höher ausgeführt werden. Eine JRE- oder JDK-Installation ist zulässig. Weitere Informationen zur Anzeige und zum Download von JREs für eine breite Palette an Plattformen (einschließlich Linux/UNIX und Windows) finden Sie unter Java SE-Downloads.

Einrichten der Java-Home-Variablen

Die Befehlszeilen-Tools sind von einer Umgebungsvariablen (JAVA_HOME) abhängig, um die Java-Runtime zu finden. Diese Umgebungsvariable sollte auf den vollständigen Pfad des Verzeichnisses gesetzt werden, das ein Unterverzeichnis namens bin enthält, das wiederum die ausführbare java-Datei (unter Linux und UNIX) oder die ausführbare java.exe-Datei (unter Windows) enthält.

Einrichten der Java Home-Variablen

1. Einrichten der Java Home-Variablen.

   • Geben Sie unter Linux und UNIX den folgenden Befehl ein:

     $ export JAVA_HOME=<PATH>

   • Geben Sie unter Windows den folgenden Befehl ein:

     C:\> set JAVA_HOME=<PATH>

2. Bestätigen Sie die Pfadeinrichtung, indem Sie $JAVA_HOME/bin/java -version ausführen und die Ausgabe überprüfen.

   • Die Ausgabe unter Linux/UNIX entspricht weitgehend der Folgenden:

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

   • Unter Windows sehen Sie eine Ausgabe vergleichbar der Folgenden:

     
     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)
     

Aufrufen der Befehlszeilen-Tools

Die Befehlszeilen-Tools stehen als ZIP-Datei auf der Website ElastiCache-Entwickler-Tools zur Verfügung. Diese Tools sind in Java geschrieben und beinhalten Shell-Skripts für Windows 2000/XP/Vista/Windows 7, Linux/UNIX und Mac OSX. Die ZIP-Datei ist unabhängig und erfordert keine Installation; laden Sie einfach die ZIP-Datei herunter und entpacken Sie sie in ein Verzeichnis auf Ihrem lokalen Rechner.

Einrichten der Tools

Die Befehlszeilen-Tools sind von einer Umgebungsvariablen (AWS_ELASTICACHE_HOME) abhängig, um unterstützende Bibliotheken zu finden. Sie müssen diese Umgebungsvariable festlegen, bevor Sie die Tools verwenden können. Setzen Sie sie auf den Pfad des Verzeichnisses, in das Sie die Befehlszeilen-Tools entpackt haben. Dieses Verzeichnis heißt ElastiCacheCli-A.B.nnnn (A, B und n sind Versions-/Release-Nummern) und enthält Unterverzeichnisse namens bin und lib.

Einrichten der Umgebungsvariable AWS_ELASTICACHE_HOME

• Öffnen Sie ein Befehlszeilenfenster und geben Sie einen der folgenden Befehle ein, um die Umgebungsvariable AWS_ELASTICACHE_HOME einzurichten.

  • Geben Sie unter Linux und UNIX den folgenden Befehl ein:

    $ export &AWS;_ELASTICACHE_HOME=<path-to-tools>

  • Geben Sie unter Windows den folgenden Befehl ein:

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

Um die Verwendung der Tools zu vereinfachen, empfehlen wir Ihnen, das BIN-Verzeichnis der Tools Ihrem System-Pfad hinzuzufügen. Der Rest dieser Anleitung geht davon aus, dass sich das BIN-Verzeichnis in Ihrem Systempfad befindet.

Das BIN-Verzeichnis der Tools Ihrem Systempfad hinzufügen

• Geben Sie die folgenden Befehle ein, um das BIN-Verzeichnis der Tools zu Ihrem System-PATH hinzuzufügen.

  • Geben Sie unter Linux und UNIX den folgenden Befehl ein:

    $ export PATH=$PATH:$&AWS;_ELASTICACHE_HOME/bin

  • Geben Sie unter Windows den folgenden Befehl ein:

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

Anmerkung

Die Windows-Umgebungsvariablen werden zurückgesetzt, wenn Sie das Befehlsfenster schließen. Möglicherweise wollen Sie sie permanent einrichten. Weitere Informationen finden Sie in der Dokumentation zu Ihrer Windows-Version.

Anmerkung

Pfade, die ein Leerzeichen enthalten, müssen in Anführungszeichen gesetzt werden, z. B.:

"C:\Program Files\Java"

Bereitstellung von Anmeldeinformationen für die Tools

Die Kommandozeilen-Tools benötigen den AWS-Zugriffsschlüssel und den geheimen Zugriffsschlüssel, die Ihnen mit Ihrem AWS-Konto bereitgestellt werden. Sie können sie über die Befehlszeile oder aus einer Anmeldeinformationsdatei auf Ihrem lokalen System beziehen.

Die Bereitstellung enthält eine Vorlagendatei ${AWS_ELASTICACHE_HOME}/credential-file-path.template, die Sie an Ihre Informationen anpassen müssen. Nachfolgend finden Sie dem Inhalt der Template-Datei:

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

Wichtig

Unter UNIX sollten Sie die Berechtigungen auf den Eigentümer der Anmeldeinformationsdatei beschränken:

$ chmod 600 <the file created above>

Wenn Sie die Anmeldedatei eingerichtet haben, müssen Sie die Umgebungsvariable AWS_CREDENTIAL_FILE setzen, damit die ElastiCache-Tools Ihre Informationen finden können.

So richten Sie die Umgebungsvariable AWS_CREDENTIAL_FILE ein

1. Legen Sie die -Umgebungsvariable fest:

   • Aktualisieren Sie unter Linux und UNIX die Variable mit folgendem Befehl:

     $ export &AWS;_CREDENTIAL_FILE=<the file created above>

   • Legen Sie unter Windows die Variable mit folgendem Befehl fest:

     C:\> set &AWS;_CREDENTIAL_FILE=<the file created above>

2. Überprüfen Sie, ob Ihre Einrichtung ordnungsgemäß funktioniert, und führen Sie den folgenden Befehl aus:

   elasticache --help

   Sie sollten die Verwendungsseite für alle ElastiCache-Befehle sehen.

Umgebungsvariablen

Umgebungsvariablen können nützlich sein, um Skripts zu erstellen, Standardwerte zu konfigurieren oder sie vorübergehend zu überschreiben.

Zusätzlich zur Umgebungsvariablen AWS_CREDENTIAL_FILE unterstützen die meisten API-Tools der ElastiCache Command Line Interface die folgenden Variablen:

• EC2_REGION – Die zu verwendende AWS-Region.

• AWS_ELASTICACHE_URL – Die für den Serviceaufruf zu verwendende URL. Es ist nicht erforderlich, einen anderen regionalen Endpunkt anzugeben, wenn EC2_REGION angegeben ist oder der Parameter --region übergeben wird.

Die folgenden Beispiele zeigen, wie Sie die Umgebungsvariable EC2_REGION setzen, um die von den API-Tools verwendete Region zu konfigurieren:

Linux, OS X oder Unix

$ export EC2_REGION=us-west-1 

Windows

$ set EC2_REGION=us-west-1