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'identification dans le AWS CLI
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, 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, veuillez consulter Configuration des paramètres pour le AWS CLI.
Note
Pour plus d'informations sur la configuration de vos informations d'identification, consultezAuthentification et informations d'accès pour AWS CLI.
Rubriques
- Format des fichiers de configuration et d'identification
- Où les paramètres de configuration sont-ils stockés ?
- Utilisation de profils nommés
- Définir et afficher les paramètres de configuration à l'aide de commandes
- Exemples de commandes de définition d'une nouvelle configuration et d'informations d'identification
- Paramètres de fichier config pris en charge
Format des fichiers de configuration et d'identification
Les credentials
fichiers config
et sont organisés en sections. Les sections incluent les profils. Une section est un ensemble nommé 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 credentials
fichiers config
et.
Ces fichiers sont des fichiers en texte brut qui utilisent le format suivant :
-
Les noms des sections sont placés entre crochets [] tels que
[default]
[profile
, etuser1
][sso-session]
. -
Toutes les entrées d'une section prennent la forme générale de
setting_name=value
. -
Les lignes peuvent être commentées en commençant par un caractère dièse (
#
).
Type de section : profile
Les AWS CLI boutiques
Selon le fichier, les noms des sections de profil utilisent le format suivant :
-
Fichier de configuration :
[default]
[profile
user1
] -
Fichier d'informations d'identification :
[default]
[
user1
]N’utilisez pas le mot
profile
lors 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 AWS régions et des formats de sortie différents. Lorsque vous nommez le profil dans un config
fichier, incluez le préfixe profile
« », mais ne l'incluez pas dans le credentials
fichier.
Les exemples suivants montrent un config
fichier credentials
et avec deux profils, une région et une sortie spécifiés. Le premier [par défaut] est utilisé lorsque vous exécutez une AWS CLI
commande sans qu'aucun profil ne soit 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 méthodes d'autorisation et d'identification supplémentaires, voirAuthentification à l'aide des informations IAM d'identification utilisateur 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 services
section.
[profile
dev
] services =my-services
La services
section est séparée en sous-sections par des <SERVICE> =
lignes, où se <SERVICE>
trouve la clé d' Service AWS identification. L' Service AWS identifiant est basé sur celui du API modèle 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 services
cette section, consultezUtilisation de points de terminaison dans AWS CLI. La clé d'identification du service est suivie de paramètres imbriqués, chacun sur sa propre ligne et indentés de deux espaces.
L'exemple suivant configure le point de terminaison à utiliser pour les demandes adressées au Amazon DynamoDB service dans le my-services
section utilisée dans dev
profil. Toutes les lignes indentées qui suivent immédiatement sont incluses dans cette sous-section et s'appliquent à ce service.
[profile
dev
] services =my-services
[servicesmy-services
] dynamodb = endpoint_url =http://localhost:8000
Pour plus d'informations sur les points de terminaison spécifiques à un service, consultez. Utilisation de points de terminaison dans AWS CLI
Si votre profil possède des informations d'identification basées sur les rôles configurées via un source_profile
paramètre pour la fonctionnalité d'IAMassumer un rôle, il utilise SDK 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 config
fichier partagé suivant :
[profile
A
] credential_source =Ec2InstanceMetadata
endpoint_url =https://profile-a-endpoint.aws/
[profileB
] source_profile =A
role_arn =arn:aws:iam::123456789012:role/roleB
services =profileB
[servicesprofileB
] ec2 = endpoint_url =https://profile-b-ec2-endpoint.aws
Si vous utilisez le profil B
et que vous appelez Amazon dans votre codeEC2, 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 ne correspond pas au point de terminaison global défini dans le profilA
. Pour qu'un point de terminaison global prenne effet pour B
le profil, vous devez le définir endpoint_url
directement dans le profilB
.
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 .aws
aws 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 credentials
fichiers. 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'AWS_SHARED_CREDENTIALS_FILE
environnement AWS_CONFIG_FILE
et sur un autre chemin local. Consultez Configuration des variables d'environnement pour 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 AssumeRole
opé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 default
profil 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-name
user1
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'AWS_PROFILE
environnement comme profil par défaut. Vous pouvez annuler ce paramètre en utilisant le --profile
paramètre.
Définir et afficher les paramètres de configuration à l'aide de commandes
Il existe plusieurs manières 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 configure
AWS Access Key ID [None]:
AWS Secret Access Key [None]:AKIAIOSFODNN7EXAMPLE
Default region name [None]:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default output format [None]:us-west-2
json
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
--profileinteg
Pour supprimer un paramètre, supprimez-le manuellement dans vos
credentials
fichiersconfig
et dans 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
region
dans le profil nomméinteg
.$
aws configure get
region
--profileinteg
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 list
-
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
Exemples de commandes de définition d'une nouvelle 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 sont prédéfinis, veuillez consulter Configuration des paramètres pour le AWS CLI
Global Settings (Paramètres globaux)
api_versions
-
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 leconfig
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.
-
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_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 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 certificats CA (un fichier avec l'
.pem
extension) 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
cli_follow_urlparam
-
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.-
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 d'équivalent variable d'environnement ou option de ligne de commande.
cli_follow_urlparam = false
-
cli_history
-
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 laaws history show
commande quicommand_ids
en résulte pour plus de détails. Pour plus d'informations, consultezaws history
le guide AWS CLI de référence. cli_timestamp_format
-
Spécifie le format des valeurs d'horodatage incluses dans la sortie. 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é, tous les horodatages sont AWS CLI reformatés conformément à la norme 8601. ISO
ISOLes horodatages au format 8601 ressemblent aux exemples suivants. Le premier exemple montre l'heure en temps universel coordonné (UTC)
en incluant un Z
après l'heure. La date et l'heure sont séparées par unT
.2019-10-31T22:21:41Z
Pour spécifier un autre fuseau horaire, au lieu du
Z
, spécifiez un+
ou-
et le nombre d'heures avant ou après le fuseau horaire souhaitéUTC, sous la forme d'une valeur à deux chiffres. L'exemple suivant montre la même heure que l'exemple précédent, mais ajustée à l'heure normale du Pacifique, soit huit heures de retardUTC.2019-10-31T14:21:41-08
-
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 HTTP requête.
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 à 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 Obtenir des informations d'identification par le biais d'un processus externe dans le AWS CLI.
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 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 foissource_profile
etcredential_source
dans 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 IAM rôle attaché au profil d'EC2instance pour obtenir les informations d'identification de la source.
-
EcsContainer— Spécifie qu' AWS CLI il faut utiliser le IAM rôle attaché au ECS conteneur 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 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 servicehttp://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 :
-
L'option
--endpoint-url
de ligne de commande. -
Si cette option est activée, la variable d'environnement
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS
global du point de terminaison ou le paramètreignore_configure_endpoint_urls
de profil ignore les points de terminaison personnalisés. -
La valeur fournie par une variable d'environnement spécifique au service
AWS_ENDPOINT_URL_<SERVICE>
, telle que.AWS_ENDPOINT_URL_DYNAMODB
-
Les valeurs fournies par les variables d'
AWS_ENDPOINT_URL
environnementAWS_USE_DUALSTACK_ENDPOINT
AWS_USE_FIPS_ENDPOINT
, et. -
La valeur du point de terminaison spécifique au service fournie par le
endpoint_url
paramètre dans uneservices
section du fichier partagéconfig
. -
La valeur fournie par le
endpoint_url
paramètre dans unprofile
config
fichier partagé. -
use_dualstack_endpoint
use_fips_endpoint
, etendpoint_url
paramètres. -
Tout point de terminaison par défaut URL pour le point correspondant Service AWS est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.
-
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
config
fichier. Les valeurs valides sonttrue
etfalse
.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 :
-
L'option
--endpoint-url
de ligne de commande. -
Si cette option est activée, la variable d'environnement
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS
global du point de terminaison ou le paramètreignore_configure_endpoint_urls
de profil ignore les points de terminaison personnalisés. -
La valeur fournie par une variable d'environnement spécifique au service
AWS_ENDPOINT_URL_<SERVICE>
, telle que.AWS_ENDPOINT_URL_DYNAMODB
-
Les valeurs fournies par les variables d'
AWS_ENDPOINT_URL
environnementAWS_USE_DUALSTACK_ENDPOINT
AWS_USE_FIPS_ENDPOINT
, et. -
La valeur du point de terminaison spécifique au service fournie par le
endpoint_url
paramètre dans uneservices
section du fichier partagéconfig
. -
La valeur fournie par le
endpoint_url
paramètre dans unprofile
config
fichier partagé. -
use_dualstack_endpoint
use_fips_endpoint
, etendpoint_url
paramètres. -
Tout point de terminaison par défaut URL pour le point correspondant Service AWS est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.
-
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érationAssumeRole
. Ce paramètre n'est nécessaire que si la stratégie d'approbation du rôle spécifie une valeur pourExternalId
. 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. 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_attempts
valeur que vous fournissez.Vous pouvez remplacer cette valeur en utilisant la variable d'
AWS_MAX_ATTEMPTS
environnement.max_attempts =
3
mfa_serial
-
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 que
GAHT12345678
) ou le nom de ressource Amazon (ARN) pour un MFA appareil 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 est formatée sous la forme de plusieurs lignes de valeurs de chaîne séparées par des tabulations. Cela peut être utile pour transmettre le résultat à un processeur de texte, comme
grep
sed
, ouawk
. -
table— La sortie est formatée sous forme de tableau en utilisant les caractères +|- pour former 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 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 d'équivalent variable d'environnement ou option de ligne de commande.
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 n'importe quel code de région disponible pour le service choisi, comme indiqué dans la section AWS Régions et points de terminaison du Référence générale d'Amazon Web Services.
-
aws_global
vous 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 en utilisant la variable d' d'
AWS_DEFAULT_REGION
environnement ou l'option de ligne de--region
commande.region =
us-west-2
-
retry_mode
-
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 dans le AWS CLI.
Vous pouvez remplacer cette valeur en utilisant la variable d'
AWS_RETRY_MODE
environnement.retry_mode =
standard
role_arn
-
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 :
-
source_profile
-
credential_source
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.
-
role_session_name
-
Spécifie le nom à attacher à la session de rôle. Cette valeur est fournie au
RoleSessionName
paramètre lorsqu'il AWS CLI appelle l'AssumeRole
opération, et fait partie du rôle assumé user ARN :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_name
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.
services
-
Spécifie la configuration du service à utiliser pour votre profil.
[profile
dev-s3-specific-and-global
] endpoint_url =http://localhost:1234
services =s3-specific
[servicess3-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.
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 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.
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_profile
etcredential_source
dans 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 STS terminaison globalsts.amazonaws.com
ap-northeast-1
, pour AWS les régions suivantes :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
— 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
plutôt que vers le point dests.amazonaws.com
terminaison 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. 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 :
-
L'option
--endpoint-url
de ligne de commande. -
Si cette option est activée, la variable d'environnement
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS
global du point de terminaison ou le paramètreignore_configure_endpoint_urls
de profil ignore les points de terminaison personnalisés. -
La valeur fournie par une variable d'environnement spécifique au service
AWS_ENDPOINT_URL_<SERVICE>
, telle que.AWS_ENDPOINT_URL_DYNAMODB
-
Les valeurs fournies par les variables d'
AWS_ENDPOINT_URL
environnementAWS_USE_DUALSTACK_ENDPOINT
AWS_USE_FIPS_ENDPOINT
, et. -
La valeur du point de terminaison spécifique au service fournie par le
endpoint_url
paramètre dans uneservices
section du fichier partagéconfig
. -
La valeur fournie par le
endpoint_url
paramètre dans unprofile
config
fichier partagé. -
use_dualstack_endpoint
use_fips_endpoint
, etendpoint_url
paramètres. -
Tout point de terminaison par défaut URL pour le point correspondant Service AWS est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.
-
use_fips_endpoint
-
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-url
option 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 :
-
L'option
--endpoint-url
de ligne de commande. -
Si cette option est activée, la variable d'environnement
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS
global du point de terminaison ou le paramètreignore_configure_endpoint_urls
de profil ignore les points de terminaison personnalisés. -
La valeur fournie par une variable d'environnement spécifique au service
AWS_ENDPOINT_URL_<SERVICE>
, telle que.AWS_ENDPOINT_URL_DYNAMODB
-
Les valeurs fournies par les variables d'
AWS_ENDPOINT_URL
environnementAWS_USE_DUALSTACK_ENDPOINT
AWS_USE_FIPS_ENDPOINT
, et. -
La valeur du point de terminaison spécifique au service fournie par le
endpoint_url
paramètre dans uneservices
section du fichier partagéconfig
. -
La valeur fournie par le
endpoint_url
paramètre dans unprofile
config
fichier partagé. -
use_dualstack_endpoint
use_fips_endpoint
, etendpoint_url
paramètres. -
Tout point de terminaison par défaut URL pour le point correspondant Service AWS est utilisé en dernier. Pour afficher la liste des points de terminaison de service disponibles dans chaque région, consultez Régions et points de terminaison AWS dans le document Référence générale d'Amazon Web Services.
-
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_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.
tcp_keepalive
-
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
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 s3
et s3api
. 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 API opération. 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. 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
etauto
. La valeur par défaut estauto
.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. olpPar exemple :https://
. Sinon, avec lebucketname
.s3.amazonaws.com.rproxy.goskope.compath
style, vous traitez le nom du compartiment comme s'il s'agissait d'un chemin dans le URI ; par exemple,https://s3.amazonaws.com/
. La valeur par défaut de CLI est to usebucketname
auto
, qui essaie d'utiliser levirtual
style là où elle le peut, mais revient aupath
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 aupath
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. 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 téléchargements en streaming (
UploadPart
etPutObject
) lors de l'utilisationHTTPS. Par défaut, ce paramètre est défini surfalse
pour les téléchargements en streaming (UploadPart
etPutObject
), mais uniquement si unContentMD5
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.
use_accelerate_endpoint
-
Utilisez le point de terminaison Amazon S3 Accelerate pour toutes les
s3api
commandess3
et. La valeur par défaut est false. Ce paramètre etuse_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 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.goskope.comListBuckets
,CreateBucket
etDeleteBucket
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 surhttps://s3-accelerate.amazonaws.com
ouhttp://s3-accelerate.amazonaws.com
pour toute commandes3api
ous3
.
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 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 :
-
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
, 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_bandwidth
pour limiter davantage la consommation de bande passante. Il en est ainsi parce quemax_concurrent_requests
contrô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.
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 commandeaws s3 cp localdir s3://bucket/ --recursive
pour télécharger des fichiers dans un compartiment S3, ils AWS CLI peuvent télécharger les fichierslocaldir/file1
localdir/file2
, etlocaldir/file3
en parallèle. Le paramètremax_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 :
-
Diminution de cette valeur — Dans certains environnements, la valeur par défaut de 10 demandes simultanées peut submerger le 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, vous souhaiterez peut-être que les transferts Amazon S3 soient effectués 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.
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 unePutObjectTask
,GetObjectTask
ouUploadPartTask
. 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.
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 le
multipart_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 quemultipart_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 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 :
-
La taille de fichier en octets. Par exemple,
1048576
. -
La taille de fichier avec un suffixe de taille. Vous pouvez utiliser
KB
,MB
,GB
ouTB
. 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 la documentation relative au chargement partitionné S3 dans le guide de l'utilisateur d'Amazon Simple Storage Service.
-