

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Referência
<a name="elasticache-api-reference"></a>

Os tópicos desta seção abrangem o trabalho com a ElastiCache API da Amazon e a ElastiCache seção do AWS CLI. Também estão incluídas nesta seção mensagens de erro comuns e notificações de serviço.
+ [Usando a ElastiCache API](ProgrammingGuide.md)
+ [ElastiCache API Reference](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/Welcome.html)
+ [ElastiCache seção da AWS CLI Referência](https://docs.aws.amazon.com/cli/latest/reference/elasticache/index.html)
+ [Mensagens ElastiCache de erro da Amazon](ErrorMessages.md)
+ [Notificações](elasticache-notifications.md)

## Configurando a interface da linha de ElastiCache comando
<a name="StartCLI"></a>

Esta seção descreve os pré-requisitos para executar as ferramentas da linha de comando, em que lugar obtê-las e como configurar as ferramentas e o ambiente, e inclui ainda uma série de exemplos comuns de uso das ferramentas.

Siga as instruções deste tópico somente se você estiver indo AWS CLI para ElastiCache.

**Importante**  
A Amazon ElastiCache Command Line Interface (CLI) não oferece suporte a nenhuma ElastiCache melhoria após a versão da API 2014-09-30. Para usar a ElastiCache funcionalidade mais recente da linha de comando, use a [interface da linha de AWS comando](https://aws.amazon.com/cli).

**Topics**
+ [Pré-requisitos](#prerequisites)
+ [Obtenção das ferramentas da linha de comando](#Overview.SetupTools.Getting)
+ [Configuração das ferramentas](#Overview.SetupTools.WhereTheyAre)
+ [Como fornecer credenciais para as ferramentas](#Overview.SetupTools.WhoYouAre)
+ [Variáveis de ambiente](#Overview.SetupTools.EnvironmentalVariables)

### Pré-requisitos
<a name="prerequisites"></a>

 Este documento pressupõe que você possa trabalhar em um ambiente Linux/UNIX ou Windows. As ferramentas de linha de ElastiCache comando da Amazon também funcionam no Mac OS X, que é um UNIX-based ambiente; no entanto, nenhuma instrução específica do Mac OS X está incluída neste guia. 

 Como convenção, todos os textos da linha de comando recebem prefixo com um prompt da linha de comando genérico **`PROMPT> `**. O prompt da linha de comando real da sua máquina pode ser diferente. Também usamos **`$ `** para indicar um comando Linux/UNIX específico e **`C:\> `** para um comando específico do Windows. O exemplo de saída resultante do comando é mostrado imediatamente após, sem qualquer prefixo. 

#### O Java Runtime Environment
<a name="java-runtime"></a>

 As ferramentas da linha de comando usadas neste guia requerem a execução do Java versão 5 ou posterior. Uma instalação do JRE ou do JDK é aceitável. Para visualizar e baixar JREs para uma variedade de plataformas, incluindo Linux/UNIX Windows, consulte [Downloads do Java SE](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 

##### Configuração da variável home do Java
<a name="java-home"></a>

 As ferramentas da linha de comando dependem de uma variável de ambiente (`JAVA_HOME`) para localizar o Java Runtime. Essa variável de ambiente deve ser definida para o caminho completo do diretório que contém um subdiretório denominado `bin`, que, por sua vez, contém o executável `java` (no Linux e no UNIX) ou o executável `java.exe` (no Windows). 

 **Para configurar da variável Java Home** 

1. Configure a variável Java Home.
   + No Linux e UNIX, digite o comando a seguir:

     ```
     $ export JAVA_HOME={{<PATH>}}
     ```
   + No Windows, digite o seguinte comando:

     ```
     C:\> set JAVA_HOME={{<PATH>}}
     ```

1.  Confirme a configuração do caminho executando **$JAVA\_HOME/bin/java -version** e verificando a saída. 
   +  Linux/UNIXAtivado, você verá uma saída semelhante à seguinte:

     ```
     $ $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)
     ```
   + No Windows, você verá uma saída semelhante à seguinte:

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

### Obtenção das ferramentas da linha de comando
<a name="Overview.SetupTools.Getting"></a>

As ferramentas da linha de comando estão disponíveis como arquivo ZIP no [ElastiCache site Ferramentas de desenvolvedor](https://aws.amazon.com/developertools/Amazon-ElastiCache). Essas ferramentas são escritas em Java e incluem scripts de shell para Windows 2000/XP/Vista/Windows 7 e Mac OSX. Linux/UNIX O arquivo ZIP é independente e nenhuma instalação é necessária; basta fazer download do arquivo ZIP e decompactá-lo em um diretório de seu computador local.

### Configuração das ferramentas
<a name="Overview.SetupTools.WhereTheyAre"></a>

As ferramentas da linha de comando dependem de uma variável de ambiente (AWS\_ELASTICACHE\_HOME) para localizar bibliotecas compatíveis. Você precisa definir essa variável de ambiente para pode usar as ferramentas. Indique o caminho do diretório no qual você descompactou as ferramentas da linha de comando. Esse diretório é denominado ElastiCacheCli-A.B.nnnn (A, B e n são version/release números) e contém subdiretórios chamados bin e lib.

 **Para definir a variável de ambiente AWS\_ELASTICACHE\_HOME** 
+ Abra uma janela de linha de comando e insira um dos comandos a seguir para definir a variável de ambiente AWS\_ELASTICACHE\_HOME.
  + No Linux e UNIX, digite o comando a seguir:

    ```
    $ export &AWS;_ELASTICACHE_HOME=<path-to-tools>
    ```
  + No Windows, digite o seguinte comando:

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

Para facilitar o uso das ferramentas, é recomendável adicionar o diretório BIN das ferramentas ao CAMINHO do sistema. O restante deste guia pressupõe que o diretório BIN encontra-se no caminho do sistema.

 **Para adicionar o diretório BIN das ferramentas ao caminho do sistema** 
+ Insira os comandos a seguir para adicionar o diretório BIN das ferramentas ao CAMINHO do sistema.
  + No Linux e UNIX, digite o comando a seguir:

    ```
    $ export PATH=$PATH:$&AWS;_ELASTICACHE_HOME/bin
    ```
  + No Windows, digite o seguinte comando:

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

**nota**  
As variáveis do ambiente Windows são redefinidas quando você fecha a janela de comando. Talvez você queira defini-las permanentemente. Consulte a documentação da versão de seu Windows para obter mais informações.

**nota**  
Os caminhos que contêm um espaço devem ser colocados entre aspas duplas; por exemplo:  
“C:\\Program Files\\Java”

### Como fornecer credenciais para as ferramentas
<a name="Overview.SetupTools.WhoYouAre"></a>

 As ferramentas da linha de comando precisam da Chave de AWS Acesso e da Chave de Acesso Secreta fornecidas com sua AWS conta. Você pode obtê-las usando a linha de comando ou um arquivo de credenciais localizado no sistema local. 

A implantação inclui um arquivo de modelo ${AWS\_ELASTICACHE\_HOME}/credential-file-path.template que você precisa alterar com suas informações. A seguir encontra-se o conteúdo do arquivo de modelo:

```
AWS AccessKeyId=<Write your AWS access ID>
AWS SecretKey=<Write your AWS secret key>
```

**Importante**  
No UNIX, limite as permissões ao proprietário do arquivo de credenciais:  

```
$ chmod 600 <the file created above>
```

Com a configuração do arquivo de credenciais, você precisará definir a variável de ambiente AWS\_CREDENTIAL\_FILE para que as ElastiCache ferramentas possam encontrar suas informações.

 **Para definir a variável de ambiente AWS\_CREDENTIAL\_FILE** 

1. Defina a variável de ambiente:
   + No Linux e UNIX, atualize a variável usando o seguinte comando:

     ```
     $ export &AWS;_CREDENTIAL_FILE=<the file created above>
     ```
   + No Windows, defina a variável usando o seguinte comando:

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

1. Verifique se sua configuração está funcionando corretamente com o seguinte comando:

   ```
   elasticache --help
   ```

   Você deve examinar a página de uso de todos os comandos do ElastiCache.

### Variáveis de ambiente
<a name="Overview.SetupTools.EnvironmentalVariables"></a>

As variáveis de ambiente podem ser úteis para scripting, configuração de padrões ou para substituí-los temporariamente. 

Além da variável de ambiente AWS\_CREDENTIAL\_FILE, a maioria das ferramentas de API incluídas na interface de linha de ElastiCache comando suporta as seguintes variáveis: 
+ **EC2\_REGION — A AWS região** a ser usada.
+ **AWS\_ELASTICACHE\_URL**: o URL a ser usado para a chamada de serviço. Não é necessária para especificar um endpoint regional diferente quando EC2\_REGION for especificada ou quando se passa o parâmetro --region. 

Os exemplos a seguir mostram como se define a variável de ambiente EC2\_REGION para configurar a região usada pelas ferramentas de API:

Linux, OSX ou UNIX

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

Windows

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