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
Os tópicos desta seção abrangem o trabalho com a API do Amazon ElastiCache e a seção do ElastiCache da AWS CLI. Também estão incluídas nesta seção mensagens de erro comuns e notificações de serviço.
+ [Uso da API do ElastiCache](ProgrammingGuide.md)
+ [Referência da API do ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/Welcome.html)
+ [Seção ElastiCache da Referência daAWS CLI](https://docs.aws.amazon.com/cli/latest/reference/elasticache/index.html)
+ [Mensagens ElastiCache de erro da Amazon](ErrorMessages.md)
+ [Notificações](elasticache-notifications.md)
## Configuração da interface de linha de comando do ElastiCache
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 neste tópico somente se for usar a AWS CLI para o ElastiCache.
**Importante**
A CLI (Command Line Interface) do Amazon ElastiCache não oferece suporte a melhorias do ElastiCache após a versão 2014-09-30 da API. Para usar a funcionalidade do ElastiCache mais recente na linha de comando, use a opção [Interface de linha de comando da AWS](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
Este documento pressupõe que você pode trabalhar em um ambiente Linux/UNIX ou Windows. As ferramentas da linha de comando do Amazon ElastiCache também funcionam no Mac OS X, que é um ambiente baseado no UNIX; contudo, não há nenhuma instrução específica ao Mac OS X 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 específico do Linux/UNIX 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
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 ver e fazer download de JREs para uma série de plataformas, incluindo Linux/UNIX e Windows, consulte [Java SE Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index.html).
##### Configuração da variável home do Java
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=
```
+ No Windows, digite o seguinte comando:
```
C:\> set JAVA_HOME=
```
1. Confirme a configuração do caminho executando **\$1JAVA\$1HOME/bin/java -version** e verificando a saída.
+ No Linux/UNIX, 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
As ferramentas da linha de comando estão disponíveis como arquivo ZIP no [ site Ferramentas de desenvolvedor do ElastiCache](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, Linux/UNIX e Mac OSX. 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
As ferramentas da linha de comando dependem de uma variável de ambiente (AWS\$1ELASTICACHE\$1HOME) 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 é chamado ElastiCacheCli-A.B.nnnn (A, B e n são os números de versão/release) e contém os subdiretórios denominados bin e lib.
**Para definir a variável de ambiente AWS\$1ELASTICACHE\$1HOME**
+ Abra uma janela de linha de comando e insira um dos seguintes comandos para definir a variável de ambiente AWS\$1ELASTICACHE\$1HOME.
+ No Linux e UNIX, digite o comando a seguir:
```
$ export &AWS;_ELASTICACHE_HOME=
```
+ No Windows, digite o seguinte comando:
```
C:\> set &AWS;_ELASTICACHE_HOME=
```
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:\$1Program Files\$1Java”
### Como fornecer credenciais para as ferramentas
As ferramentas da linha de comando precisam da chave de acesso e da chave de acesso secreta da AWS fornecidas com sua conta da AWS. 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 \$1\$1AWS\$1ELASTICACHE\$1HOME\$1/credential-file-path.template que você precisa alterar com suas informações. A seguir encontra-se o conteúdo do arquivo de modelo:
```
AWSAccessKeyId=
AWSSecretKey=
```
**Importante**
No UNIX, limite as permissões ao proprietário do arquivo de credenciais:
```
$ chmod 600
```
Com o arquivo de credenciais configurado, você precisará definir a variável de ambiente AWS\$1CREDENTIAL\$1FILE para que as ferramentas do ElastiCache possam encontrar suas informações.
**Para definir a variável de ambiente AWS\$1CREDENTIAL\$1FILE**
1. Defina a variável de ambiente:
+ No Linux e UNIX, atualize a variável usando o seguinte comando:
```
$ export &AWS;_CREDENTIAL_FILE=
```
+ No Windows, defina a variável usando o seguinte comando:
```
C:\> set &AWS;_CREDENTIAL_FILE=
```
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
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\$1CREDENTIAL\$1FILE, a maioria das ferramentas de API incluídas com a interface da linha de comando do ElastiCache comporta as seguintes variáveis:
+ **EC2\$1REGION**: a região da AWS a ser usada.
+ **AWS\$1ELASTICACHE\$1URL**: o URL a ser usado para a chamada de serviço. Não é necessária para especificar um endpoint regional diferente quando EC2\$1REGION for especificada ou quando se passa o parâmetro --region.
Os exemplos a seguir mostram como se define a variável de ambiente EC2\$1REGION 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
```