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

# 參考資料
<a name="elasticache-api-reference"></a>

本節中的主題涵蓋使用 Amazon ElastiCache API 的內容，以及 ElastiCache 的 AWS CLI章節。本節也包含常見錯誤訊息及服務通知。
+ [使用 ElastiCache API](ProgrammingGuide.md)
+ [ElastiCache API 參考](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/Welcome.html)
+ [AWS CLI 參考的 ElastiCache 區段](https://docs.aws.amazon.com/cli/latest/reference/elasticache/index.html)
+ [Amazon ElastiCache 錯誤訊息](ErrorMessages.md)
+ [通知](elasticache-notifications.md)

## 設定 ElastiCache 命令列界面
<a name="StartCLI"></a>

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

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

**重要**  
在 API 2014-09-30 版之後，Amazon ElastiCache 命令列界面 (CLI) 不支援任何 ElastiCache 改善項目。若要從命令列使用 ElastiCache 功能，請使用 [AWS 命令列介面](https://aws.amazon.com/cli)。

**Topics**
+ [先決條件](#prerequisites)
+ [取得命令列工具](#Overview.SetupTools.Getting)
+ [設定工具](#Overview.SetupTools.WhereTheyAre)
+ [為工具提供憑證](#Overview.SetupTools.WhoYouAre)
+ [環境變數](#Overview.SetupTools.EnvironmentalVariables)

### 先決條件
<a name="prerequisites"></a>

 本文件假設您作業於 Linux/UNIX 或 Windows 環境。Amazon ElastiCache 命令列工具亦可正常運作於 Mac OS X 系統 (一種 UNIX 環境)，但本指南未包含具體的 Mac OS X 說明。

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

#### Java 執行階段環境
<a name="java-runtime"></a>

 本指南使用的命令列工具，需要 Java (版本 5 或更新版本) 來執行。您可以安裝 JRE 或 JDK。若要檢視並下載適用於各種平台 (包括 Linux/UNIX 和 Windows) 的 JRE，請參閱 [Java SE Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index.html)。

##### 設定 Java Home 變數
<a name="java-home"></a>

 命令列工具依存環境變數 (`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>
     ```

1.  執行 **\$1JAVA\$1HOME/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)
     ```

### 取得命令列工具
<a name="Overview.SetupTools.Getting"></a>

命令列工具可透過位於 [ElastiCache 開發人員工具網站](https://aws.amazon.com/developertools/Amazon-ElastiCache)上的 ZIP 檔取得。這些工具都是以 Java 編寫，並且包含 Windows 2000/XP/Vista/Windows 7、Linux/UNIX 及 Mac OSX 的殼層指令碼。ZIP 檔案是獨立式的，因此不需要任何安裝。您只需下載 zip 檔案，並將它解壓縮到位於您本機電腦上的目錄。

### 設定工具
<a name="Overview.SetupTools.WhereTheyAre"></a>

命令列工具仰賴環境變數 (AWS\$1ELASTICACHE\$1HOME) 來尋找支援程式庫。在您使用此工具之前，您必須先設定此環境變數。將它設為您解壓縮命令列工具的目錄路徑。此目錄名為 ElastiCacheCli-A.B.nnnn (A、B 及 n 是版本/發行編號)，並且包含名為 bin 及 lib 的子目錄。

 **設定 AWS\$1ELASTICACHE\$1HOME 環境變數** 
+ 開啟命令列視窗，然後輸入下列其中一個命令來設定 AWS\$1ELASTICACHE\$1HOME 環境變數。
  + 若使用的是 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:\$1Program Files\$1Java"

### 為工具提供憑證
<a name="Overview.SetupTools.WhoYouAre"></a>

 命令列工具需要您 AWS 帳戶隨附的 AWS 存取金鑰和私密存取金鑰。您可以透過使用命令列或從位於您本機系統上的登入資料檔案來取得它們。

部署包含一個範本檔案 \$1\$1AWS\$1ELASTICACHE\$1HOME\$1/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\$1CREDENTIAL\$1FILE 環境變數，以便 ElastiCache 工具可以找到您的資訊。

 **設定 AWS\$1CREDENTIAL\$1FILE 環境變數** 

1. 設定 環境變數：
   + 在 Linux 和 UNIX 上，請使用下列命令來更新變數：

     ```
     $ export &AWS;_CREDENTIAL_FILE=<the file created above>
     ```
   + 在 Windows 上，請使用下列命令來設定變數：

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

1. 檢查您的設定正常運作，請執行以下命令：

   ```
   elasticache --help
   ```

   您應該會看到所有 ElastiCache 命令的用量頁面。

### 環境變數
<a name="Overview.SetupTools.EnvironmentalVariables"></a>

環境變數在編寫指令碼、設定預設值或暫時覆寫預設值時很有用。

除了 AWS\$1CREDENTIAL\$1FILE 環境變數之外，ElastiCache 命令列界面隨附的大多數 API 工具都支援下列變數：
+ **EC2\$1REGION** — 要使用 AWS 的區域。
+ **AWS\$1ELASTICACHE\$1URL** - 要用於服務呼叫的 URL。若已指定 EC2\$1REGION 或傳遞 --region 參數，則不需要指定不同區域端點。

以下範例會示範如何設定環境變數 EC2\$1REGION 來設定 API 工具所使用的區域：

Linux、OS X，或 Unix

```
1. $ export EC2_REGION=us-west-1 
```

Windows

```
1. $ set EC2_REGION=us-west-1 
```