Paramètres des fichiers de configuration et d'informations d'identification - AWS Command Line Interface

Python 2.7, 3.4 et 3.5 sont obsolètes pour leAWS CLIversion 1. Pour en savoir plus, consultez leAWS CLIsection version 1 deÀ propos de laAWS CLIversions.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

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

Vous pouvez enregistrer vos paramètres de configuration utilisés fréquemment et vos informations d'identification dans les fichiers qui sont gérés par l'AWS CLI.

Les fichiers sont divisés en profiles. Par défaut, la zoneAWS CLIutilise les paramètres du profil nommédefault. Pour utiliser d'autres paramètres, vous pouvez créer d'autres profils et y faire référence. Pour plus d'informations sur les profils nommés, veuillez consulter Profils nommés.

Vous pouvez également remplacer un paramètre spécifique en définissant l'une des variables d'environnement prises en charge ou un paramètre de ligne de commande. Pour plus d'informations sur la priorité des paramètres de configuration, veuillez consulter Configuration des paramètres et des priorités.

Où les paramètres de configuration sont-ils stockés ?

L'AWS CLI stocke les informations d'identification que vous spécifiez avec aws configure dans un fichier local nommé credentials dans un dossier nommé .aws dans le répertoire de base. Les autres options de configuration que vous spécifiez avec aws configure sont stockées dans un fichier local nommé config, également stocké dans le dossier .aws du répertoire de base.

Stockage des informations d'identification dans le fichier de configuration

Vous pouvez conserver tous vos paramètres de profil dans un seul fichier, car l'AWS CLI peut lire les informations d'identification à partir du fichier config. S'il existe des informations d'identification dans les deux fichiers pour un profil partageant le même nom, les clés du fichier d'informations d'identification ont priorité.

Ces fichiers sont également utilisés par les divers kits de développement logiciel (SDK). Si vous utilisez l'un des kits SDK en plus de l'AWS CLI, confirmez si les informations d'identification doivent être stockées dans leur propre fichier.

L'emplacement du répertoire de base varie selon le système d'exploitation, mais il est référencé à l'aide de variables d'environnement %UserProfile% sous Windows et $HOME ou ~ (tilde) sur les systèmes Unix. Pour spécifier un emplacement autre que celui par défaut pour le fichier config, définissez un autre chemin local dans la variable d'environnement AWS_CONFIG_FILE. Consultez Variables d'environnement pour configurer l’AWS CLI. pour plus de détails.

Par exemple, les fichiers générés par leAWS CLIpour un profil par défaut configuré avecaws configureressemble à ce qui suit.

~/.aws/credentials

[default] aws_access_key_id=AKIAIOSFODNN7EXAMPLE aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

~/.aws/config

[default] region=us-west-2 output=json

Pour obtenir des exemples de fichiers comportant plusieurs profils nommés, veuillez consulter Profils nommés.

Lorsque vous utilisez un profil partagé qui spécifie unAWS Identity and Access Management(IAM), l'intentionAWS CLIappelle l'intentionAWS STS AssumeRoleopération pour récupérer des informations d'identification temporaires. Ces informations d'identification sont ensuite stockées (dans ~/.aws/cli/cache). Les commandes d’AWS CLI suivantes utilisent les informations d'identification temporaires mises en cache jusqu'à ce qu'elles expirent ; à ce stade, l’AWS CLI actualise automatiquement les informations d'identification.

Définition et affichage des paramètres de configuration

Il existe plusieurs façons d'afficher et de définir vos paramètres de configuration dans les fichiers.

Informations d'identification et fichier de configuration

Pour consulter et modifier vos paramètres, modifiez directement les fichiers config et credentials dans un éditeur de texte. Pour plus d'informations, consultez la section .Où les paramètres de configuration sont-ils stockés ?

Pour supprimer un paramètre, supprimez le paramètre correspondant dans vos fichiers config et credentials.

aws configure

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

Pour plus d'informations, consultez la section .Configuration rapide avec aws configure

aws configure set

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
aws configure get

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.

aws configure import
Cette fonction est disponible uniquement avec l'.AWS CLIversion 2.

La fonctionnalité suivante n'est disponible que si vous utilisez l'.AWS CLIversion 2. Elle n'est pas disponible si vous exécutez l'.AWS CLIversion 1. Pour de plus amples informations sur l'installation de la version 2, consultez Installation, mise à jour et désinstallation de l’AWS CLIversion 2.

Importez les informations d'identification CSV générées à partir de la console web AWS. Un fichier CSV est importé avec le nom de profil correspondant au nom d'utilisateur IAM. Le fichier CSV doit contenir les en-têtes suivants.

  • Nom utilisateur

  • ID de clé d'accès

  • Clé d'accès secrète

$ aws configure import --csv file://credentials.csv
aws configure list

Pour afficher la liste de toutes les données de configuration, utilisez la commande aws configure list. Cette commande affiche le nom d'AWS CLI de tous les paramètres que vous avez configurés, leurs valeurs et l'endroit à partir duquel la configuration a été récupéré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
aws configure list-profiles
Cette fonction est disponible uniquement avec l'.AWS CLIversion 2.

La fonctionnalité suivante n'est disponible que si vous utilisez l'.AWS CLIversion 2. Elle n'est pas disponible si vous exécutez l'.AWS CLIversion 1. Pour de plus amples informations sur l'installation de la version 2, consultez Installation, mise à jour et désinstallation de l’AWS CLIversion 2.

Pour afficher la liste de tous les noms de profil, utilisez la commande aws configure list-profiles.

$ aws configure list-profiles default test

Paramètres de fichier config pris en charge

Les paramètres suivants sont pris en charge dans le fichier config. Les valeurs reprises dans le profil spécifié (ou par défaut) sont utilisées, sauf si elles sont remplacées par la présence d'une variable d'environnement de même nom ou une option de ligne de commande de même nom. Pour plus d'informations sur les paramètres de commande qui sont prédéfinis, veuillez consulter Configuration des paramètres et des priorités

Global Settings (Paramètres globaux)

api_versions

(disponible dans la régionAWS CLIversion 1 uniquement.)MomentanéeAWSles services conservent plusieurs versions d'une API pour prendre en charge la rétrocompatibilité. Par défaut,AWS CLIutilise la dernière version disponible de l'API. Vous pouvez spécifier une version de l'API à utiliser pour un profil en incluant le paramètre api_versions dans le fichier config.

Il s'agit d'un paramètre « imbriqué » qui est suivi d'une ou plusieurs lignes en retrait qui identifient chacune un service AWS et la version de l'API à utiliser. Reportez-vous à la documentation de chaque service pour comprendre les versions de l'API disponibles.

L'exemple suivant illustre comment spécifier une version de l'API pour deux services AWS. Ces versions de l'API ne sont utilisées que pour les commandes qui s'exécutent sous le profil qui contient 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.

aws_access_key_id

Spécifie la clé d'accès AWS utilisée dans les 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
aws_secret_access_key

Spécifie la clé secrète AWS utilisée dans les 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
aws_session_token

Spécifie un jeton de session AWS. 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
ca_bundle

Spécifie un ensemble de certificat CA (un fichier avec l'extension .pem) qui est utilisé pour vérifier les certificats SSL.

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
cli_auto_prompt
Cette fonction est disponible uniquement avec l'.AWS CLIversion 2.

La fonctionnalité suivante n'est disponible que si vous utilisez l'.AWS CLIversion 2. Elle n'est pas disponible si vous exécutez l'.AWS CLIversion 1. Pour de plus amples informations sur l'installation de la version 2, consultez Installation, mise à jour et désinstallation de l’AWS CLIversion 2.

Active l'invite automatique pour leAWS CLIversion 2. Deux paramètres peuvent être utilisés :

  • onutilise le mode d'invite automatique complet chaque fois que vous tentez d'exécuter unawscommande. Cela inclut le pressageENTRERaprès une commande complète ou une commande incomplète.

    cli_auto_prompt = on
  • on-partialutilise le mode d'invite automatique partielle. Si une commande est incomplète ou ne peut pas être exécutée en raison d'erreurs de validation côté client, l'invite automatique est utilisée. Ce mode est particulièrement utile si vous possédez des scripts, des runbooks préexistants ou si vous souhaitez uniquement recevoir une demande automatique pour les commandes que vous ne connaissez pas, plutôt que si vous y êtes invité.

    cli_auto_prompt = on-partial

Vous pouvez remplacer ce paramètre à l'aide duaws_cli_auto_promptou la variable d'environnement--cli-auto-promptand--no-cli-auto-promptparamètres de ligne de commande.

Pour plus d'informations sur leAWS CLIfonction d'invite automatique version 2, voirHAVANTAWS CLIvous invite à entrer des commandes.

cli_binary_format
Cette fonction est disponible uniquement avec l'.AWS CLIversion 2.

La fonctionnalité suivante n'est disponible que si vous utilisez l'.AWS CLIversion 2. Elle n'est pas disponible si vous exécutez l'.AWS CLIversion 1. Pour de plus amples informations sur l'installation de la version 2, consultez Installation, mise à jour et désinstallation de l’AWS CLIversion 2.

Spécifie comment leAWS CLILa version 2 interprète les paramètres d'entrée binaire. Il peut avoir l'une des valeurs suivantes :

  • base64— il s'agit de la valeur par défaut. Un paramètre d'entrée qui est saisi comme un objet BLOB accepte une chaîne codée en base64. Pour transmettre le contenu binaire réel, placez le contenu dans un fichier et indiquez le chemin d'accès et le nom du fichier avec le préfixe fileb:// comme valeur du paramètre. Pour transmettre du texte codé en base64 contenu dans un fichier, indiquez le chemin d'accès et le nom du fichier avec le préfixe file:// comme valeur du paramètre.

  • raw-in-base64-out— Fournit une compatibilité descendante avec leAWS CLIComportement de version 1 par lequel les valeurs binaires doivent être transmises littéralement.

Cette entrée n'a pas de variable d'environnement équivalente. Vous pouvez spécifier la valeur sur une commande seule à l'aide du paramètre --cli-binary-format raw-in-base64-out.

cli_binary_format = raw-in-base64-out

Si vous référencez une valeur binaire dans un fichier en utilisant la notation de préfixe fileb://, l'AWS CLI s'attend toujours à ce que le fichier contienne du contenu binaire brut et ne tente pas de convertir la valeur.

Si vous référencez une valeur binaire dans un fichier à l'aide de la notation de préfixe file://, l'AWS CLI gère le fichier en fonction du paramètre cli_binary_format actuel. Si la valeur de ce paramètre estbase64(valeur par défaut lorsqu'elle n'est pas explicitement définie), leAWS CLIs'attend à ce que le fichier contienne du texte codé en base64. Si la valeur de ce paramètre estraw-in-base64-out, leAWS CLIs'attend à ce que le fichier contienne du contenu binaire brut.

cli_follow_urlparam
Cette fonction est disponible uniquement avec l'.AWS CLIversion 1.

La fonctionnalité suivante n'est disponible que si vous utilisez l'.AWS CLIversion 1. Elle n'est pas disponible si vous exécutez l'.AWS CLIversion 2.

Spécifie si leAWS CLItente de suivre les liens d'URL dans les paramètres de ligne de commande qui commencent parhttp://ouhttps://. Lorsque cette option est activée, le contenu récupéré est utilisé comme valeur de paramètre à la place de l'URL.

  • vrai— il s'agit de la valeur par défaut. Lorsque cette option est configurée, tous les paramètres de chaîne qui commencent par http:// ou https:// sont récupérés et le contenu téléchargé est utilisé comme valeur de paramètre pour la commande.

  • false— S'il est spécifié, leAWS CLIne traite pas les valeurs de chaîne de paramètre qui commencent parhttp://ouhttps://différemment des autres chaînes.

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

cli_follow_urlparam = false
cli_pager
Cette fonction est disponible uniquement avec l'.AWS CLIversion 2.

La fonctionnalité suivante n'est disponible que si vous utilisez l'.AWS CLIversion 2. Elle n'est pas disponible si vous exécutez l'.AWS CLIversion 1. Pour de plus amples informations sur l'installation de la version 2, consultez Installation, mise à jour et désinstallation de l’AWS CLIversion 2.

Spécifie le programme de pager utilisé pour la sortie. Par défaut,AWS CLILa version 2 renvoie toutes les sorties via le programme du pager par défaut de votre système d'exploitation.

Peut être remplacé par la variable d'environnement AWS_PAGER.

cli_pager=less

Pour désactiver toute utilisation d'un programme de pagination externe, définissez la variable sur une chaîne vide, comme illustré dans l'exemple suivant.

cli_pager=
cli_timestamp_format

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

  • ISO 8601— La valeur par défaut duAWS CLIversion 2. En cas de spécification, l'AWS CLI reformate tous les horodatages selon la norme ISO 8601.

  • fil— La valeur par défaut duAWS CLIversion 1. En cas de spécification, l'AWS CLI affiche toutes les valeurs d'horodatage exactement telles qu'elles ont été reçues dans la réponse de requête HTTP.

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

cli_timestamp_format = iso8601
credential_process

Spécifie une commande externe que la commandeAWS CLIs'exécute pour générer ou récupérer des 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 Utilisation d'informations d'identification provenant d'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
credential_source

Utilisé dans des instances ou des conteneurs Amazon EC2 pour spécifier où leAWS CLIpeut trouver les informations d'identification à utiliser pour assumer le rôle que vous avez spécifié avec lerole_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 :

  • Environnement— Spécifie que leAWS CLIconsiste à récupérer les informations d'identification source à partir des variables d'environnement.

  • Métadonnées d'instance EC2— Spécifie que leAWS CLIconsiste à utiliser le rôle IAM attaché auProfil d'instance EC2pour obtenir les informations d'identification des sources.

  • EcsContainer— Spécifie que leAWS CLIconsiste à utiliser le rôle IAM attaché au conteneur ECS comme informations d'identification source.

credential_source = Ec2InstanceMetadata
duration_seconds

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.

external_id

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 de plus amples informations, veuillez consulterProcédure d'utilisation d'une passerelle externe lorsque vous accordez l'accès à votreAWSRessources destinées à un tiersdans leIAM User Guide.

max_attempts

Spécifie la valeur des tentatives maximales de nouvelles tentativesAWS CLIutilise le gestionnaire de nouvelles tentatives, où l'appel initial compte pour lemax_attemptsvaleur que vous fournissez.

Vous pouvez remplacer cette valeur à l'aide deAWS_MAX_ATTEMPTSvariable d'environnement.

max_attempts = 3
mfa_serial

Numéro d'identification d’un périphérique MFA à utiliser lors de l'endossement d'un rôle. Cela est obligatoire seulement si la stratégie d'approbation du rôle assumé inclut une condition exigeant une authentification MFA. La valeur peut être un numéro de série pour un périphérique matériel (tel que GAHT12345678) ou un Amazon Resource Name (ARN) pour un périphérique MFA virtuel (tel que arn:aws:iam::123456789012:mfa/user).

output

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

  • json— La sortie est au format d'JSONChaîne.

  • yaml— La sortie est au format d'YAMLChaîne. (disponible dans la régionAWS CLIversion 2 uniquement.)

  • yaml-stream— La sortie est diffusée en continu et formatée en tant queYAMLChaîne. La diffusion en continu permet une gestion plus rapide des grands types de données. (disponible dans la régionAWS CLIversion 2 uniquement.)

  • text— La sortie est formatée en plusieurs lignes de valeurs de chaîne séparées par des tabulations. Cela peut être utile pour transmettre la sortie à un processeur de texte, commegrep,sed, ouawk.

  • table— La sortie est au format d'un tableau utilisant les caractères +|- pour délimiter les bordures des cellules. La présentation des informations est dans un format beaucoup plus lisible par l'utilisateur que les autres, mais peu pratique du point de vue programmation.

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

output = table
parameter_validation

Spécifie si le client de l'AWS CLI tente de valider les paramètres avant de les envoyer vers le point de terminaison des services AWS.

  • vrai— il s'agit de la valeur par défaut. S'il est spécifié, leAWS CLIeffectue une validation locale des paramètres de ligne de commande.

  • false— S'il est spécifié, leAWS CLIne valide pas les paramètres de ligne de commande avant de les envoyer vers leAWSpoint de terminaison de service.

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

parameter_validation = false
region

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

  • Vous pouvez spécifier chacun des codes de région disponibles pour le service choisi comme répertoriés dansAWSRégions et points de terminaisondans leRéférence générale Amazon Web Services.

  • aws_globalvous permet de spécifier le point de terminaison global pour les services qui prennent en charge un point de terminaison global en plus des points de terminaison régionaux, tels que :AWS Security Token Service(AWS STS) et Amazon Simple Storage Service (Amazon S3).

Vous pouvez remplacer cette valeur à l'aide de la variable d'environnement AWS_DEFAULT_REGION ou de l'option de ligne de commande --region.

region = us-west-2
retry_mode

Spécifie quel mode de nouvelle tentativeAWS CLIutilise. Trois modes de nouvelle tentative sont disponibles : hérité (par défaut), standard et adaptatif. Pour plus d'informations sur les nouvelles tentatives, consultez la section AWS CLIretries.

Vous pouvez remplacer cette valeur à l'aide deAWS_RETRY_MODEvariable d'environnement.

retry_mode = standard
role_arn

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

  • source_profile

  • credential_source

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

La variable d'environnementAWS_ROLE_ARNremplace ce paramètre.

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

role_session_name

Spécifie le nom à attacher à la session de rôle. Cette valeur est fournie à l'.RoleSessionNamelorsque le paramètreAWS CLIappelle l'intentionAssumeRoleet fait partie de l'ARN utilisateur du rôle assumé : 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'environnementAWS_ROLE_SESSION_NAMEremplace ce paramètre.

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

source_profile

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
sso_account_id (disponible dans la régionAWS CLIversion 2 uniquement.)

Spécifie la zoneAWSID de compte qui contient le rôle IAM avec l'autorisation que vous souhaitez accorder à l'associéAWS SSOutilisateur.

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

sso_account_id = 123456789012
sso_region (disponible dans la régionAWS CLIversion 2 uniquement.)

Spécifie la région AWS qui contient l'hôte du portail AWS SSO. Cette région est distincte, et peut être différente du paramètre region de l'interface de ligne de commande par défaut.

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

aws_sso_region = us_west-2
sso_role_name (disponible dans la régionAWS CLIversion 2 uniquement.)

Nom convivial du rôle IAM qui définit les autorisations de l'utilisateur lors de l'utilisation de ce profil.

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

sso_role_name = ReadAccess
sso_start_url (disponible dans la régionAWS CLIversion 2 uniquement.)

Spécifie l'URL qui pointe vers le portail utilisateur AWS SSO de l'organisation. L'AWS CLI utilise cette URL pour établir une session avec le service AWS SSO pour authentifier ses utilisateurs.

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

sso_start_url = https://my-sso-portal.awsapps.com/start
sts_regional_endpoints

Spécifie de quelle manière l'AWS CLI détermine le point de terminaison de service AWS utilisé par le client de l'AWS CLI pour parler à AWS Security Token Service (AWS STS).

  • La valeur par défaut deAWS CLILa version 1 est.legacy.

  • La valeur par défaut deAWS CLILa version 2 est.regional.

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

  • legacy— Utilise le point de terminaison STS global,sts.amazonaws.com, pour ce qui suitAWSRégions :ap-northeast-1,ap-south-1,ap-southeast-1,ap-southeast-2,aws-global,ca-central-1,eu-central-1,eu-north-1,eu-west-1,eu-west-2,eu-west-3,sa-east-1,us-east-1,us-east-2,us-west-1, etus-west-2. Toutes les autres régions utilisent automatiquement leur point de terminaison régional respectif.

  • regional— LeAWS CLIutilise toujours la régionAWS STSpoint de terminaison pour la région en cours de configuration. Par exemple, si le client est configuré pour utiliser us-west-2, tous les appels à AWS STS sont effectués vers le point de terminaison sts.us-west-2.amazonaws.com régional au lieu du point de terminaison sts.amazonaws.com global. Pour envoyer une demande au point de terminaison global lorsque ce paramètre est activé, vous pouvez définir la région sur aws-global.

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.

web_identity_token_file

Spécifie le chemin d'accès à un fichier qui contient 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'environnementAWS_WEB_IDENTITY_TOKEN_FILEremplace ce paramètre.

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

tcp_keepalive

Spécifie si le client de l'AWS CLI 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

Paramètres de commandes personnalisées S3

Amazon S3 prend en charge plusieurs paramètres qui configurent comment l'AWS CLIeffectue des opérations Amazon S3. Certains s'appliquent à toutes les commandes S3 dans les deux espaces de noms s3 et s3api. D'autres sont spécifiques aux commandes « personnalisées » S3 qui abstraient des opérations courantes et font plus qu'un mappage individuel avec une opération d'API. Les commandes de transfert aws s3 cp, sync, mv et rm ont des paramètres supplémentaires que vous pouvez utiliser pour contrôler les transferts S3.

Toutes ces options peuvent être configurées en spécifiant le paramètre imbriqué s3 dans votre fichier config. Chaque paramètre est en retrait sur sa propre ligne.

Note

Ces paramètres sont entièrement facultatifs. Vous devriez pouvoir utiliser les commandes de transfert aws s3 sans configurer aucun de ces paramètres. Ces paramètres sont fournis pour vous permettre d'optimiser les performances ou pour prendre en compte l'environnement spécifique dans lequel vous exécutez ces commandes aws s3.

Ces paramètres sont tous définis sous une clé s3 de niveau supérieur dans le fichier config, comme illustré dans l'exemple suivant pour le profil development :

[profile development] s3 = max_concurrent_requests = 20 max_queue_size = 10000 multipart_threshold = 64MB multipart_chunksize = 16MB max_bandwidth = 50MB/s use_accelerate_endpoint = true addressing_style = path

Les paramètres suivants s'appliquent à n'importe quelle commande S3 dans les espaces de noms s3 et s3api.

addressing_style

Spécifie le type d'adressage à utiliser. Il vérifie si le nom du compartiment figure dans le nom d'hôte ou fait partie de l'URL. Les valeurs valides sont path, virtual et auto. La valeur par défaut est auto.

Il existe deux styles de création 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 la régionpath, vous traitez le nom du compartiment comme s'il s'agissait d'un chemin d'accès dans l'URI : par exemple,https://s3.amazonaws.com/bucketname. La valeur par défaut dans l'interface de ligne de commande consiste à utiliser auto, qui tente d'utiliser le style virtual chaque fois que possible, mais bascule, au besoin, sur le style path. Par exemple, si le nom de votre compartiment n'est pas compatible DNS, ce nom ne peut pas faire partie du nom d'hôte et doit être dans le chemin d'accès. Avec auto, l'interface de ligne de commande détecte cette condition et passe automatiquement au style path. Si vous définissez le type d'adressage sur path, vous devez ensuite vous assurer que la région AWS que vous avez configurée dans l'AWS CLI correspond à la région de votre compartiment.

payload_signing_enabled

Spécifie s'il convient de signer SHA256 les charges utiles sigv4. Par défaut, cette option est désactivée pour les chargements de streaming (UploadPart et PutObject) lors de l'utilisation de https. Par défaut, cette option est définie sur false pour les chargements de streaming (UploadPart et PutObject), mais uniquement si un ContentMD5 est présent (il est générée par défaut) et sir le point de terminaison utilise le protocole HTTPS.

Si la valeur est true, les requêtes S3 reçoivent du contenu de validation supplémentaire sous la forme d'un total de contrôle SHA256 qui est calculé automatiquement et inclus dans la signature de la requête. 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.

use_dualstack_endpoint

Utilisez le point de terminaison IPv4/IPv6 double Amazon S3 pour toutes les.s3ands3apicommandes. La valeur par défaut est false. Ce paramètre et use_accelerate_endpoint sont mutuellement exclusifs.

Si true est défini, la zoneAWS CLIdirige toutes les requêtes Amazon S3 vers le point de terminaison double IPv4/IPv6 de la région configurée.

use_accelerate_endpoint

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

Si true est défini, la zoneAWS CLIdirige toutes les demandes Amazon S3 vers leS3 Acceleratepoint de terminaison à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 d'adressage de compartiment : my-bucket.s3-accelerate.amazonaws.com. AnyListBuckets,CreateBucket, etDeleteBucket Les requêtes 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.

Les paramètres suivants ne s'appliquent qu'aux commandes de l'ensemble de commandes de l'espace de noms s3 :

max_bandwidth

Spécifie la bande passante maximale consommable pour le chargement et le téléchargement de données depuis et vers 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 depuis et vers 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 :

  • Un entier. Par exemple, 1048576 définit l'utilisation maximale de bande passante à 1 méga-octet par seconde.

  • Un entier suivi d'un taux suffixe de débit. Vous pouvez spécifier des suffixes de débit en utilisant : KB/s, MB/s, ou GB/s. Par exemple, 300KB/s, 10MB/s.

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.

max_concurrent_requests

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 charger des fichiers dans un compartiment S3, l'AWS CLI peut charger les fichiers localdir/file1, localdir/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 :

  • Réduire cette valeur : sur certains environnements, la valeur par défaut de 10 requêtes simultanées peut submerger un système. Cela peut entraîner des délais de connexion ou réduire la réactivité du système. La réduction de cette valeur rend les commandes de transfert S3 moins gourmandes en ressources. Le compromis est que les transferts S3 peuvent prendre plus de temps à s'exécuter. La réduction de cette valeur peut s'avérer nécessaire si vous utilisez un outil pour limiter la bande passante.

  • Augmenter cette valeur : dans certains scénarios, il se peut que vous souhaitiez que les transferts Amazon S3 se terminent le plus rapidement possible, en utilisant autant de bande passante réseau que nécessaire. Dans ce scénario, le nombre par défaut de requêtes simultanées peut ne pas être suffisant pour utiliser toute la bande passante réseau disponible. L'augmentation de cette valeur peut améliorer le temps nécessaire pour effectuer un transfert Amazon S3.

max_queue_size

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

LeAWS CLIinterne utilise un modèle par lequel elle place en file d'attente des tâches Amazon S3 qui sont ensuite exécutées par des consommateurs dont les nombres sont limités parmax_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 que l'AWS CLIest conscient de ce besoin d'être exécutés. Cela signifie que, par défaut, l'AWS CLIne peut voir que 1 000 tâches à venir. L'augmentation de cette valeur signifie que leAWS CLIpeut connaître plus rapidement le nombre total de tâches nécessaires, en supposant que la vitesse de mise en file d'attente soit supérieure à celle d'achèvement des tâches. Le compromis est qu'une max_queue_size plus importante nécessite plus de mémoire.

multipart_chunksize

Spécifie la taille de bloc que l'AWS CLI utilise 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 fichiers dépasse la valeurmultipart_threshold, leAWS CLIdivise le fichier en blocs 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.

multipart_threshold

Spécifie le seuil de taille que l'AWS CLI utilise 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 en opérations partitionnées si le fichier dépasse cette taille. Vous pouvez spécifier cette valeur de deux manières :

  • La taille de fichier en octets. Par exemple, .1048576

  • La taille de fichier avec un suffixe de taille. Vous pouvez utiliser KB, MB, GB ou TB. Par exemple : 10MB, 1GB.

    Note

    S3 peut imposer des contraintes sur les valeurs valides utilisables être utilisées pour les opérations partitionnées. Pour plus d'informations, consultez le .Documentation sur le chargement partitionné S3dans leManuel de l'utilisateur Amazon Simple Storage Service.