Ajustes de configuración y archivos de credenciales en el AWS CLI

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 eliminar un ajuste, elimínalo manualmente en tus credentials archivos config y en un editor de texto.

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 las funciones y el Centro de IAM identidad, 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 API versiones para permitir la compatibilidad con versiones anteriores. De forma predeterminada, AWS CLI los comandos utilizan la última API versión disponible. Puede especificar una API versión para utilizarla en un perfil incluyendo la api_versions configuración en el config archivo.

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 API versión que se va a utilizar. Consulte la documentación de cada servicio para saber qué API versiones están disponibles.

El siguiente ejemplo muestra cómo especificar una API versión para dos AWS servicios. Estas API versiones se utilizan únicamente para los comandos que se ejecutan en el perfil que contiene esta configuración.

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 .pem extensión) que se utiliza para comprobar SSL los certificados.

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 URL los enlaces de los parámetros de la línea de comandos que comienzan por http:// ohttps://. Cuando está activado, el contenido recuperado se utiliza como valor del parámetro en lugar delURL.

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 Obtención de credenciales con un proceso externo en el AWS CLI.

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 usa en EC2 las instancias o contenedores de Amazon para especificar dónde AWS CLI se pueden encontrar las credenciales que se utilizarán para asumir la función que especificó con el role_arn parámetro. 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á activado, 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 identificador externo al conceder acceso a sus AWS recursos a un tercero en la Guía del IAM usuario.

Especifica el valor máximo de intentos de reintento 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 de un MFA dispositivo que se utilizará al asumir una función. Esto es obligatorio solo si la política de confianza del rol que se asume incluye una condición que requiera la MFA autenticación. El valor puede ser un número de serie de un dispositivo de hardware (por ejemploGAHT12345678) o un nombre de recurso de Amazon (ARN) para un MFA dispositivo virtual (por ejemploarn: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 deben 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 AWS CLI vuelve a intentarlo en el 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 un IAM rol que desea usar para ejecutar los AWS CLI comandos. 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 RoleSessionName parámetro cuando AWS CLI llama a la AssumeRole operación y pasa a formar parte del rol asumido userARN: 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.

Varias aplicaciones de clientes Cuenta de AWS pueden utilizar una sola aplicación para realizar llamadas Servicios de AWS. El ID de aplicación identifica qué aplicación de origen realizó un conjunto de llamadas mediante un Servicio de AWS. AWS SDKsy los servicios no utilizan ni interpretan este valor más que para mostrarlo en las comunicaciones con los clientes. Por ejemplo, este valor se puede incluir en los correos electrónicos operativos para identificar de forma exclusiva qué aplicaciones están asociadas a la notificación.

El identificador de la aplicación es una cadena con una longitud máxima de 50 caracteres. Se permiten letras, números y los siguientes caracteres especiales: de forma ! $ % & * + - . , ^ _ ` | ~ predeterminada, no se asigna ningún valor.

sdk_ua_app_id = prod1

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

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 enlace de doble pila, que admiten tanto como IPv4 el IPv6 tráfico, consulte Uso de los puntos de enlace 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 Región de AWS si la solicitud 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 la Información (FIPS) 140-2. Regiones de AWS Cuando el AWS servicio lo admiteFIPS, esta configuración especifica qué FIPS punto final AWS CLI debe usar. A diferencia de AWS los puntos finales estándar, los FIPS puntos finales utilizan una biblioteca de TLS software que cumple con FIPS la norma 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 FIPS punto final para el servicio en su servidor Región de AWS, es posible que se produzca un error en el AWS comando. 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 FIPS puntos de enlace por Región de AWS, consulte FIPSPuntos finales 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 a un archivo que contiene un token de acceso OAuth 2.0 o un token de ID de OpenID Connect proporcionado por un proveedor de identidad. 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 usa 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 nombre del host o forma parte delURL. 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. Como alternativa, con el path estilo, se trata el nombre del bucket como si fuera una ruta delURI; por ejemplo,https://s3.amazonaws.com/bucketname. El valor predeterminado CLI es usarauto, que intenta usar el virtual estilo siempre que puede, pero volverá a usar el path estilo cuando sea necesario. Por ejemplo, si el nombre del depósito no es DNS compatible, el nombre del depósito no puede formar parte del nombre de host y debe estar en la ruta. Con auto él, CLI detectará esta condición y cambiará automáticamente a su path estilo. 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 se SHA256 firmarán las cargas útiles sigv4. De forma predeterminada, está deshabilitada para las subidas en streaming (UploadPartyPutObject) cuando se utiliza. HTTPS De forma predeterminada, está configurado false para las subidas en streaming (UploadPartyPutObject), pero solo si ContentMD5 hay un (se genera de forma predeterminada) y el terminal lo usa. HTTPS

Si se establece en true, las solicitudes de S3 reciben una validación de contenido adicional en forma de una SHA256 suma de comprobación 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: