Opciones de los archivos de configuración y credenciales

Ejecute este comando para establecer y ver rápidamente las credenciales de , la región y el formato de salida. En el ejemplo siguiente se muestran los valores de ejemplo.

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

Puede establecer las credenciales o las opciones de configuración mediante aws configure set. Especifique el perfil que desea ver o modificar con la opción --profile.

Por ejemplo, el siguiente comando configura region en el perfil denominado integ.

$ aws configure set region us-west-2 --profile integ

Para quitar una opción, utilice una cadena vacía como valor o elimine manualmente la opción de los archivos config y credentials en un editor de texto.

$ aws configure set cli_pager "" --profile integ

Puede recuperar las credenciales o las opciones de configuración que haya establecido utilizando aws configure get. Especifique el perfil que desea ver o modificar con la opción --profile.

Por ejemplo, el siguiente comando recupera la opción region en el perfil denominado integ.

$ aws configure get region --profile integ
us-west-2

Si la salida está vacía, significa que la configuración no está establecida de forma explícita y se utiliza el valor predeterminado.

Para mostrar los datos de configuración, utilice el comando aws configure list. Este comando muestra el perfil, la clave de acceso, la clave secreta y la información de configuración de la región utilizada para el perfil especificado. Para cada elemento de configuración, muestra el valor, dónde se recuperó el valor de configuración y el nombre de la variable de configuración.

Por ejemplo, si proporciona el valor Región de AWS en una variable de entorno, este comando le mostrará el nombre de la región que ha configurado, que este valor proviene de una variable de entorno y el nombre de la variable de entorno.

En el caso de los métodos de credenciales temporales, como los roles y el Centro de identidades de IAM, este comando muestra la clave de acceso almacenada temporalmente en caché y se muestra la clave de acceso secreta.

$ aws configure list
      Name                    Value             Type    Location
      ----                    -----             ----    --------
   profile                <not set>             None    None
access_key     ****************ABCD  shared-credentials-file    
secret_key     ****************ABCD  shared-credentials-file    
    region                us-west-2             env    AWS_DEFAULT_REGION

Algunos AWS servicios mantienen varias versiones de la API para permitir la compatibilidad con versiones anteriores. De forma predeterminada, AWS CLI los comandos utilizan la última versión de la API disponible. Puede especificar la versión de la API que se va a utilizar para un perfil mediante la inclusión de la configuración api_versions en el archivo config.

Se trata de una configuración «anidada» seguida de una o más líneas dentadas, cada una de las cuales identifica un AWS servicio y la versión de API que se va a utilizar. Consulte la documentación de cada servicio para saber qué versiones de API están disponibles.

En el siguiente ejemplo, se muestra cómo especificar una versión de API para dos servicios de AWS . Estas versiones de API se utilizan únicamente para los comandos que se ejecutan bajo el perfil que contiene estos ajustes.

api_versions =
    ec2 = 2015-03-01
    cloudfront = 2015-09-017

Este ajuste no tiene una variable de entorno ni un parámetro de línea de comandos equivalente.

Especifica la clave de AWS acceso utilizada como parte de las credenciales para autenticar la solicitud de comando. Aunque puede estar almacenada en el archivo config, recomendamos almacenar esta información en el archivo credentials.

Se puede anular mediante la variable de entorno AWS_ACCESS_KEY_ID. No se puede especificar el ID de clave de acceso como una opción de línea de comandos.

aws_access_key_id = AKIAIOSFODNN7EXAMPLE

Especifica la clave AWS secreta utilizada como parte de las credenciales para autenticar la solicitud de comando. Aunque puede estar almacenada en el archivo config, recomendamos almacenar esta información en el archivo credentials.

Se puede anular mediante la variable de entorno AWS_SECRET_ACCESS_KEY. No se puede especificar la clave de acceso secreta como una opción de línea de comandos.

aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Especifica un token AWS de sesión. Un token de sesión solo es necesario si especifica manualmente credenciales de seguridad temporales. Aunque puede estar almacenada en el archivo config, recomendamos almacenar esta información en el archivo credentials.

Se puede anular mediante la variable de entorno AWS_SESSION_TOKEN. No se puede especificar un token de sesión como una opción de línea de comandos.

aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk

Especifica un paquete de certificados de CA (un archivo con la extensión .pem) que se utiliza para verificar certificados SSL.

Se puede anular mediante la variable de entorno AWS_CA_BUNDLE o la opción de línea de comandos --ca-bundle.

ca_bundle = dev/apps/ca-certs/cabundle-2019mar05.pem

Especifica si los AWS CLI intentos de seguir los enlaces URL en los parámetros de la línea de comandos que comienzan por http:// ohttps://. Cuando la opción está habilitada, el contenido recuperado se utiliza como el valor del parámetro en lugar de la URL.

Esta entrada no tiene una variable de entorno equivalente ni una opción de línea de comandos.

cli_follow_urlparam = false

Está deshabilitado de forma predeterminada. Esta configuración habilita el historial de comandos para la AWS CLI. Tras activar esta configuración, AWS CLI registra el historial de aws comandos.

cli_history = enabled

Puede hacer una lista de su historial con el comando aws history list y utilizar los command_ids resultantes en el comando aws history show para obtener más información. Para obtener más información, consulte aws history en la Guía de referencia de AWS CLI .

Especifica el formato de los valores de la marca temporal incluidos en la salida. Puede especificar cualquiera de los siguientes valores:

Esta entrada no tiene una variable de entorno equivalente ni una opción de línea de comandos.

cli_timestamp_format = iso8601

Especifica un comando externo que AWS CLI se ejecuta para generar o recuperar las credenciales de autenticación que se utilizarán en este comando. El comando debe devolver las credenciales en un formato específico. Para obtener más información sobre el uso de esta configuración, consulte Obtener credenciales con un proceso externo.

Esta entrada no tiene una variable de entorno equivalente ni una opción de línea de comandos.

credential_process = /opt/bin/awscreds-retriever --username susan

Se utiliza en instancias o en contenedores de Amazon EC2 para especificar dónde la AWS CLI puede encontrar credenciales para usar a fin de asumir el rol que usted especificó con el parámetro role_arn. No puede especificar source_profile y credential_source en el mismo perfil.

Este parámetro puede tener uno de tres valores:

credential_source = Ec2InstanceMetadata

Especifica la duración máxima de la sesión de rol, en segundos. Este valor puede oscilar entre 900 segundos (15 minutos) y el valor de la duración máxima de la sesión para el rol (que puede ser 43200 como máximo). Se trata de un parámetro opcional y, de forma predeterminada, el valor se establece en 3600 segundos.

Especifica el punto de conexión que se utiliza para todas las solicitudes de servicio. Si esta configuración se usa en la sección de services del archivo config, el punto de conexión se usa solo para el servicio especificado.

En el siguiente ejemplo, se utiliza el punto de conexión global http://localhost:1234 y un punto de conexión específico del servicio de http://localhost:4567 para Amazon S3.

[profile dev]
endpoint_url = http://localhost:1234
services = s3-specific

[services s3-specific]
s3 = 
  endpoint_url = http://localhost:4567

Los valores de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

Si está habilitada, AWS CLI ignora todas las configuraciones de punto final personalizadas especificadas en el config archivo. Los valores válidos son true y false.

ignore_configure_endpoint_urls = true

Los ajustes de configuración de los puntos finales se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

Especifica un identificador único utilizado por terceros para adoptar un rol en las cuentas de los clientes. Se asigna al parámetro ExternalId en la operación AssumeRole. Este parámetro solo es necesario si la política de confianza del rol especifica un valor para ExternalId. Para obtener más información, consulte Cómo utilizar un ID externo para conceder acceso a sus AWS recursos a un tercero en la Guía del usuario de IAM.

Especifica el valor máximo de reintentos que utiliza el controlador de AWS CLI reintentos, donde la llamada inicial se tiene en cuenta para el max_attempts valor que usted proporciona.

Puede invalidar este valor mediante la variable de entorno de AWS_MAX_ATTEMPTS.

max_attempts = 3

El número de identificación del dispositivo MFA que se debe utilizar al asumir un rol. Este valor solo es obligatorio si la política de confianza del rol que se ha asumido incluye una condición que requiere autenticación MFA. El valor puede ser un número de serie de un dispositivo de hardware (como GAHT12345678) o un nombre de recurso de Amazon (ARN) de un dispositivo MFA virtual (como arn:aws:iam::123456789012:mfa/user).

Especifica el formato de la salida predeterminado para los comandos solicitados con este perfil. Puede especificar cualquiera de los siguientes valores:

Se puede anular mediante la variable de entorno AWS_DEFAULT_OUTPUT o la opción de línea de comandos --output.

output = table

Especifica si el AWS CLI cliente intenta validar los parámetros antes de enviarlos al punto final del AWS servicio.

Esta entrada no tiene una variable de entorno equivalente ni una opción de línea de comandos.

parameter_validation = false

Especifica el Región de AWS lugar al que se van a enviar las solicitudes para los comandos solicitados mediante este perfil.

Puede invalidar este valor mediante la variable de entorno AWS_DEFAULT_REGION o la opción de línea de comandos --region.

region = us-west-2

Especifica qué modo AWS CLI de reintento se utiliza. Hay tres modos de reintento disponibles: heredado (predeterminado), estándar y adaptativo. Para obtener más información acerca de los reintentos, consulte Reintentos de AWS CLI.

Puede invalidar este valor mediante la variable de entorno de AWS_RETRY_MODE.

retry_mode = standard

Especifica el nombre de recurso de Amazon (ARN) de una función de IAM que desee utilizar para ejecutar los comandos. AWS CLI También debe especificar uno de los siguientes parámetros para identificar las credenciales que tienen permiso para asumir este rol:

role_arn = arn:aws:iam::123456789012:role/role-name

La variable de entorno AWS_ROLE_ARN anula esta configuración.

Para obtener más información sobre el uso de las identidades web, consulte Adopción de un rol con una identidad web.

Especifica el nombre que se va a asociar a la sesión de rol. Este valor se proporciona al parámetro RoleSessionName cuando la AWS CLI llama a la operación AssumeRole y pasa a formar parte del ARN del usuario del rol asumido: arn:aws:sts::123456789012:assumed-role/role_name/role_session_name. Se trata de un parámetro opcional. Si no proporciona este valor, se genera automáticamente un nombre de sesión. Este nombre aparece en los registros de AWS CloudTrail correspondientes a las entradas asociadas a esta sesión.

role_session_name = maria_garcia_role

La variable de entorno AWS_ROLE_SESSION_NAME anula esta configuración.

Para obtener más información sobre el uso de las identidades web, consulte Adopción de un rol con una identidad web.

Especifica la configuración del servicio que se utilizará en el perfil.

[profile dev-s3-specific-and-global]
endpoint_url = http://localhost:1234
services = s3-specific

[services s3-specific]
s3 = 
  endpoint_url = http://localhost:4567

Para obtener más información sobre la sección de services, consulte Tipo de sección: services.

La variable de entorno AWS_ROLE_SESSION_NAME anula esta configuración.

Para obtener más información sobre el uso de las identidades web, consulte Adopción de un rol con una identidad web.

Especifica un perfil con nombre con credenciales duraderas que la AWS CLI puede utilizar para asumir el rol que ha especificado con el parámetro role_arn. No puede especificar source_profile y credential_source en el mismo perfil.

source_profile = production-profile

Especifica cómo AWS CLI determina el punto final del AWS servicio que el AWS CLI cliente utiliza para comunicarse con el AWS Security Token Service (AWS STS). El valor predeterminado de la AWS CLI versión 1 eslegacy.

Puede especificar uno de estos dos valores:

Esta configuración se puede sobrescribir utilizando la variable de entorno AWS_STS_REGIONAL_ENDPOINTS. No se puede establecer este valor como parámetro de la línea de comandos.

Permite el uso de puntos finales de doble pila para enviar AWS solicitudes. Para obtener más información sobre los puntos de conexión de doble pila, que admiten tráfico de IPv4 e IPv6, consulte Uso de puntos de conexión de doble pila de Amazon S3 en la Guía del usuario de Amazon Simple Storage Service. Los puntos de conexión de doble pila están disponibles para algunos servicios en algunas regiones. Si no existe un punto final de doble pila para el servicio o si la solicitud Región de AWS falla. Esta opción está deshabilitada de forma predeterminada.

Es mutuamente excluyente con la configuración use_accelerate_endpoint.

Los ajustes de configuración del punto final se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

Algunos AWS servicios ofrecen terminales que, en algunos casos, son compatibles con la Norma Federal de Procesamiento de Información (FIPS) 140-2. Regiones de AWS Cuando el AWS servicio es compatible con FIPS, esta configuración especifica qué punto final de FIPS se debe usar. AWS CLI A diferencia de AWS los puntos finales estándar, los puntos finales de FIPS utilizan una biblioteca de software TLS que cumple con la norma FIPS 140-2. Las empresas que trabajan con el gobierno de los Estados Unidos pueden requerir estos puntos de conexión.

Si esta configuración está habilitada, pero no existe un punto final FIPS para el servicio en su servidor, es posible que se produzca un error en el comando. Región de AWS AWS En este caso, especifique manualmente el punto de conexión que se va a utilizar en el comando mediante la opción --endpoint-url o utilice los puntos de conexión específicos del servicio.

Para obtener más información sobre cómo especificar los puntos de enlace de FIPS por Región de AWS, consulte Puntos de enlace de FIPS por servicio.

Los ajustes de configuración de los terminales se encuentran en varios lugares, como las variables de entorno del sistema o del usuario, los archivos de AWS configuración locales, o se declaran explícitamente en la línea de comandos como parámetros. Los ajustes de configuración del punto de conexión de la AWS CLI tienen prioridad en el siguiente orden:

Especifica la ruta de un archivo que contiene un token de acceso de OAuth 2.0 o un token de ID de OpenID Connect proporcionado por un proveedor de identidades. La AWS CLI carga el contenido de este archivo y lo pasa como argumento WebIdentityToken a la operación AssumeRoleWithWebIdentity.

La variable de entorno AWS_WEB_IDENTITY_TOKEN_FILE anula esta configuración.

Para obtener más información sobre el uso de las identidades web, consulte Adopción de un rol con una identidad web.

Especifica si el AWS CLI cliente utiliza paquetes TCP Keep-Alive.

Esta entrada no tiene una variable de entorno equivalente ni una opción de línea de comandos.

tcp_keepalive = false

Especifica qué estilo de direccionamiento debe usarse. Esto controla si el nombre del bucket está en el hostname o es parte de la URL. Los valores válidos son path, virtual y auto. El valor predeterminado es auto.

Hay dos estilos para crear un punto enlace de Amazon S3. El primero se llama virtual e incluye el nombre del bucket como parte del nombre de host. Por ejemplo: https://bucketname.s3.amazonaws.com. Si lo desea, también puede utilizar el estilo path, que tratará el nombre del bucket como si fuera una ruta del URI; por ejemplo, https://s3.amazonaws.com/bucketname. El valor predeterminado en la CLI es utilizar auto, que intenta utilizar el estilo virtual siempre que puede, pero usará el estilo path cuando sea necesario. Por ejemplo, si el nombre del bucket no es compatible con DNS, el nombre del bucket no puede formar parte del nombre de host y debe estar en la ruta. Con auto, la CLI detectará esta condición y cambiará automáticamente al estilo path. Si estableces el estilo de direccionamiento enpath, debes asegurarte de que la AWS región en la que configuraste AWS CLI coincida con la región de tu bucket.

Especifica si firma con SHA256 cargas de sigv4. De forma predeterminada, esta opción está deshabilitada para cargas de streaming (UploadPart y PutObject) cuando se utiliza https. De forma predeterminada, la opción está configurada en false para cargas de streaming (UploadPart y PutObject), pero solo si está presente un ContentMD5 (se genera de forma predeterminada) y el punto de enlace utiliza HTTPS.

Si se establece en verdadero, las solicitudes de S3 reciben validación de contenido adicional en forma de suma de comprobación SHA256 que se calcula automáticamente y se incluye en la firma de la solicitud. Si se establece en falso, la suma de comprobación no se calcula. Deshabilitar esta opción puede ser útil para reducir la sobrecarga de rendimiento creada por el cálculo de la suma de comprobación.

Utilice el punto de enlace de aceleración de Amazon S3 para todos los comandos s3 y s3api. El valor predeterminado es false. Es mutuamente excluyente con la configuración use_dualstack_endpoint.

Si se establece en true, AWS CLI dirige todas las solicitudes de Amazon S3 al S3 Accelerate punto de conexión ens3-accelerate.amazonaws.com. Para utilizar este punto de enlace, debe habilitar el bucket para que use S3 Accelerate. Todas las solicitudes se envían mediante el direccionamiento al bucket de estilo virtual: my-bucket.s3-accelerate.amazonaws.com. Las solicitudes ListBuckets, CreateBucket y DeleteBucket no se envían al punto de enlace de S3 Accelerate, ya que este punto de enlace no admite estas operaciones. Este comportamiento también se puede establecer si el parámetro --endpoint-url está establecido en https://s3-accelerate.amazonaws.com o http://s3-accelerate.amazonaws.com para cualquier comando s3api o s3.

Especifica el ancho de banda máximo que puede ser consumido para cargar y descargar datos desde y hacia Amazon S3. El valor predeterminado es sin límite.

Esto limita el ancho de banda máximo que los comandos de S3 pueden utilizar para transferir datos desde y hacia Amazon S3. Este valor se aplica únicamente a cargas y descargas; no se aplica a copias o eliminaciones. El valor se expresa como bytes por segundo. El valor puede especificarse como:

En general, se recomienda intenta reducir primero el consumo de ancho de banda, disminuyendo las max_concurrent_requests. Si así no se reduce el consumo de ancho de banda lo suficiente para conseguir la velocidad deseada, puede utilizar la opción max_bandwidth para limitar más el consumo de ancho de banda. Esto se debe a que max_concurrent_requests controla la cantidad de subprocesos se están ejecutando en este momento. Si en su lugar reduce primero max_bandwidth pero deja max_concurrent_requests en un valor alto, puede provocar que los subprocesos tengan que esperar innecesariamente. Esto puede provocar un consumo excesivo de recursos y que se agoten los tiempos de espera de conexión.

Especifica el número máximo de solicitudes concurrentes. El valor predeterminado es 10.

Los comandos de transferencia de aws s3 tienen varios subprocesos. En un momento dado, es posible que se estén ejecutando varias solicitudes de Amazon S3. Por ejemplo, cuando usas el comando aws s3 cp localdir s3://bucket/ --recursive para cargar archivos en un bucket de S3, AWS CLI puedes cargar los archivos localdir/file1 y localdir/file3 en paralelo. localdir/file2 La configuración max_concurrent_requests especifica el número máximo de operaciones de transferencia que se pueden ejecutar al mismo tiempo.

Es posible que tenga que cambiar este valor por varios motivos:

Especifica el número máximo de tareas en la cola. El valor predeterminado es 1000.

AWS CLI Internamente, utiliza un modelo en el que pone en cola las tareas de Amazon S3 que luego son ejecutadas por consumidores cuyo número está limitado pormax_concurrent_requests. Una tarea, por lo general, se asigna a una sola operación de Amazon S3. Por ejemplo, una tarea puede ser PutObjectTask, GetObjectTask o UploadPartTask. La velocidad a la que se añaden tareas a la cola puede ser mucho más rápida que la velocidad en la que los consumidores finalizan las tareas. Para evitar el crecimiento ilimitado, el tamaño de la cola de tareas se limita a un tamaño específico. Esta configuración cambia el valor de ese número máximo.

Por lo general, no tendrá que cambiar este ajuste. Esta configuración también corresponde al número de tareas que AWS CLI sabe que deben ejecutarse. Esto significa que, de forma predeterminada, solo AWS CLI puede ver 1000 tareas por delante. Si se aumenta este valor, AWS CLI se puede saber más rápidamente el número total de tareas necesarias, suponiendo que el ritmo de espera sea más rápido que el ritmo de finalización de las tareas. La desventaja es que un valor mayor en max_queue_size, exige también más memoria.

Especifica el tamaño del fragmento que se AWS CLI utiliza para las transferencias multipartes de archivos individuales. El valor predeterminado es 8 MB, con un mínimo de 5 MB.

Cuando la transferencia de un archivo supera el multipart_threshold, la AWS CLI divide el archivo en fragmentos de este tamaño. Este valor puede especificarse utilizando la misma sintaxis que en multipart_threshold, ya sea especificando el número de bytes como un número entero o especificando un tamaño y un sufijo.

Especifica el umbral de tamaño que se AWS CLI utiliza para las transferencias multipartes de archivos individuales. El valor predeterminado es 8 MB.

Al cargar, descargar o copiar un archivo, los comandos de Amazon S3 cambian a operaciones multiparte si el archivo supera este tamaño. Puede especificar este valor de una de las dos formas siguientes: