Redis 用 Amazon ElastiCache
Redis 用 ElastiCache ユーザーガイド (API バージョン 2015-02-02)

リファレンス

このセクションのトピックでは、Amazon ElastiCache API および AWS CLI の ElastiCache セクションの使用について説明します。また、このセクションには一般的なエラーメッセージとサービス通知も含まれます。

ElastiCache コマンドラインインターフェイスの設定

このセクションでは、コマンドラインツールを実行するための前提条件、コマンドラインツールを入手できる場所、ツールの設定方法と環境について説明します。また、このセクションにはツール使用の一般的な例も含まれています。

AWS CLI for ElastiCache を使用する場合にのみ、このトピックの手順に従います。

重要

Amazon ElastiCache コマンドラインインターフェイス (CLI) では、API バージョン 2014-09-30 以降の ElastiCache の機能強化がサポートされていません。コマンドラインインターフェイスで ElastiCache の新しい機能を使用するには、AWS コマンドラインインターフェイスを使用してください。

前提条件

この文書では、Linux/UNIX または Windows 環境での作業が可能であることを想定しています。Amazon ElastiCache コマンドラインツールは、UNIX ベースの環境である Mac OS X でも動作しますが、このガイドには Mac OS X に関する固有の手順は含まれていません。

慣例として、すべてのコマンドラインテキストには、一般的な PROMPT> コマンドラインプロンプトが前に付けられています。マシンの実際のコマンドラインプロンプトは、異なっている可能性があります。また、Linux/UNIX 固有のコマンドを示すには、$ 、Windows 固有のコマンドを示すには、C:\> を使用します。コマンドからの出力例は、その直後にプレフィックスなしで表示されています。

Java ランタイム環境

このガイドで使用されているコマンドラインツールを実行するには、Java バージョン 5 以降が必要です。JRE または JDK のどちらでもかまいません。Linux/UNIX と Windows を含め各種プラットフォーム用の JRE は、Java SE ダウンロードから表示してダウンロードすることができます。

Java Home 変数の設定

コマンドラインツールは、Java ランタイムの場所を特定する環境変数(JAVA_HOME)に応じて異なります。この環境変数は、bin 実行可能ファイル(Linux および UNIX の場合)または java 実行可能ファイル(Windows の場合)が存在する java.exe という名前のサブディレクトリが含まれているディレクトリの絶対パスに設定する必要があります。

JAVA_HOME 変数の設定方法

  1. Java ホーム変数を設定します。

    • Linux と UNIX では、以下のコマンドを入力します。

      $ export JAVA_HOME=<PATH>
    • Windows は、以下のコマンドを入力します。

      C:\> set JAVA_HOME=<PATH>
  2. $JAVA_HOME/bin/java -version を実行して出力をチェックすることにより、パス設定を確認します。

    • Linux/UNIX では、以下のような出力結果が表示されるはずです。

      $ $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)
    • Windows では、以下のような出力結果が表示されるはずです。

      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)

コマンドラインツールを入手する

コマンドラインツールは、「ElastiCache 開発者ツールウェブサイト」で ZIP ファイルとして入手できます。このツールは Java で作成されており、Windows 2000/XP/Vista/Windows 7 と Linux/UNIX、および Mac OSX 用のシェルスクリプトが含まれています。ZIP ファイルは自己完結型であり、インストール作業は不要です。ZIP ファイルをダウンロードして圧縮を解除し、ローカルマシン上の任意のディレクトリに保存してください。

ツールを設定する

コマンドラインツールは、サポートライブラリの場所の特定を環境変数(AWS_ELASTICACHE_HOME)に依存しています。ツールを使うには、この環境変数を設定する必要があります。コマンドラインツールを解凍したディレクトリのパスに設定します。このディレクトリの名前は、ElastiCacheCli-A.B.nnnn(A、B、および n はバージョン/リリース番号)で、bin および lib という名前のサブディレクトリが含まれます。

AWS_ELASTICACHE_HOME 環境変数を設定するには

  • コマンドラインウィンドウを開き、次のいずれかのコマンドを入力して、AWS_ELASTICACHE_HOME 環境変数を設定します。

    • Linux と UNIX では、以下のコマンドを入力します。

      $ export AWS_ELASTICACHE_HOME=<path-to-tools>
    • Windows は、以下のコマンドを入力します。

      C:\> set AWS_ELASTICACHE_HOME=<path-to-tools>

ツールを使いやすくするため、ツールの BIN ディレクトリをシステム PATH に追加することをお勧めします。このガイドの残りの部分は、BIN ディレクトリがシステムパスに含まれていることを前提としています。

ツールの BIN ディレクトリをシステムパスに追加するには

  • システム PATH にツールの BIN ディレクトリを追加するには、次のコマンドを入力します。

    • Linux と UNIX では、以下のコマンドを入力します。

      $ export PATH=$PATH:$AWS_ELASTICACHE_HOME/bin
    • Windows は、以下のコマンドを入力します。

      C:\> set PATH=%PATH%;%AWS_ELASTICACHE_HOME%\bin

注記

Windows の環境変数は、コマンドウィンドウを閉じたときにリセットされます。永続的に設定することもできます。詳細については、使用している Windows のバージョンのドキュメントを参照してください。

注記

スペースを含むパスは、二重引用符で囲む必要があります。たとえば、次のとおりです。

「C:\Program Files\Java」

ツールでの認証情報の指定

コマンドラインツールを使用するには、AWS アカウントで提供される AWS アクセスキーとシークレットアクセスキーが必要です。コマンドラインを使用するか、ローカルシステムにある認証情報ファイルから取得できます。

環境には、情報の編集に必要なテンプレートファイル ${AWS_ELASTICACHE_HOME}/credential-file-path.template が含まれています。テンプレートファイルの内容は次のとおりです。

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

重要

UNIX では、アクセス許可を認証情報ファイルの所有者に制限します。

$ chmod 600 <the file created above>

認証情報ファイルを設定したら、ElastiCache ツールで情報が検索されるように AWS_CREDENTIAL_FILE 環境変数を作成する必要があります。

AWS_CREDENTIAL_FILE 環境変数の設定方法

  1. 環境変数を設定します。

    • Linux/UNIX では、次のコマンドを使用して変数を更新します。

      $ export AWS_CREDENTIAL_FILE=<the file created above>
    • Windows では、次のコマンドを使用して変数を設定します。

      C:\> set AWS_CREDENTIAL_FILE=<the file created above>
  2. 設定が適切に機能することをチェックし、次のコマンドを実行します。

    elasticache --help

    すべての ElastiCache コマンドの使用方法ページが表示されます。

環境変数

環境変数はスクリプトやデフォルト値の設定またはそれらを一時的に上書きする場合に便利です。

AWS_CREDENTIAL_FILE 環境変数に加えて、ElastiCache コマンドラインインターフェイスに付属するほとんどの API ツールは次の変数をサポートしています。

  • EC2_REGION — 使用する AWS リージョンです。

  • AWS_ELASTICACHE_URL — サービス呼び出しに使用する URL です。EC2_REGION が指定されている場合または -- リージョンパラメータが渡されている場合は、別のリージョンのエンドポイントを指定する必要はありません。

以下の例は API ツールで使用するリージョンを設定する環境変数 EC2_REGION の設定方法を示します。

Linux、OS X、Unix

$ export EC2_REGION=us-west-1

Windows

$ set EC2_REGION=us-west-1