用于 Redis 的 Amazon ElastiCache
ElastiCache for Redis 用户指南 (API 版本 2015-02-02)
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

参考

本部分中的主题涵盖了有关使用 Amazon ElastiCache API 和 AWS CLI 的 ElastiCache 部分的信息。本部分还包含常见错误消息和服务通知。

设置 ElastiCache 命令行界面

本部分描述了运行命令行工具的先决条件、在何处获取命令行工具以及如何设置工具及其环境,同时包含了一系列常见的工具用途示例。

只有您打算使用适用于 ElastiCache 的 AWS CLI 时,才按照此主题的说明操作。

重要

Amazon ElastiCache 命令行接口 (CLI) 不支持 API 版本 2014-09-30 之后的任何 ElastiCache 改进。要从命令行使用较新的 ElastiCache 功能,请使用 AWS 命令行接口

先决条件

本文件假定您能够在 Linux/UNIX 或 Windows 环境中操作。Amazon ElastiCache 命令行工具也可在 Mac OS X(这是基于 UNIX 的环境)上运行;但是,本指南中不包含特定 Mac OS X 说明。

就惯例而言,所有命令行文本以通配的 PROMPT> 命令行提示符作为前缀。您的机器上的实际命令行提示符可能有所不同。我们还使用 $ 表示 Linux/UNIX 特定命令,使用 C:\> 表示 Windows 特定命令。由命令得出的示例输出在其后立即显示,同时不带任何前缀。

Java 运行时环境

本指南中使用的命令行工具需要 Java 版本 5 或更高版本,方可运行。JRE 或 JDK 安装均可行。如要查看并下载适用于一系列平台 (包括 Linux/UNIX 和 Windows) 的 JRE,请参阅 Java SE 下载

设置 Java Home 变量

命令行工具根据环境变量 (JAVA_HOME) 定位 Java Runtime。此环境变量应该被设为目录的完整路径,其中包含一个名称为 bin 的子目录,而该子目录中包含可执行的 java 文件(在 Linux 和 UNIX 上)或 java.exe可执行文件(在 Windows 上)。

设置 Java Home 变量

  1. 设置 Java Home 变量。

    • 在 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)

获得命令行工具

命令行工具可作为 ZIP 文件在 ElastiCache 开发工具网站上提供。这些工具是用 JAVA 编写,包括适用于 Windows 2000/XP/Vista/Windows 7、Linux/UNIX 和 Mac OSX 的 Shell 脚本。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 目录添加至您的系统路径。本指南的其余部分假定 BIN 目录位于您的系统路径中。

将工具的 BIN 目录添加至您的系统路径

  • 输入下述命令,即可将工具的 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>

使用凭证文件设置,您将需要设置 AWS_CREDENTIAL_FILE 环境变量,以便 ElastiCache 工具能够找到您的信息。

设置 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 或传递了 --region 参数,则无需指定不同的区域终端节点。

以下示例演示如何设置环境变量 EC2_REGION 以配置 API 工具所使用的区域:

Linux、OS X 或 Unix

$ export EC2_REGION=us-west-1

Windows

$ set EC2_REGION=us-west-1