Referencia

Los temas de esta sección tratan sobre el trabajo con la ElastiCache API de Amazon y la ElastiCache sección de AWS CLI. También se describen mensajes de error y notificaciones de servicio comunes.

• Uso de la ElastiCache API

• ElastiCache Referencia de la API

• ElastiCache sección de la AWS CLI Referencia

• Mensajes de ElastiCache error de Amazon

• Notificaciones

Configuración de la interfaz de línea de ElastiCache comandos

En esta sección, se describen los requisitos previos para ejecutar las herramientas de línea de comandos, se explica dónde se pueden obtener y cómo configurar las herramientas y su entorno, y se incluyen una serie de ejemplos sobre los usos habituales de las herramientas.

Siga las instrucciones de este tema únicamente si va a utilizar el formulario AWS CLI . ElastiCache

importante

La interfaz de línea de ElastiCache comandos (CLI) de Amazon no admite ninguna ElastiCache mejora después de la versión de API 2014-09-30. Para utilizar las ElastiCache funciones más recientes de la línea de comandos, utilice la interfaz de línea de AWS comandos.

Requisitos previos

En este documento se presupone que puede trabajar en un entorno Linux/UNIX o Windows. Las herramientas de línea de ElastiCache comandos de Amazon también funcionan en Mac OS X, que es un entorno basado en Unix; sin embargo, en esta guía no se incluyen instrucciones específicas para Mac OS X.

Por convención, todo el texto de las líneas de comando va precedido de un símbolo de línea de comando genérico: PROMPT> . Es probable que el símbolo de línea de comando real que aparezca en su equipo sea distinto. También se utilizan $ para indicar un comando Linux/UNIX específico y C:\> para un comando específico de Windows. La salida de ejemplo que se obtiene como resultado del comando se muestra inmediatamente después sin ningún prefijo.

El entorno en tiempo de ejecución de Java

Las herramientas de línea de comandos que se utilizan en esta guía requieren que se ejecute Java versión 5 o posterior. Se acepta una instalación de JRE o de JDK. Para ver y descargar JREs para una variedad de plataformas, incluidas Linux/UNIX Windows, consulte Descargas de Java SE.

Configuración de la variable Java Home

Las herramientas de línea de comandos dependen de una variable de entorno (JAVA_HOME) para localizar Java Runtime. Esta variable de entorno se debe establecer en la ruta completa del directorio que contiene un subdirectorio denominado bin que, a su vez, contiene el ejecutable java (en Linux y UNIX) o java.exe (en Windows).

Para establecer la variable Java_Home

1. Establezca la variable Java_Home.

   • En Linux y UNIX, escriba el comando siguiente:

     $ export JAVA_HOME=<PATH>

   • En Windows, escriba el siguiente comando:

     C:\> set JAVA_HOME=<PATH>

2. Confirme la configuración de la ruta ejecutando $JAVA_HOME/bin/java -version y comprobando la salida.

   • En Linux/UNIX, verá una salida similar a la siguiente:

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

   • En Windows, verá una salida similar a la siguiente:

     
     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)
     

Obtención de las herramientas de línea de comandos

Las herramientas de línea de comandos están disponibles en archivos ZIP en el sitio web de herramientas para desarrolladores de ElastiCache . Estas herramientas están escritas en Java e incluyen scripts de shell para Windows 2000/ XP/Vista/Windows 7, Linux/UNIX y Mac OSX. El archivo ZIP es autónomo y no requiere instalación; basta con descargarlo y descomprimirlo en un directorio del equipo local.

Configuración de las herramientas

Las herramientas de línea de comandos dependen de una variable de entorno (AWS_ELASTICACHE_HOME) para localizar las bibliotecas que necesitan. Es necesario configurar esta variable de entorno para poder utilizar las herramientas. Establézcala en la ruta del directorio en el que descomprimió las herramientas de línea de comandos. Este directorio se denomina ElastiCacheCli -A.b.nnnn (A, B y n son números de versión/versión) y contiene subdirectorios denominados bin y lib.

Para AWS configurar la variable de entorno _ELASTICACHE_HOME

• Abra una ventana de línea de comandos e introduzca uno de los siguientes comandos para configurar la variable de entorno _ELASTICACHE_HOME. AWS

  • En Linux y UNIX, escriba el comando siguiente:

    $ export &AWS;_ELASTICACHE_HOME=<path-to-tools>

  • En Windows, escriba el siguiente comando:

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

Para facilitar el uso de las herramientas, recomendamos que agregue el directorio BIN de herramientas a la ruta del sistema. En esta guía se presupone que el directorio BIN está en la ruta del sistema.

Para agregar el directorio BIN de las herramientas a la ruta del sistema

• Introduzca los siguientes comandos para agregar el directorio BIN de las herramientas a la ruta del sistema.

  • En Linux y UNIX, escriba el comando siguiente:

    $ export PATH=$PATH:$&AWS;_ELASTICACHE_HOME/bin

  • En Windows, escriba el siguiente comando:

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

nota

Las variables de entorno de Windows se restablecen cuando se cierra la ventana de comandos. Es posible que desee configurarlas de forma permanente. Para obtener más información, consulte la documentación de su versión de Windows.

nota

Las rutas que contienen espacios deben encerrarse entre comillas; por ejemplo:

"C:\Program Files\Java"

Suministro de credenciales para las herramientas

Las herramientas de línea de comandos necesitan la clave de AWS acceso y la clave de acceso secreta que vienen con su cuenta. AWS Puede obtenerlas desde la línea de comandos o desde un archivo de credenciales situado en el sistema local.

La implementación incluye un archivo de plantilla $ {AWS_ELASTICACHE_HOME}/credential-file-path.template que debes editar con tu información. A continuación se muestra el contenido del archivo de plantilla:

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

importante

En UNIX, limite los permisos al propietario del archivo de credenciales:

$ chmod 600 <the file created above>

Con el archivo de credenciales configurado, tendrá que configurar la variable de entorno AWS_CREDENTIAL_FILE para que las herramientas puedan encontrar su información. ElastiCache

Para configurar la variable de entorno _CREDENTIAL_FILE AWS

1. Establezca la variable de entorno :

   • En Linux y UNIX, actualice la variable con el comando siguiente:

     $ export &AWS;_CREDENTIAL_FILE=<the file created above>

   • En Windows, establezca la variable con el comando siguiente:

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

2. Compruebe que la configuración funciona correctamente; para ello, ejecute el comando siguiente:

   elasticache --help

   Debería ver la página de uso de todos los comandos de ElastiCache.

Variables de entorno

Las variables de entorno pueden resultar útiles para crear scripts, configurar valores predeterminados o anularlos temporalmente.

Además de la variable de entorno AWS_CREDENTIAL_FILE, la mayoría de las herramientas de API incluidas en la interfaz de línea de comandos admiten las ElastiCache siguientes variables:

• EC2_REGION: la región que se va a utilizar. AWS

• AWS_ELASTICACHE_URL: la URL que se utilizará para la llamada de servicio. No es necesario especificar un punto final regional diferente si se especifica EC2 _REGION o se pasa el parámetro --region.

Los siguientes ejemplos muestran cómo establecer la variable de entorno EC2 _REGION para configurar la región utilizada por las herramientas de la API:

Linux, OS X o Unix

$ export EC2_REGION=us-west-1 

Windows

$ set EC2_REGION=us-west-1