參考資料 - Amazon ElastiCache

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

參考資料

本節中的主題涵蓋使用 Amazon ElastiCache API 和 的 ElastiCache 章節 AWS CLI。本節也包含常見錯誤訊息及服務通知。

設定 ElastiCache 命令列介面

本節說明執行命令列工具的事前準備、如何取得命令列工具、如何設定工具及其環境,以及使用工具的一系列常見範例。

只有在您前往 AWS CLI 的 時,才遵循本主題中的指示 ElastiCache。

重要

Amazon ElastiCache Command Line Interface (CLI) 不支援 2014-09-30 API版之後的任何 ElastiCache 改進。若要從命令列使用較新的 ElastiCache 功能,請使用AWS 命令列介面

必要條件

本文件假設您可以在 Linux/UNIX 或 Windows 環境中工作。Amazon ElastiCache 命令列工具也適用於以 UNIX為基礎的 Mac OS X,但本指南中不包含特定的 Mac OS X 指示。

以慣例而言,所有命令列文字前方都會加上通用的 PROMPT> 命令列提示字元,您機器實際的命令列提示字元可能有所不同。我們也使用 $ 來指示 Linux/UNIX特定命令,以及 C:\> Windows 特定命令。此命令的範例輸出則直接列出,前方沒有任何前綴字。

Java 執行階段環境

本指南使用的命令列工具,需要 Java (版本 5 或更新版本) 來執行。可接受 JRE或 JDK 安裝。若要檢視和下載JREs一系列平台,包括 Linux/UNIX 和 Windows,請參閱 Java SE Downloads

設定 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)

取得命令列工具

命令列工具可在 ElastiCache 開發人員工具 網站 上以ZIP檔案形式提供。這些工具以 Java 編寫,並包含適用於 Windows 2000/XP/Vista/Windows 7、Linux/ UNIX和 Mac 的 Shell 指令碼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目錄新增至您的系統路徑

  • 輸入下列命令,將工具的BIN目錄新增至您的系統 PATH。

    • 在 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,您需要使用資訊進行編輯。以下是範本檔案的內容:

AWS AccessKeyId=<Write your AWS access ID> AWS SecretKey=<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