Paramètres des fichiers de configuration et d’informations d’identification dans l’ AWS CLI

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

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

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

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

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

Pour supprimer un paramètre, supprimez-le manuellement de vos fichiers config et credentials dans un éditeur de texte.

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

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

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

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

Importez les informations d’identification CSV générées à partir de la console web IAM. Cela ne concerne pas les informations d’identification générées par IAM Identity Center ; les clients qui utilisent IAM Identity Center doivent utiliser aws configure sso. Un fichier CSV est importé avec le nom de profil correspondant au nom d’utilisateur. Le fichier CSV doit comporter les en-têtes suivants.

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

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 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

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

$ aws configure list-profiles
default
test

Exécutez cette commande pour configurer un nouveau profil à utiliser avec l'authentification multifactorielle (MFA) et vos informations d'identification d'utilisateur IAM dans le profil spécifié. Si aucun profil n'est spécifié, le MFA est basé sur le default profil. Si aucun profil par défaut n'est configuré, la mfa-login commande vous invite à entrer vos AWS informations d'identification avant de demander les informations de votre MFA. L'exemple de commande suivant utilise votre configuration par défaut et crée un profil MFA.

$ aws configure mfa-login
MFA serial number or ARN: arn:aws:iam::123456789012:mfa/MFADeviceName
MFA token code: 123456
Profile to update [session-MFADeviceName]:
Temporary credentials written to profile 'session-MFADeviceName'
Credentials will expire at 2023-05-19 18:06:10 UTC
To use these credentials, specify --profile session-MFADeviceName when running AWS CLI commands

Pour mettre à jour un profil existant, utilisez le --update-profile paramètre.

$ aws configure mfa-login --profile myprofile --update-profile mfaprofile
MFA token code: 123456
Temporary credentials written to profile 'mfaprofile'
Credentials will expire at 2023-05-19 18:06:10 UTC
To use these credentials, specify --profile mfaprofile when running AWS CLI commands

Cette commande ne prend actuellement en charge que les authentificateurs par mot de passe à usage unique (OTP) matériels ou logiciels. Les clés d'accès et les appareils U2F ne sont actuellement pas pris en charge avec cette commande.

Pour plus d'informations sur l'utilisation de l'authentification MFA avec IAM, consultez la section Authentification AWS multifactorielle dans le guide de l'utilisateur.AWS Identity and Access Management

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

$ aws configure sso
SSO session name (Recommended): my-sso
SSO start URL [None]: https://my-sso-portal.awsapps.com/start
SSO region [None]: us-east-1
SSO registration scopes [None]: sso:account:access

Exécutez cette commande pour définir et afficher rapidement vos AWS IAM Identity Center informations d'identification, votre région et votre format de sortie dans la sso-session section des config fichiers credentials et. L’exemple suivant montre des exemples de valeurs.

$ aws configure sso-session
SSO session name: my-sso
SSO start URL [None]: https://my-sso-portal.awsapps.com/start
SSO region [None]: us-east-1
SSO registration scopes [None]: sso:account:access

Exécutez cette commande pour exporter les informations d’identification actuellement définies dans le format spécifié. Par défaut, la commande exporte les informations d'identification par défaut au process format, qui est un format JSON pris en charge par le format d'identification AWS SDKs and Tools.

$ aws configure export-credentials
{
  "Version": 1,
  "AccessKeyId": "AKIAIOSFODNN7EXAMPLE",
  "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
}

Pour exporter un profil et un format spécifiques, utilisez les options --profile et --format. Les options de format sont les suivantes :

L’exemple suivant exporte le profil user1 vers un format shell exporté.

$ aws configure export-credentials --profile user1 --format env
export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

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 :

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’environnement AWS_ACCOUNT_ID ou le paramètre aws_account_id.

account_id_endpoint_mode = preferred

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

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

aws_access_key_id = AKIAIOSFODNN7EXAMPLE

Spécifie 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’environnement AWS_ACCOUNT_ID_ENDPOINT_MODE ou le paramètre account_id_endpoint_mode doit être défini(e) sur preferred ou required pour l’utilisation de ce paramètre.

aws_account_id = 123456789EXAMPLE

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

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

aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

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

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

aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk

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_BUNDLE ou l’option de ligne de commande --ca-bundle.

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

Active l'invite automatique pour la AWS CLI version 2. Deux paramètres peuvent être utilisés :

Vous pouvez remplacer ce paramètre en utilisant la variable d’environnement aws_cli_auto_prompt ou les paramètres de ligne de commande --cli-auto-prompt et --no-cli-auto-prompt.

Pour plus d'informations sur la fonctionnalité d'invite automatique de la AWS CLI version 2, consultezActivation et utilisation des invites de commande dans l’AWS CLI.

Spécifie la manière dont la AWS CLI version 2 interprète les paramètres d'entrée binaires. Cette option peut avoir l’une des valeurs suivantes :

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

cli_binary_format = raw-in-base64-out

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

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

À compter de la version 2.31.0, l’affichage de la commande help est configuré par le paramètre cli_help_output et elle possède les valeurs suivantes :

cli_help_output = browser

Pour plus d’informations sur la commande help , consultez Accès à l'aide et aux ressources pour AWS CLI.

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 aws commandes.

cli_history = enabled

Vous pouvez répertorier votre historique à l’aide de la commande aws history list et utiliser la valeur command_ids obtenue dans la commande aws history show pour plus de détails. Pour plus d’informations, consultez aws history dans le guide de référence de l’AWS CLI .

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

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

cli_pager=less

Spécifie le format de sortie des valeurs d’horodatage. Vous pouvez spécifier chacune des valeurs suivantes :

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

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

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

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

credential_source = Ec2InstanceMetadata

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

Spécifie le point de terminaison 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:1234 et un point de terminaison spécifique au service http://localhost:4567 pour Amazon S3.

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

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

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

ignore_configure_endpoint_urls = true

Identifiant unique utilisé par des tiers pour assumer un rôle dans les comptes de leurs clients. Il est mappé au paramètre ExternalId dans l’opération AssumeRole. Ce paramètre n’est nécessaire que si la politique d’approbation du rôle spécifie une valeur pour ExternalId. 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.

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 à l’aide de la variable d’environnement AWS_MAX_ATTEMPTS.

max_attempts = 3

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 que arn:aws:iam::123456789012:mfa/user).

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

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

output = table

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

Cette entrée n’a pas de variable d’environnement ni d’option de ligne de commande équivalente.

parameter_validation = false

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

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

region = us-west-2

Indique le moment où une somme de contrôle est calculée pour les données utiles des demandes et propose les options suivantes :

request_checksum_calculation = when_supported

La variable d’environnement AWS_REQUEST_CHECKSUM_CALCULATION remplace ce paramètre.

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 :

response_checksum_validation = when_supported

La variable d’environnement AWS_RESPONSE_CHECKSUM_VALIDATION remplace ce paramètre.

Spécifie le mode de nouvelle tentative AWS CLI utilisé. Trois modes de nouvelle tentative sont disponibles : standard (par défaut), legacy (par défaut) et adaptive. 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

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 :

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

La 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.

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

role_session_name = maria_garcia_role

La variable d’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.

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

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

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

Pour plus d’informations sur 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.

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 = prod1

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

Spécifie 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-1

Pour 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.

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

source_profile = production-profile

Spécifie l'ID de AWS compte qui contient le rôle IAM avec l'autorisation que vous souhaitez accorder à l'utilisateur IAM Identity Center associé.

Ce paramètre n’a pas de variable d’environnement ni d’option de ligne de commande.

sso_account_id = 123456789012

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

Ce paramètre n’a pas de variable d’environnement ni d’option de ligne de commande.

sso_region = us_west-2

Liste CSV des portées d’application à autoriser pour sso-session. Les portées autorisent l’accès aux points de terminaison autorisés par le jeton de porteur IAM Identity Center. Une portée valide est une chaîne, telle que sso:account:access. Ce paramètre ne s’applique pas à la configuration non actualisable héritée.

sso_registration_scopes = sso:account:access

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

Ce paramètre n’a pas de variable d’environnement ni d’option de ligne de commande.

sso_role_name = ReadAccess

Spécifie l'URL qui pointe vers le portail d' AWS accès de l'organisation. Il AWS CLI utilise cette URL pour établir une session avec le service IAM Identity Center afin d'authentifier ses utilisateurs. Pour trouver l'URL de votre portail d' AWS accès, utilisez l'une des méthodes suivantes :

Ce paramètre n’a pas de variable d’environnement ni d’option de ligne de commande.

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

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 true et false. 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_endpoint sont mutuellement exclusifs.

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-url ou utilisez des points de terminaison spécifiques aux services.

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

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

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

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

Cette entrée n’a pas de variable d’environnement ni d’option de ligne de commande équivalente.

tcp_keepalive = false

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

Il existe deux styles de création d’un point de terminaison Amazon S3. Le premier est appelé virtual et inclut le nom du compartiment dans le nom d’hôte. Par exemple : https://bucketname.s3.amazonaws.com. Sinon, avec le style path, vous traitez le nom du compartiment comme s’il s’agissait d’un chemin d’accès dans l’URI : par exemple, https://s3.amazonaws.com/bucketname. La valeur par défaut dans l’interface de ligne de commande consiste à utiliser auto, qui tente d’utiliser le style virtual chaque fois que possible, mais bascule, au besoin, sur le style path. Par exemple, si le nom de votre compartiment n’est pas compatible DNS, ce nom ne peut pas faire partie du nom d’hôte et doit être dans le chemin d’accès. Avec auto, l’interface de ligne de commande détecte cette condition et passe automatiquement au style path. Si vous définissez le style d'adressage surpath, vous devez alors vous assurer que la AWS région dans laquelle vous avez configuré AWS CLI correspond à la région de votre compartiment.

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

Si 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.

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

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

Permet d’utiliser des points de terminaison à double pile pour l’envoi des demandes s3 et s3api. 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 true et false. 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_endpoint sont mutuellement exclusifs.

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 :

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

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

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

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

Spécifie le nombre maximal de tâches dans la file d’attente de tâches. La valeur par défaut est 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_requests Une tâche correspond généralement à une seule opération Amazon S3. Par exemple, une tâche pourrait être PutObjectTask, GetObjectTask ou UploadPartTask. La vitesse à laquelle les tâches sont ajoutées à la file d’attente peut être largement plus rapide que celle à laquelle les consommateurs terminent les tâches. Pour éviter une croissance sans limite, la taille de la file d’attente de tâches est limitée à une valeur spécifique. Ce paramètre modifie la valeur de ce nombre maximal.

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

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

Lorsqu’un transfert de fichier dépasse 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 que multipart_threshold, comme le nombre d’octets sous la forme d’un entier ou en utilisant une taille et un suffixe.

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

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