Cette documentation concerne AWS CLI uniquement la version 1. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.
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 dans l’ AWS CLI
Vous pouvez enregistrer vos paramètres de configuration utilisés fréquemment et vos informations d’identification dans des fichiers qui sont gérés par l’ AWS CLI.
Les fichiers sont divisés en profiles. Par défaut, AWS CLI utilise 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.
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, consultez Configuration des paramètres de l’AWS CLI.
Note
Pour plus d’informations sur la configuration des informations d’identification, consultez Authentification et informations d’identification d’accès pour l’ AWS CLI.
Rubriques
Format des fichiers de configuration et des informations d’identification
Les fichiers config et credentials sont organisés en sections. Les sections sont profiles et services. Une section est une collection nommée de paramètres qui continue jusqu’à ce qu’une autre ligne de définition de section soit rencontrée. Plusieurs profils et sections peuvent être enregistrés dans les fichiers config et credentials.
Ces fichiers sont des fichiers en texte brut au format suivant :
-
Les noms des sections sont placés entre crochets [ ], par exemple
[default],[profileetuser1][sso-session]. -
Toutes les entrées d’une section prennent la forme générale
setting_name=value. -
Les lignes peuvent être commentées en commençant par un caractère dièse (
#).
Type de section : profile
Selon le fichier, les noms de section de profil utilisent le format suivant :
-
Fichier de configuration :
[default][profileuser1] -
Fichier d’informations d’identification :
[default][user1]N’utilisez pas le mot
profilelors de la création d’une entrée dans le fichiercredentials.
Chaque profil peut spécifier des informations d’identification différentes et peut également spécifier des régions AWS et des formats de sortie différents. Lorsque vous nommez le profil dans un fichier config, incluez le préfixe « profile », mais ne l’incluez pas dans le fichier credentials.
Les exemples suivants montrent un fichier credentials et config avec deux profils, une région et une sortie spécifiés. La première valeur [default] est utilisée lors de l’exécution d’une commande AWS CLI
sans aucun profil spécifié. Le second est utilisé lorsque vous exécutez une AWS CLI commande avec le --profile user1 paramètre.
Pour plus d’informations et des détails sur les méthodes supplémentaires pour les autorisations les informations d’identification, consultez Authentification à l'aide des informations d'identification utilisateur IAM pour AWS CLI.
Type de section : services
La services section est un groupe de paramètres qui configure les points de terminaison personnalisés pour les Service AWS demandes. Un profil est ensuite lié à une section services.
[profiledev] services =my-services
La section services est divisée en sous-sections par des lignes <SERVICE> = , où <SERVICE> est la clé d’identifiant Service AWS . L' Service AWS identifiant est basé sur le modèle d'API serviceId en remplaçant tous les espaces par des traits de soulignement et en minuscules toutes les lettres. Pour obtenir la liste de toutes les clés d’identification de service à utiliser dans la section services, consultez Utilisation de points de terminaison dans l’AWS CLI. La clé d’identification du service est suivie de paramètres imbriqués, chacun sur sa propre ligne et indenté de deux espaces.
L'exemple suivant configure le point de terminaison à utiliser pour les demandes adressées au Amazon DynamoDB service dans la my-services section utilisée dans le dev profil. Toutes les lignes indentées qui suivent immédiatement sont incluses dans cette sous-section et s’appliquent à ce service.
[profiledev] services =my-services[servicesmy-services] dynamodb = endpoint_url =http://localhost:8000
Pour plus d’informations sur les points de terminaison spécifiques aux services, consultez Utilisation de points de terminaison dans l’AWS CLI.
Si votre profil comporte des informations d’identification basées sur un rôle configurées via un paramètre source_profile pour la fonctionnalité de rôle de responsable IAM, le kit SDK utilise uniquement les configurations de service pour le profil spécifié. Il n’utilise pas de profils auxquels des rôles sont liés. Par exemple, en utilisant le fichier config partagé suivant :
[profileA] credential_source =Ec2InstanceMetadataendpoint_url =https://profile-a-endpoint.aws/[profileB] source_profile =Arole_arn =arn:aws:iam::123456789012:role/roleBservices =profileB[servicesprofileB] ec2 = endpoint_url =https://profile-b-ec2-endpoint.aws
Si vous utilisez le profil B et que vous appelez Amazon dans votre code EC2, le point de terminaison est résolu commehttps://profile-b-ec2-endpoint.aws. Si votre code envoie une demande à un autre service, la résolution du point de terminaison ne suivra aucune logique personnalisée. Le point de terminaison n’est pas résolu en point de terminaison global défini dans le profil A. Pour qu’un point de terminaison global prenne effet pour le profil B, vous devez définir endpoint_url directement dans le profil B.
Où les paramètres de configuration sont-ils stockés ?
Le AWS CLI stocke les informations d'identification sensibles que vous spécifiez aws
configure dans un fichier local nommécredentials, dans un dossier nommé dans votre répertoire personnel. Les autres options de configuration que vous spécifiez avec .awsaws configure sont stockées dans un fichier local nommé config, également stocké dans le dossier du répertoire de base. .aws
Stockage des informations d’identification dans le fichier de configuration
Vous pouvez conserver tous les paramètres de votre profil dans un seul fichier, car les informations d'identification AWS CLI peuvent être lues dans le config fichier. 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é. Nous vous suggérons de conserver les informations d’identification dans les fichiers credentials. Ces fichiers sont également utilisés par les différents kits de développement de logiciels linguistiques (SDKs). Si vous utilisez l'un d'entre eux SDKs en plus du AWS CLI, vérifiez 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. Vous pouvez spécifier un emplacement autre que celui par défaut pour les fichiers en définissant les variables d’environnement AWS_CONFIG_FILE et AWS_SHARED_CREDENTIALS_FILE sur un autre chemin local. Consultez Configuration des variables d’environnement pour l’ AWS CLI pour plus de détails.
Lorsque vous utilisez un profil partagé qui spécifie un rôle AWS Identity and Access Management (IAM), l'opération AWS CLI appelle l' AWS STS AssumeRoleopération pour récupérer des informations d'identification temporaires. Ces informations d’identification sont ensuite stockées (dans ). Les AWS CLI commandes suivantes utilisent les informations d'identification temporaires mises en cache jusqu'à leur expiration, et à ce stade, les informations d'identification AWS CLI
sont automatiquement actualisées.~/.aws/cli/cache
Utilisation de profils nommés
Si aucun profil n’est défini explicitement, le profil default est utilisé.
Pour utiliser un profil nommé, ajoutez l’option --profile
à votre commande. L'exemple suivant répertorie toutes vos EC2 instances Amazon à l'aide des informations d'identification et des paramètres définis dans le profile-nameuser1 profil.
$aws ec2 describe-instances --profile user1
Pour utiliser un profil nommé pour plusieurs commandes, vous pouvez éviter de spécifier le profil dans chaque commande en définissant la variable d’environnement AWS_PROFILE comme profil par défaut. Vous pouvez remplacer ce paramètre à l’aide du paramètre --profile.
Définition et affichage des paramètres de configuration à l’aide de commandes
Il existe plusieurs façons d’afficher et de définir vos paramètres de configuration à l’aide de commandes.
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 configureAWS Access Key ID [None]:AWS Secret Access Key [None]:AKIAIOSFODNN7EXAMPLEDefault region name [None]:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEYDefault output format [None]:us-west-2json 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
regiondans le profil nomméinteg.$aws configure set regionus-west-2--profileintegPour supprimer un paramètre, supprimez-le manuellement de vos fichiers
configetcredentialsdans un éditeur de texte. 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
regiondans le profil nomméinteg.$aws configure getregion--profileintegus-west-2Un résultat vide indique que le paramètre n’est pas explicitement défini et utilise la valeur par défaut.
aws configure list-
Pour afficher la liste de toutes les données de configuration, utilisez la commande
aws configure list. 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, elle indique la valeur, l’emplacement où la valeur de configuration a été extraite 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’informations 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 listName 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
Exemples de commandes de paramétrage d’une configuration et d’informations d’identification
Les exemples suivants montrent comment configurer un profil par défaut avec des informations d’identification, une région et une sortie spécifiées pour différentes méthodes d’authentification.
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 prévalent, consultez Configuration des paramètres de l’AWS CLI
Paramètres globaux
-
account_id_endpoint_mode -
Spécifie s'il faut utiliser un point de terminaison AWS basé sur le compte IDs pour les appels vers le support. Services AWS Pour plus d’informations sur les points de terminaison basés sur un compte, consultez Points de terminaison basés sur un compte.
Ce paramètre peut être défini sur les valeurs suivantes :
-
(par défaut)
preferred: le point de terminaison doit inclure l’ID de compte s’il est disponible. -
disabled: un point de terminaison résolu n’inclut pas d’ID de compte. -
required: le point de terminaison doit inclure un ID de compte. Si l’ID de compte n’est pas disponible, le kit SDK génère une erreur.
Peut être remplacée par la variable d’environnement
AWS_ACCOUNT_ID_ENDPOINT_MODE. Pour utiliser des points de terminaison basés sur un compte, l’ID doit être défini dans la variable d’environnementAWS_ACCOUNT_IDou le paramètreaws_account_id.account_id_endpoint_mode =preferredPriorité des points de terminaison
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. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.
-
-
api_versions -
Certains AWS services gèrent plusieurs versions d'API afin de garantir la rétrocompatibilité. Par défaut, AWS CLI les commandes utilisent la dernière version d'API disponible. Vous pouvez spécifier une version de l’API à utiliser pour un profil en incluant le paramètre
api_versionsdans le fichierconfig.Il s'agit d'un paramètre « imbriqué » suivi d'une ou de plusieurs lignes en retrait identifiant chacune un AWS service et la version d'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-017Ce paramètre n’a pas de variable d’environnement ni de paramètre de ligne de commande équivalent.
-
aws_access_key_id -
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 fichiercredentials.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_account_id -
Spécifie l'ID du point de terminaison AWS basé sur le compte à utiliser pour les appels vers le service pris en charge. Services AWS Pour plus d’informations sur les points de terminaison basés sur un compte, consultez Points de terminaison basés sur un compte.
Peut être remplacée par la variable d’environnement
AWS_ACCOUNT_ID. La variable d’environnementAWS_ACCOUNT_ID_ENDPOINT_MODEou le paramètreaccount_id_endpoint_modedoit être défini(e) surpreferredourequiredpour l’utilisation de ce paramètre.aws_account_id =123456789EXAMPLEPriorité des points de terminaison
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. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.
aws_secret_access_key-
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 fichiercredentials.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 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 fichiercredentials.Peut être remplacée par la variable d’environnement
AWS_SESSION_TOKEN. Vous ne pouvez pas spécifier 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ée par la variable d’environnement
AWS_CA_BUNDLEou l’option de ligne de commande--ca-bundle.ca_bundle =dev/apps/ca-certs/cabundle-2019mar05.pem cli_follow_urlparam-
Spécifie si les AWS CLI tentatives de suivi des liens URL 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 à la place de l’URL.-
true : 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://ouhttps://sont récupérés et le contenu téléchargé est utilisé comme valeur de paramètre pour la commande. -
false — Si elle est spécifiée, les valeurs des chaînes de paramètres commençant par
http://ouhttps://différemment des autres chaînes AWS CLI ne sont pas traitées.
Cette entrée n’a pas de variable d’environnement ni d’option de ligne de commande équivalente.
cli_follow_urlparam = false -
cli_history-
Ce paramètre est désactivé par défaut. Ce paramètre active l’historique des commandes pour l’ AWS CLI. Après avoir activé ce paramètre, AWS CLI enregistre l'historique des
awscommandes.cli_history = enabledVous pouvez répertorier votre historique à l’aide de la commande
aws history listet utiliser la valeurcommand_idsobtenue dans la commandeaws history showpour plus de détails. Pour plus d’informations, consultezaws historydans le guide de référence de l’AWS CLI . cli_timestamp_format-
Spécifie le format de sortie des valeurs d’horodatage. Vous pouvez spécifier chacune des valeurs suivantes :
-
iso8601 — La valeur par défaut pour la AWS CLI version 2. Si cela est spécifié, le AWS CLI reformatage de tous les horodatages de la sortie conformément à la norme ISO 8601.
Les horodatages au format ISO 8601 ressemblent aux exemples suivants. L’exemple suivant montre comment l’heure est formatée en séparant la date et l’heure par un Tet en incluant unZaprès l’heure.YYYY-MM-DDThh:mm:ssZLes exemples suivants montrent un horodatage utilisant le formatage précédent.
2024-05-08T15:16:43Z -
wire — La valeur par défaut pour la AWS CLI version 1. Si cela est spécifié, AWS CLI affiche toutes les valeurs d'horodatage exactement telles qu'elles ont été reçues dans la réponse à la requête HTTP.
Ce paramètre n’a pas de variable d’environnement ni d’option de ligne de commande équivalente. Ce paramètre ne modifie pas les entrées d’horodatage, uniquement le formatage des sorties.
cli_timestamp_format = iso8601 -
credential_process-
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 Utilisation d’informations d’identification provenant d’un processus externe dans l’AWS CLI.
Cette entrée n’a pas de variable d’environnement ni d’option de ligne de commande équivalente.
credential_process =/opt/bin/awscreds-retriever --username susan credential_source-
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_arnparamètre. Vous ne pouvez pas spécifier à la foissource_profileetcredential_sourcedans le même profil.Ce paramètre peut avoir l’une des trois valeurs suivantes :
-
Environnement — Spécifie qu'il s' AWS CLI agit de récupérer les informations d'identification de la source à partir des variables d'environnement.
-
Ec2 InstanceMetadata — Spécifie qu' AWS CLI il faut utiliser le rôle IAM attaché au profil d'EC2 instance pour obtenir les informations d'identification de la source.
-
EcsContainer— Spécifie qu' AWS CLI il faut 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.
endpoint_url-
Spécifie le point de terminaison qui est utilisé pour toutes les demandes de service. Si ce paramètre est utilisé dans la section services du fichier
config, le point de terminaison est utilisé uniquement pour le service spécifié. Pour de plus amples informations, veuillez consulter Définition d’un point de terminaison global pour tous les Services AWS.L’exemple suivant utilise le point de terminaison global
http://localhost:1234et un point de terminaison spécifique au servicehttp://localhost:4567pour Amazon S3.[profile dev] endpoint_url = http://localhost:1234 services = s3-specific [services s3-specific] s3 = endpoint_url = http://localhost:4567Priorité des points de terminaison
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. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.
ignore_configure_endpoint_urls-
Si cette option est activée, elle AWS CLI ignore toutes les configurations de point de terminaison personnalisées spécifiées dans le
configfichier. Les valeurs valides sonttrueetfalse.ignore_configure_endpoint_urls = truePriorité des points de terminaison
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. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.
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
ExternalIddans l’opérationAssumeRole. Ce paramètre n’est nécessaire que si la politique d’approbation du rôle spécifie une valeur pourExternalId. Pour plus d'informations, consultez la section Comment utiliser un identifiant externe pour accorder l'accès à vos AWS ressources à un tiers dans le guide de l'utilisateur IAM. max_attempts-
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_attemptsvaleur que vous fournissez.Vous pouvez remplacer cette valeur à l’aide de la variable d’environnement
AWS_MAX_ATTEMPTS.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 politique 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 quearn: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 :
-
text : la sortie a le format de 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, comme
grep,sedouawk. -
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ée par la variable d’environnement
AWS_DEFAULT_OUTPUTou l’option de ligne de commande--output.output =table parameter_validation-
Spécifie si le AWS CLI client tente de valider les paramètres avant de les envoyer au point de terminaison du AWS service.
-
true : il s’agit de la valeur par défaut. Si cela est spécifié, il AWS CLI effectue une validation locale des paramètres de ligne de commande.
-
false — Si cela est spécifié, les paramètres de ligne de commande AWS CLI ne sont pas validés avant de les envoyer au point de terminaison du AWS service.
Cette entrée n’a pas de variable d’environnement ni d’option de ligne de commande équivalente.
parameter_validation = false -
region-
Spécifie Région AWS à qui 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 dans AWS Régions et point de terminaison dans le Référence générale d'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 mondial 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 de la variable d’environnement
AWS_DEFAULT_REGIONou de l’option de ligne de commande--region.region =us-west-2 -
request_checksum_calculation-
Indique le moment où une somme de contrôle est calculée pour les données utiles des demandes et propose les options suivantes :
-
when_supported: (par défaut) la somme de contrôle des données utiles des demandes est calculée lorsqu’une opération indique un algorithme de somme de contrôle dans son modèle de service ou nécessite des sommes de contrôle des demandes. -
when_required: la somme de contrôle des données utiles des demandes est calculée lorsqu’une opération nécessite des sommes de contrôle des demandes ou lorsqu’un utilisateur fournit unrequestAlgorithmMemberqui est modélisé par le Service AWS.
request_checksum_calculation =when_supportedLa variable d’environnement AWS_REQUEST_CHECKSUM_CALCULATION remplace ce paramètre.
-
response_checksum_validation-
Indique le moment où une somme de contrôle est validée pour les données utiles des réponses et propose les options suivantes :
-
when_supported— (Par défaut) La validation de la somme de contrôle de la charge utile de réponse est effectuée lorsqu'une opération spécifie un algorithme de réponse dans son modèle de service qu'elle prend en charge. AWS CLI -
when_required— La validation de la somme de contrôle de la charge utile de réponse est effectuée lorsqu'une opération spécifie un algorithme de réponse dans son modèle de service qu'elle prend en AWS CLI charge, et que vous définissez le modèle sur lequel il est modéliséENABLEDdans l'requestValidationModeMemberentrée de l'opération.
response_checksum_validation =when_supportedLa variable d’environnement AWS_RESPONSE_CHECKSUM_VALIDATION remplace ce paramètre.
-
retry_mode-
Spécifie le mode de nouvelle tentative AWS CLI utilisé. Trois modes de nouvelle tentative sont disponibles :
standard,legacy(par défaut) etadaptive. Pour plus d’informations sur les nouvelles tentatives, consultez Nouvelles tentatives de l’AWS CLI dans l’AWS CLI.Vous pouvez remplacer cette valeur à l’aide de la variable d’environnement
AWS_RETRY_MODE.retry_mode =standard role_arn-
Spécifie le nom de ressource Amazon (ARN) d'un rôle IAM 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 :
-
source_profile
-
credential_source
role_arn = arn:aws:iam::123456789012:role/role-nameLa variable d’environnement AWS_ROLE_ARN remplace ce paramètre.
Pour plus d’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 au paramètre
RoleSessionNamelorsque l’ AWS CLI appelle l’opérationAssumeRoleet fait partie de l’ARN utilisateur du rôle assumé :arn:aws:sts::. 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.123456789012:assumed-role/role_name/role_session_namerole_session_name =maria_garcia_roleLa variable d’environnement AWS_ROLE_SESSION_NAME remplace ce paramètre.
Pour plus d’informations sur l’utilisation des identités web, consultez Utilisation d’un rôle à l’aide d’une identité web.
services-
Spécifie la configuration du service à utiliser pour votre profil.
[profiledev-s3-specific-and-global] endpoint_url =http://localhost:1234services =s3-specific[servicess3-specific] s3 = endpoint_url =http://localhost:4567Pour plus d’informations sur la section
services, consultez Type de section : services.La variable d’environnement AWS_ROLE_SESSION_NAME remplace ce paramètre.
Pour plus d’informations sur l’utilisation des identités web, consultez Utilisation d’un rôle à l’aide d’une identité web.
sdk_ua_app_id-
Un seul Compte AWS peut être utilisé par plusieurs applications clients pour passer des appels à Services AWS. L'ID d'application identifie l'application source qui a effectué un ensemble d'appels à l'aide d'un Service AWS. AWS SDKs et 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 les applications qui sont associées à 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 =prod1Ce 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.
sigv4a_signing_region_set-
Spécifie les régions à utiliser lors de la signature avec SigV4a à l’aide d’une liste séparée par des virgules. Si cette variable n'est pas définie, elle AWS CLI utilise la valeur par défaut utilisée par le Service AWS. S'il n'y Service AWS a pas de valeur par défaut, la signature de la demande devient valide dans toutes les régions en utilisant une valeur de
*.sigv4a_signing_region_set =us-west-2, us-east-1Pour plus d’informations sur SigV4a, consultez AWS Signature Version 4 pour les requêtes d’API dans le Guide de l’utilisateur IAM.
Ce paramètre peut être remplacé à l’aide de la variable d’environnement AWS_SIGV4A_SIGNING_REGION_SET. Vous ne pouvez pas définir cette valeur en tant que paramètre de ligne de commande.
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 foissource_profileetcredential_sourcedans le même profil.source_profile =production-profile sts_regional_endpoints-
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 est
legacy.Vous pouvez spécifier l’une des deux valeurs suivantes :
-
legacy— Utilise le point de terminaison STS globalsts.amazonaws.com.rproxy.govskope.caap-northeast-1ap-south-1, pour AWS les régions suivantes :ap-southeast-1ap-southeast-2aws-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— Utilise AWS CLI toujours le AWS STS point de terminaison pour la région actuellement configurée. Par exemple, si le client est configuré pour être utiliséus-west-2, tous les appels AWS STS sont effectués vers le point de terminaison régionalsts---us-west-2.amazonaws.com.rproxy.govskope.caplutôt que vers le point dests.amazonaws.com.rproxy.govskope.caterminaison global. Pour envoyer une demande au point de terminaison global lorsque ce paramètre est activé, vous pouvez définir la région suraws-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. -
use_dualstack_endpoint-
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. Les 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. Les paramètres valides sont
trueetfalse. Par défaut, l’option est désactivée. Pour de plus amples informations, veuillez consulter Éléments à définir pour permettre l’utilisation de points de terminaison à double pile pour tous les Services AWS.Ce paramètre et
use_accelerate_endpointsont mutuellement exclusifs.Priorité des points de terminaison
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. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.
use_fips_endpoint-
Certains AWS services proposent des terminaux 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 prend en charge le protocole FIPS, ce paramètre indique le point de terminaison FIPS à utiliser AWS CLI . Contrairement aux points de AWS terminaison standard, les points de terminaison FIPS utilisent une bibliothèque logicielle TLS conforme à la norme FIPS 140-2. Ces points de terminaison peuvent être requis par les entreprises qui interagissent avec le gouvernement des États-Unis. Pour plus d'informations, voir,Éléments à définir afin de permettre l’utilisation de points de terminaison FIPS pour tous les Services AWS. Si ce paramètre est activé, mais qu'il n'existe pas de point de terminaison FIPS pour le service dans votre ordinateur Région AWS, la AWS commande risque d'échouer. Dans ce cas, indiquez manuellement le point de terminaison à utiliser dans la commande à l’aide de l’option
--endpoint-urlou utilisez des points de terminaison spécifiques aux services.Priorité des points de terminaison
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. AWS CLI vérifie ces paramètres de point de terminaison dans un ordre particulier et utilise le paramètre de point de terminaison ayant la priorité la plus élevée. Pour la liste des priorités des points de terminaison, consultez Configuration du point de terminaison et priorité des paramètres.
web_identity_token_file-
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érationAssumeRoleWithWebIdentity.La variable d’environnement
AWS_WEB_IDENTITY_TOKEN_FILEremplace ce paramètre.Pour plus d’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 AWS CLI client utilise des paquets TCP Keep-Alive.
Cette entrée n’a pas de variable d’environnement ni d’option de ligne de commande équivalente.
tcp_keepalive = false
Paramètres de commandes personnalisées S3
Amazon S3 prend en charge plusieurs paramètres qui configurent la manière dont AWS CLI les opérations Amazon S3 sont effectuées. Certains s’appliquent à toutes les commandes S3 dans les deux espaces de noms s3api et s3. D'autres sont spécifiquement destinées aux commandes « personnalisées » S3 qui font abstraction des opérations courantes et font plus qu'un one-to-one mappage vers 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,virtualetauto. La valeur par défaut estauto.Il existe deux styles de création d’un point de terminaison Amazon S3. Le premier est appelé
virtualet inclut le nom du compartiment dans le nom d’hôte. Par exemple :https://. Sinon, avec le stylebucketname.s3.amazonaws.com.rproxy.govskope.capath, 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/. La valeur par défaut dans l’interface de ligne de commande consiste à utiliserbucketnameauto, qui tente d’utiliser le stylevirtualchaque fois que possible, mais bascule, au besoin, sur le stylepath. 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. Avecauto, l’interface de ligne de commande détecte cette condition et passe automatiquement au stylepath. 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. payload_signing_enabled-
Spécifie s'il faut SHA256 signer les charges utiles sigv4. Par défaut, cette option est désactivée pour les chargements de streaming (
UploadPartetPutObject) lors de l’utilisation de https. Par défaut, cette option est définie surfalsepour les chargements de streaming (UploadPartetPutObject), mais uniquement si unContentMD5est présent (il est générée par défaut) et sir le point de terminaison utilise le protocole HTTPS.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, la somme de contrôle n’est pas calculée. La désactivation peut s’avérer utile pour réduire la surcharge en termes de performances générée par le calcul de la somme de contrôle.
use_accelerate_endpoint-
Utilisez le point de terminaison Amazon S3 Accelerate pour toutes les commandes
s3ets3api. La valeur par défaut est false. Ce paramètre etuse_dualstack_endpointsont mutuellement exclusifs.S'il est défini sur true, toutes les AWS CLI demandes Amazon S3 sont dirigées vers le
S3 Acceleratepoint de terminaison situé às3-accelerate.amazonaws.com. Pour utiliser ce point de terminaison, vous devez activer votre compartiment pour utiliserS3 Accelerate. Toutes les requêtes sont envoyées en utilisant le style virtuel de l’adressage de compartiment :. Les requêtesmy-bucket.s3-accelerate.amazonaws.com.rproxy.govskope.caListBuckets,CreateBucketetDeleteBucketne 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 si le paramètre--endpoint-urlest défini surhttps://s3-accelerate.amazonaws.com.rproxy.govskope.caouhttp://s3-accelerate.amazonaws.compour toute commandes3apious3. use_dualstack_endpoint-
Permet d’utiliser des points de terminaison à double pile pour l’envoi des demandes
s3ets3api. 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. Les 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. Les paramètres valides sonttrueetfalse. Par défaut, l’option est désactivée. Pour de plus amples informations, veuillez consulter Éléments à définir pour permettre l’utilisation de points de terminaison à double pile pour tous les Services AWS.Ce paramètre et
use_accelerate_endpointsont mutuellement exclusifs.
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 est 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 ni aux suppressions. La valeur est exprimée en octets par seconde. La valeur peut être spécifiée comme suit :
-
Un entier. Par exemple,
1048576définit l’utilisation maximale de bande passante à 1 méga-octet par seconde. -
Un entier suivi d’un suffixe de débit. Vous pouvez spécifier des suffixes de débit en utilisant :
KB/s,MB/s, ouGB/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ètremax_bandwidthpour limiter davantage la consommation de bande passante. Il en est ainsi parce quemax_concurrent_requestscontrôle le nombre de threads en cours d’exécution. Si à la place vous baissez d’abordmax_bandwidth, mais conservez une valeurmax_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.
Les commandes de transfert
aws s3sont multithread. À tout moment, plusieurs requêtes Amazon S3 peuvent être en cours d’exécution. Par exemple, lorsque vous utilisez la commandeaws s3 cp localdir s3://bucket/ --recursivepour télécharger des fichiers dans un compartiment S3, ils AWS CLI peuvent télécharger les fichierslocaldir/file1localdir/file2, etlocaldir/file3en parallèle. Le paramètremax_concurrent_requestsspé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 : dans 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 du 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 du 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 1 000.
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_requestsUne tâche correspond généralement à une seule opération Amazon S3. Par exemple, une tâche pourrait êtrePutObjectTask,GetObjectTaskouUploadPartTask. 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 valeur max_queue_size plus importante nécessite plus de mémoire.
multipart_chunksize-
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 la valeur
multipart_threshold, l’ AWS CLI divise le fichier en blocs de cette taille. Cette valeur peut être spécifiée en utilisant la même syntaxe quemultipart_threshold, comme le 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 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 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,GBouTB. Par exemple10MB,1GB.Note
S3 peut imposer des contraintes sur les valeurs valides utilisables pour les opérations partitionnées. Pour plus d’informations, consultez la documentation relative au chargement partitionné S3 dans le Guide de l’utilisateur Amazon Simple Storage Service.
-