Paramètres des fichiers de configuration et d'informations d'identification

Exécutez cette commande pour définir et afficher rapidement vos informations d'identification, votre région et votre format de sortie. L'exemple suivant montre des exemples de valeurs.

$ 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

Vous pouvez définir les informations d'identification ou les paramètres de configuration à l'aide de la commande aws configure set. Spécifiez le profil que vous souhaitez consulter ou modifier avec le paramètre --profile.

Par exemple, la commande suivante définit le paramètre region dans le profil nommé integ.

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

Pour supprimer un paramètre, utilisez une chaîne vide comme valeur ou supprimez manuellement le paramètre dans vos fichiers config et credentials dans un éditeur de texte.

$ aws configure set cli_pager "" --profile integ

Vous pouvez récupérer les informations d'identification ou les paramètres de configuration que vous avez définis via aws configure get. Spécifiez le profil que vous souhaitez consulter ou modifier avec le paramètre --profile.

Par exemple, la commande suivante récupère le paramètre region dans le profil nommé integ.

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

Un résultat vide indique que le paramètre n'est pas explicitement défini et utilise la valeur par défaut.

Pour répertorier les données de configuration, utilisez la aws configure list commande. Cette commande répertorie le profil, la clé d'accès, la clé secrète et les informations de configuration de région utilisées pour le profil spécifié. Pour chaque élément de configuration, il indique la valeur, l'endroit où la valeur de configuration a été récupérée et le nom de la variable de configuration.

Par exemple, si vous fournissez la variable d'environnement Région AWS in an, cette commande indique le nom de la région que vous avez configurée, indique que cette valeur provient d'une variable d'environnement et le nom de la variable d'environnement.

Pour les méthodes d'identification temporaires telles que les rôles et IAM Identity Center, cette commande affiche la clé d'accès temporairement mise en cache et la clé d'accès secrète est affichée.

$ 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

Certains AWS services proposent plusieurs API versions pour garantir la rétrocompatibilité. Par défaut, AWS CLI les commandes utilisent la dernière API version disponible. Vous pouvez spécifier API la version à utiliser pour un profil en incluant le api_versions paramètre dans le config fichier.

Il s'agit d'un paramètre « imbriqué » suivi d'une ou de plusieurs lignes en retrait identifiant chacune un AWS service et la API version à utiliser. Consultez la documentation de chaque service pour savoir quelles API versions sont disponibles.

L'exemple suivant montre comment spécifier une API version pour deux AWS services. Ces API versions ne sont utilisées que pour les commandes exécutées sous le profil contenant ces paramètres.

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

Ce paramètre n'a pas de variable d'environnement ou de paramètre de ligne de commande équivalent.

Spécifie la clé AWS d'accès utilisée dans le cadre des informations d'identification pour authentifier la demande de commande. Bien qu'elle puisse être stockée dans le fichier config, nous vous recommandons de la stocker dans le fichier credentials.

Peut être remplacée par la variable d'environnement AWS_ACCESS_KEY_ID. Vous ne pouvez pas spécifier l'ID de clé d'accès sous forme d'option de ligne de commande.

aws_access_key_id = AKIAIOSFODNN7EXAMPLE

Spécifie la clé AWS secrète utilisée dans le cadre des informations d'identification pour authentifier la demande de commande. Bien qu'elle puisse être stockée dans le fichier config, nous vous recommandons de la stocker dans le fichier credentials.

Peut être remplacée par la variable d'environnement AWS_SECRET_ACCESS_KEY. Vous ne pouvez pas spécifier la clé d'accès secrète sous forme d'option de ligne de commande.

aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Spécifie un jeton de AWS session. Un jeton de session n'est nécessaire que si vous spécifiez manuellement des informations d'identification de sécurité temporaires. Bien qu'elle puisse être stockée dans le fichier config, nous vous recommandons de la stocker dans le fichier credentials.

Peut être remplacée par la variable d'environnement AWS_SESSION_TOKEN. Vous ne pouvez pas le jeton de session sous forme d'option de ligne de commande.

aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk

Spécifie un ensemble de certificats CA (un fichier avec l'.pemextension) utilisé pour vérifier les SSL certificats.

Peut être remplacé par la variable d'environnement AWS_CA_BUNDLE ou l'option de ligne de commande --ca-bundle.

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

Spécifie si les AWS CLI tentatives de suivre URL des liens dans les paramètres de ligne de commande commençant par http:// ouhttps://. Lorsque cette option est activée, le contenu récupéré est utilisé comme valeur de paramètre au lieu deURL.

Cette entrée n'a pas d'équivalent variable d'environnement ou option de ligne de commande.

cli_follow_urlparam = false

Ce paramètre est désactivé par défaut. Ce paramètre active l'historique des commandes pour AWS CLI. Après avoir activé ce paramètre, AWS CLI enregistre l'historique des aws commandes.

cli_history = enabled

Vous pouvez répertorier votre historique à l'aide de la aws history list commande et utiliser la aws history show commande qui command_ids en résulte pour plus de détails. Pour plus d'informations, consultez aws historyle guide AWS CLI de référence.

Spécifie le format des valeurs d'horodatage incluses dans la sortie. Vous pouvez spécifier chacune des valeurs suivantes :

Cette entrée n'a pas d'équivalent variable d'environnement ou option de ligne de commande.

cli_timestamp_format = iso8601

Spécifie une commande externe à exécuter AWS CLI pour générer ou récupérer les informations d'authentification à utiliser pour cette commande. La commande doit renvoyer les informations d'identification dans un format spécifique. Pour plus d'informations sur l'utilisation de ce paramètre, consultez Informations d'identification de la source avec un processus externe.

Cette entrée n'a pas d'équivalent variable d'environnement ou option de ligne de commande.

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

Utilisé dans les EC2 instances ou les conteneurs Amazon pour spécifier où se AWS CLI trouvent les informations d'identification à utiliser pour assumer le rôle que vous avez spécifié avec le role_arn paramètre. Vous ne pouvez pas spécifier à la fois source_profile et credential_source dans le même profil.

Ce paramètre peut avoir l'une des trois valeurs suivantes :

credential_source = Ec2InstanceMetadata

Spécifie la durée maximale de la session de rôle, en secondes. La valeur peut être comprise entre 900 secondes (15 minutes) et la valeur de durée de session maximale définie pour le rôle (soit 43 200 au maximum). Il s'agit d'un paramètre facultatif et, par défaut, la valeur est définie sur 3600 secondes.

Spécifie le point de terminaison utilisé pour toutes les demandes de service. Si ce paramètre est utilisé dans la servicessection du config fichier, le point de terminaison est utilisé uniquement pour le service spécifié.

L'exemple suivant utilise le point de terminaison global http://localhost:1234 et un point de terminaison spécifique au service http://localhost:4567 pour Amazon S3.

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

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

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

Si cette option est activée, elle AWS CLI ignore toutes les configurations de point de terminaison personnalisées spécifiées dans le config fichier. Les valeurs valides sont true et false.

ignore_configure_endpoint_urls = true

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

Identifiant unique utilisé par des tiers pour assumer un rôle dans les comptes de leurs clients. Il est mappé au paramètre ExternalId dans l'opération AssumeRole. Ce paramètre n'est nécessaire que si la stratégie d'approbation du rôle spécifie une valeur pour ExternalId. Pour plus d'informations, consultez la section Comment utiliser un identifiant externe lorsque vous accordez l'accès à vos AWS ressources à un tiers dans le Guide de IAM l'utilisateur.

Spécifie la valeur maximale de tentatives utilisées par le gestionnaire de AWS CLI nouvelles tentatives, l'appel initial étant pris en compte dans la max_attempts valeur que vous fournissez.

Vous pouvez remplacer cette valeur en utilisant la variable d'AWS_MAX_ATTEMPTSenvironnement.

max_attempts = 3

Le numéro d'identification d'un MFA appareil à utiliser pour assumer un rôle. Cela n'est obligatoire que si la politique de confiance du rôle assumé inclut une condition qui nécessite une MFA authentification. La valeur peut être le numéro de série d'un périphérique matériel (tel queGAHT12345678) ou le nom de ressource Amazon (ARN) pour un MFA appareil virtuel (tel quearn:aws:iam::123456789012:mfa/user).

Spécifie le format de sortie par défaut des commandes demandées en utilisant ce profil. Vous pouvez spécifier les valeurs suivantes :

Peut être remplacé par la variable d'environnement AWS_DEFAULT_OUTPUT ou l'option de ligne de commande --output.

output = table

Spécifie si le AWS CLI client tente de valider les paramètres avant de les envoyer au point de terminaison du AWS service.

Cette entrée n'a pas d'équivalent variable d'environnement ou option de ligne de commande.

parameter_validation = false

Spécifie Région AWS à qui envoyer les demandes pour les commandes demandées à l'aide de ce profil.

Vous pouvez remplacer cette valeur en utilisant la variable d' d'AWS_DEFAULT_REGIONenvironnement ou l'option de ligne de --region commande.

region = us-west-2

Spécifie le mode de nouvelle tentative AWS CLI utilisé. Trois modes de nouvelle tentative sont disponibles : ancien (par défaut), standard et adaptatif. Pour plus d'informations sur les nouvelles tentatives, consultez la section AWS CLI réessaie.

Vous pouvez remplacer cette valeur en utilisant la variable d'AWS_RETRY_MODEenvironnement.

retry_mode = standard

Spécifie le nom de ressource Amazon (ARN) d'un IAM rôle que vous souhaitez utiliser pour exécuter les AWS CLI commandes. Vous devez également spécifier l'un des paramètres suivants pour identifier les informations d'identification autorisées à assumer ce rôle :

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

La variable d'environnement AWS_ROLE_ARNremplace ce paramètre.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

Spécifie le nom à attacher à la session de rôle. Cette valeur est fournie au RoleSessionName paramètre lorsqu'il AWS CLI appelle l'AssumeRoleopération, et fait partie du rôle assumé user ARN : arn:aws:sts::123456789012:assumed-role/role_name/role_session_name. Ce paramètre est facultatif. Si vous ne spécifiez pas cette valeur, un nom de session est généré automatiquement. Ce nom s'affiche dans les journaux AWS CloudTrail pour les entrées associées à cette session.

role_session_name = maria_garcia_role

La variable d'environnement AWS_ROLE_SESSION_NAMEremplace ce paramètre.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

Spécifie la configuration du service à utiliser pour votre profil.

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

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

Pour plus d'informations sur services cette section, consultezType de section : services.

La variable d'environnement AWS_ROLE_SESSION_NAMEremplace ce paramètre.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

Un seul Compte AWS peut être utilisé par plusieurs applications clients pour passer des appels à AWS services. L'ID d'application identifie l'application source qui a effectué un ensemble d'appels à l'aide d'un AWS service. AWS SDKset les services n'utilisent ni n'interprètent cette valeur autrement que pour la réintégrer dans les communications avec les clients. Par exemple, cette valeur peut être incluse dans les e-mails opérationnels pour identifier de manière unique laquelle de vos applications est associée à la notification.

L'ID de l'application est une chaîne d'une longueur maximale de 50 caractères. Les lettres, les chiffres et les caractères spéciaux suivants sont autorisés : ! $ % & * + - . , ^ _ ` | ~ Par défaut, aucune valeur n'est attribuée.

sdk_ua_app_id = prod1

Ce paramètre peut être remplacé à l'aide de la variable d'environnement AWS_SDK_UA_APP_ID. Vous ne pouvez pas définir cette valeur en tant que paramètre de ligne de commande.

Spécifie un profil nommé avec des informations d'identification à long terme que l’ AWS CLI peut utiliser pour assumer un rôle que vous avez spécifié avec le paramètre role_arn. Vous ne pouvez pas spécifier à la fois source_profile et credential_source dans le même profil.

source_profile = production-profile

Spécifie comment AWS CLI détermine le point AWS de terminaison de service que le AWS CLI client utilise pour parler au AWS Security Token Service (AWS STS). La valeur par défaut pour AWS CLI la version 1 estlegacy.

Vous pouvez spécifier l'une des deux valeurs suivantes :

Ce paramètre peut être remplacé à l'aide de la variable d'environnement AWS_STS_REGIONAL_ENDPOINTS. Vous ne pouvez pas définir cette valeur en tant que paramètre de ligne de commande.

Permet d'utiliser des points de terminaison à double pile pour envoyer AWS des demandes. Pour en savoir plus sur les points de terminaison à double pile, qui prennent en charge à la fois le IPv6 trafic IPv4 et le trafic, consultez la section Utilisation des points de terminaison à double pile Amazon S3 dans le guide de l'utilisateur d'Amazon Simple Storage Service. Des points de terminaison à double pile sont disponibles pour certains services dans certaines régions. S'il n'existe pas de point de terminaison à double pile pour le service ou Région AWS si la demande échoue. Par défaut, l'option est désactivée.

Ce paramètre et use_accelerate_endpoint sont mutuellement exclusifs.

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

Certains AWS services proposent des points de terminaison compatibles avec la norme fédérale de traitement de l'information (FIPS) 140-2 dans certains cas. Régions AWS Lorsque le AWS service est pris en chargeFIPS, ce paramètre indique quel FIPS point de terminaison AWS CLI il doit utiliser. Contrairement aux AWS terminaux standard, les FIPS terminaux utilisent une bibliothèque TLS logicielle conforme FIPS à la norme 140-2. Ces points de terminaison peuvent être requis par les entreprises qui interagissent avec le gouvernement des États-Unis.

Si ce paramètre est activé, mais qu'il n'existe aucun point de FIPS terminaison pour le service dans votre ordinateur Région AWS, la AWS commande risque d'échouer. Dans ce cas, spécifiez manuellement le point de terminaison à utiliser dans la commande à l'aide de l'--endpoint-urloption ou utilisez des points de terminaison spécifiques au service.

Pour plus d'informations sur la spécification des FIPS points de terminaison par Région AWS, consultez la section FIPSPoints de terminaison par service.

Les paramètres de configuration du point de terminaison se trouvent à plusieurs endroits, tels que les variables d'environnement système ou utilisateur, les fichiers de AWS configuration locaux, ou sont explicitement déclarés sur la ligne de commande en tant que paramètre. Les paramètres de configuration du point de AWS CLI terminaison sont prioritaires dans l'ordre suivant :

Spécifie le chemin d'accès à un fichier contenant un jeton d'accès OAuth 2.0 ou un jeton d'identification OpenID Connect fourni par un fournisseur d'identité. L’ AWS CLI charge le contenu de ce fichier et le transmet en tant qu’argument WebIdentityToken à l'opération AssumeRoleWithWebIdentity.

La variable d'environnement AWS_WEB_IDENTITY_TOKEN_FILE remplace ce paramètre.

Pour plus d'informations sur l'utilisation des identités Web, consultezUtilisation d'un rôle à l'aide d'une identité web.

Spécifie si le AWS CLI client utilise des paquets TCP Keep-Alive.

Cette entrée n'a pas d'équivalent variable d'environnement ou option de ligne de commande.

tcp_keepalive = false

Spécifie le type d'adressage à utiliser. Cela permet de contrôler si le nom du bucket figure dans le nom d'hôte ou s'il en fait partie. URL Les valeurs valides sont path, virtual et auto. La valeur par défaut est auto.

Il existe deux styles de construction d'un point de terminaison Amazon S3. Le premier est appelé virtual et inclut le nom du compartiment dans le nom d'hôte. Par exemple : https://bucketname.s3.amazonaws.com. Sinon, avec le path style, vous traitez le nom du compartiment comme s'il s'agissait d'un chemin dans le URI ; par exemple,https://s3.amazonaws.com/bucketname. La valeur par défaut de CLI est to useauto, qui essaie d'utiliser le virtual style là où elle le peut, mais revient au path style si nécessaire. Par exemple, si le nom de votre compartiment n'est pas DNS compatible, le nom du compartiment ne peut pas faire partie du nom d'hôte et doit figurer dans le chemin. Avecauto, ils CLI détecteront cette condition et passeront automatiquement au path style pour vous. Si vous définissez le style d'adressage surpath, vous devez alors vous assurer que la AWS région dans laquelle vous avez configuré AWS CLI correspond à la région de votre compartiment.

Spécifie s'il faut SHA256 signer les charges utiles sigv4. Par défaut, cette option est désactivée pour les téléchargements en streaming (UploadPartetPutObject) lors de l'utilisationHTTPS. Par défaut, ce paramètre est défini sur false pour les téléchargements en streaming (UploadPartetPutObject), mais uniquement si un ContentMD5 est présent (il est généré par défaut) et que le terminal l'utiliseHTTPS.

Si le paramètre est défini sur true, les demandes S3 reçoivent une validation de contenu supplémentaire sous la forme d'une SHA256 somme de contrôle calculée pour vous et incluse dans la signature de la demande. Si la valeur est false, le total de contrôle n'est pas calculé. La désactivation peut s'avérer utile pour réduire la surcharge en termes de performances générée par le calcul du total de contrôle.

Utilisez le point de terminaison Amazon S3 Accelerate pour toutes les s3api commandes s3 et. La valeur par défaut est false. Ce paramètre et use_dualstack_endpoint sont mutuellement exclusifs.

S'il est défini sur true, toutes les AWS CLI demandes Amazon S3 sont dirigées vers le S3 Accelerate point de terminaison situé às3-accelerate.amazonaws.com. Pour utiliser ce point de terminaison, vous devez activer votre compartiment pour utiliser S3 Accelerate. Toutes les requêtes sont envoyées en utilisant le style virtuel de l'adressage de compartiment : my-bucket.s3-accelerate.amazonaws.com. Les requêtes ListBuckets, CreateBucket et DeleteBucket ne sont pas envoyées au point de terminaison S3 Accelerate, car celui-ci ne prend pas en charge ces opérations. Ce comportement peut également être défini sur si le paramètre --endpoint-url est défini sur https://s3-accelerate.amazonaws.com ou http://s3-accelerate.amazonaws.com pour toute commande s3api ou s3.

Spécifie la bande passante maximale qui peut être consommée pour le chargement et le téléchargement de données vers et depuis Amazon S3. La valeur par défaut sans limite.

Cela limite la bande passante maximale que les commandes S3 peuvent utiliser pour transférer des données vers et depuis Amazon S3. Cette valeur ne s'applique qu'aux chargements et aux téléchargements ; elle ne s'applique pas aux copies ou suppressions. La valeur est exprimée en octets par seconde. La valeur peut être spécifiée comme suit :

En général, nous vous recommandons de commencer par essayer de réduire la consommation de bande passante en diminuant max_concurrent_requests. Si cela ne limite pas la consommation de bande passante de façon adéquate pour le débit souhaité, vous pouvez utiliser le paramètre max_bandwidth pour limiter davantage la consommation de bande passante. Il en est ainsi parce que max_concurrent_requests contrôle le nombre de threads en cours d'exécution. Si à la place vous baissez d'abord max_bandwidth, mais conservez une valeur max_concurrent_requests élevée, cela peut conduire certains threads à attendre inutilement. Cela peut entraîner une consommation excessive de ressources et des délais d'expiration de connexion.

Spécifie le nombre maximal de requêtes simultanées. La valeur par défaut est 10.

Le commandes de transfert aws s3 sont multithread. À tout moment, plusieurs requêtes Amazon S3 peuvent être en cours d'exécution. Par exemple, lorsque vous utilisez la commande aws s3 cp localdir s3://bucket/ --recursive pour télécharger des fichiers dans un compartiment S3, ils AWS CLI peuvent télécharger les fichiers localdir/file1localdir/file2, et localdir/file3 en parallèle. Le paramètre max_concurrent_requests spécifie le nombre maximal d'opérations de transfert qui peuvent s'exécuter en même temps.

Vous devrez peut-être modifier cette valeur pour quelques raisons :

Spécifie le nombre maximal de tâches dans la file d'attente de tâches. La valeur par défaut est 1000.

AWS CLI En interne, il utilise un modèle dans lequel il met en file d'attente les tâches Amazon S3 qui sont ensuite exécutées par des consommateurs dont le nombre est limité à. max_concurrent_requests Une tâche correspond généralement à une seule opération Amazon S3. Par exemple, une tâche pourrait être une PutObjectTask, GetObjectTask ou UploadPartTask. La vitesse à laquelle les tâches sont ajoutées à la file d'attente peut être largement plus rapide que celle à laquelle les consommateurs terminent les tâches. Pour éviter une croissance sans limite, la taille de la file d'attente de tâches est limitée à une valeur spécifique. Ce paramètre modifie la valeur de ce nombre maximal.

En général, vous n'avez pas besoin de modifier ce paramètre. Ce paramètre correspond également au nombre de tâches dont il a connaissance et qui doivent être exécutées. AWS CLI Cela signifie que par défaut, ils ne AWS CLI peuvent voir que 1000 tâches à venir. L' AWS CLI augmentation de cette valeur permet de connaître plus rapidement le nombre total de tâches nécessaires, en supposant que le taux de mise en file d'attente est plus rapide que le taux d'achèvement des tâches. Le compromis est qu'une max_queue_size plus importante nécessite plus de mémoire.

Spécifie la taille de bloc AWS CLI utilisée pour les transferts partitionnés de fichiers individuels. La valeur par défaut est 8 Mo, avec un minimum de 5 Mo.

Lorsqu'un transfert de fichier dépasse lemultipart_threshold, il AWS CLI divise le fichier en morceaux de cette taille. Cette valeur peut être spécifiée en utilisant la même syntaxe que multipart_threshold, comme nombre d'octets sous la forme d'un entier ou en utilisant une taille et un suffixe.

Spécifie le seuil de taille AWS CLI utilisé pour les transferts partitionnés de fichiers individuels. La valeur par défaut est de 8 Mo.

Lors du chargement, du téléchargement ou de la copie d'un fichier, les commandes Amazon S3 passent aux opérations en plusieurs parties si le fichier dépasse cette taille. Vous pouvez spécifier cette valeur de deux manières :