Référence des paramètres

Les SDK fournissent des API spécifiques au langage pour. Services AWS Ils prennent en charge certaines des tâches les plus lourdes nécessaires à la réussite des appels d'API, notamment l'authentification, le comportement des nouvelles tentatives, etc. Pour ce faire, les SDK disposent de stratégies flexibles permettant d'obtenir des informations d'identification à utiliser pour vos demandes, de conserver les paramètres à utiliser avec chaque service et d'obtenir des valeurs à utiliser pour les paramètres globaux.

Vous trouverez des informations détaillées sur les paramètres de configuration dans les sections suivantes :

• AWS SDK et outils, fournisseurs d'identifiants standardisés— Fournisseurs d'informations d'identification communs normalisés sur plusieurs SDK.

• AWS Fonctionnalités standardisées des SDK et des outils— Fonctionnalités communes standardisées sur plusieurs SDK.

Création de clients de service

Pour y accéder par programmation Services AWS, les SDK utilisent une classe/un objet client pour chacun d'entre eux. Service AWS Par exemple, si votre application doit accéder à Amazon EC2, elle crée un objet client Amazon EC2 pour établir une interface avec ce service. Vous utilisez ensuite le client du service pour y faire des demandes Service AWS. Dans la plupart des SDK, un objet client de service est immuable. Vous devez donc créer un nouveau client pour chaque service auquel vous envoyez des demandes et pour envoyer des demandes au même service en utilisant une configuration différente.

Priorité des paramètres

Les paramètres globaux configurent les fonctionnalités, les fournisseurs d'informations d'identification et les autres fonctionnalités prises en charge par la plupart des SDK et ayant un large impact sur l'ensemble de ces derniers. Services AWS Tous les SDK comportent une série d'emplacements (ou de sources) qu'ils vérifient afin de trouver une valeur pour les paramètres globaux. La définition de la priorité de recherche est la suivante :

1. Tout paramètre explicite défini dans le code ou sur un client de service lui-même a priorité sur tout autre paramètre.

   • Certains paramètres peuvent être définis pour chaque opération et peuvent être modifiés selon les besoins pour chaque opération que vous invoquez. Pour le AWS CLI ou AWS Tools for PowerShell, ils prennent la forme de paramètres par opération que vous entrez sur la ligne de commande. Pour un SDK, les attributions explicites peuvent prendre la forme d'un paramètre que vous définissez lorsque vous instanciez un Service AWS client ou un objet de configuration, ou parfois lorsque vous appelez une API individuelle.

2. Java/Kotlin uniquement : la propriété du système JVM pour le paramètre est vérifiée. Si elle est définie, cette valeur est utilisée pour configurer le client.

3. La variable d'environnement est contrôlée. Si elle est définie, cette valeur est utilisée pour configurer le client.

4. Le SDK vérifie le paramètre dans credentials le fichier partagé. S'il est défini, le client l'utilise.

5. Le config fichier partagé pour le paramètre. Si le paramètre est présent, le SDK l'utilise.

   • La variable d'AWS_PROFILEenvironnement ou la propriété du système aws.profile JVM peuvent être utilisées pour spécifier le profil chargé par le SDK.

6. Toute valeur par défaut fournie par le code source du SDK lui-même est utilisée en dernier.

Note

Certains SDK et outils peuvent être enregistrés dans un ordre différent. En outre, certains SDK et outils prennent en charge d'autres méthodes de stockage et de récupération de paramètres. Par exemple, il AWS SDK for .NET prend en charge une source supplémentaire appelée SDK Store. Pour plus d'informations sur les fournisseurs spécifiques à un SDK ou à un outil, consultez le guide spécifique au SDK ou à l'outil que vous utilisez.

L'ordre détermine quelles méthodes ont priorité et remplacent les autres. Par exemple, si vous configurez un profil dans le config fichier partagé, il n'est trouvé et utilisé qu'une fois que le SDK ou l'outil a d'abord vérifié les autres emplacements. Cela signifie que si vous insérez un paramètre dans le credentials fichier, il est utilisé à la place de celui qui se trouve dans le config fichier. Si vous configurez une variable d'environnement avec un paramètre et une valeur, elle remplacera ce paramètre dans les config fichiers credentials et. Enfin, un réglage sur l'opération individuelle (paramètre de AWS CLI ligne de commande ou paramètre d'API) ou dans le code remplacerait toutes les autres valeurs de cette commande.

Configliste des paramètres de fichier

Les paramètres répertoriés dans le tableau suivant peuvent être attribués dans le AWS config fichier partagé. Elles sont mondiales et concernent tout le monde Services AWS. Les SDK et les outils peuvent également prendre en charge des paramètres et des variables d'environnement uniques. Pour voir les paramètres et les variables d'environnement pris en charge uniquement par un SDK ou un outil individuel, consultez ce SDK ou ce guide d'outils spécifique.

Nom du paramètre	Détails
api_versions	Paramètres de configuration généraux
aws_access_key_id	AWS clés d'accès
aws_secret_access_key	AWS clés d'accès
aws_session_token	AWS clés d'accès
ca_bundle	Paramètres de configuration généraux
credential_process	Fournisseur d'identifiants de processus
credential_source	Assumer le rôle de fournisseur d'informations d'identification
defaults_mode	Paramètres de configuration intelligents par défaut
disable_request_compression	Compression des demandes
duration_seconds	Assumer le rôle de fournisseur d'informations d'identification
ec2_metadata_service_endpoint	fournisseur d'informations d'identification IMDS
ec2_metadata_service_endpoint_mode	fournisseur d'informations d'identification IMDS
ec2_metadata_v1_disabled	fournisseur d'informations d'identification IMDS
endpoint_discovery_enabled	Découverte des terminaux
endpoint_url	Points de terminaison spécifiques au service
external_id	Assumer le rôle de fournisseur d'informations d'identification
ignore_configured_endpoint_urls	Points de terminaison spécifiques au service
max_attempts	Comportement des nouvelles tentatives
metadata_service_num_attempts	Métadonnées de l'instance Amazon EC2
metadata_service_timeout	Métadonnées de l'instance Amazon EC2
mfa_serial	Assumer le rôle de fournisseur d'informations d'identification
output	Paramètres de configuration généraux
parameter_validation	Paramètres de configuration généraux
region	Région AWS
request_min_compression_size_bytes	Compression des demandes
retry_mode	Comportement des nouvelles tentatives
role_arn	Assumer le rôle de fournisseur d'informations d'identification
role_session_name	Assumer le rôle de fournisseur d'informations d'identification
s3_disable_multiregion_access_points	Amazon S3 Multi-Region Access Points
s3_use_arn_region	Points d'accès Amazon S3
sdk_ua_app_id	ID d'application
source_profile	Assumer le rôle de fournisseur d'informations d'identification
sso_account_id	Fournisseur d'identifiants IAM Identity Center
sso_region	Fournisseur d'identifiants IAM Identity Center
sso_registration_scopes	Fournisseur d'identifiants IAM Identity Center
sso_role_name	Fournisseur d'identifiants IAM Identity Center
sso_start_url	Fournisseur d'identifiants IAM Identity Center
sts_regional_endpoints	AWS STS Points de terminaison régionalisés
use_dualstack_endpoint	Points de terminaison à double pile et FIPS
use_fips_endpoint	Points de terminaison à double pile et FIPS
web_identity_token_file	Assumer le rôle de fournisseur d'informations d'identification

Credentialsliste des paramètres de fichier

Les paramètres répertoriés dans le tableau suivant peuvent être attribués dans le AWS credentials fichier partagé. Elles sont mondiales et concernent tout le monde Services AWS. Les SDK et les outils peuvent également prendre en charge des paramètres et des variables d'environnement uniques. Pour voir les paramètres et les variables d'environnement pris en charge uniquement par un SDK ou un outil individuel, consultez ce SDK ou ce guide d'outils spécifique.

Nom du paramètre	Détails
aws_access_key_id	AWS clés d'accès
aws_secret_access_key	AWS clés d'accès
aws_session_token	AWS clés d'accès

Liste des variables d'environnement

Les variables d'environnement prises en charge par la plupart des SDK sont répertoriées dans le tableau suivant. Elles sont mondiales et concernent tout le monde Services AWS. Les SDK et les outils peuvent également prendre en charge des paramètres et des variables d'environnement uniques. Pour voir les paramètres et les variables d'environnement pris en charge uniquement par un SDK ou un outil individuel, consultez ce SDK ou ce guide d'outils spécifique.

Nom du paramètre	Détails
AWS_ACCESS_KEY_ID	AWS clés d'accès
AWS_CA_BUNDLE	Paramètres de configuration généraux
AWS_CONFIG_FILE	Emplacement du partage config et des credentials fichiers
AWS_CONTAINER_AUTHORIZATION_TOKEN	Fournisseur d'informations d'identification du conteneur
AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE	Fournisseur d'informations d'identification du conteneur
AWS_CONTAINER_CREDENTIALS_FULL_URI	Fournisseur d'informations d'identification du conteneur
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI	Fournisseur d'informations d'identification du conteneur
AWS_DEFAULTS_MODE	Paramètres de configuration intelligents par défaut
AWS_DISABLE_REQUEST_COMPRESSION	Compression des demandes
AWS_EC2_METADATA_DISABLED	fournisseur d'informations d'identification IMDS
AWS_EC2_METADATA_SERVICE_ENDPOINT	fournisseur d'informations d'identification IMDS
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE	fournisseur d'informations d'identification IMDS
AWS_EC2_METADATA_V1_DISABLED	fournisseur d'informations d'identification IMDS
AWS_ENABLE_ENDPOINT_DISCOVERY	Découverte des terminaux
AWS_ENDPOINT_URL	Points de terminaison spécifiques au service
AWS_ENDPOINT_URL_<SERVICE>	Points de terminaison spécifiques au service
AWS_IAM_ROLE_ARN	Assumer le rôle de fournisseur d'informations d'identification
AWS_IAM_ROLE_SESSION_NAME	Assumer le rôle de fournisseur d'informations d'identification
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS	Points de terminaison spécifiques au service
AWS_MAX_ATTEMPTS	Comportement des nouvelles tentatives
AWS_METADATA_SERVICE_NUM_ATTEMPTS	Métadonnées de l'instance Amazon EC2
AWS_METADATA_SERVICE_TIMEOUT	Métadonnées de l'instance Amazon EC2
AWS_PROFILE	Partage config et credentials fichiers
AWS_REGION	Région AWS
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES	Compression des demandes
AWS_RETRY_MODE	Comportement des nouvelles tentatives
AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS	Amazon S3 Multi-Region Access Points
AWS_S3_USE_ARN_REGION	Points d'accès Amazon S3
AWS_SDK_UA_APP_ID	ID d'application
AWS_SECRET_ACCESS_KEY	AWS clés d'accès
AWS_SESSION_TOKEN	AWS clés d'accès
AWS_SHARED_CREDENTIALS_FILE	Emplacement du partage config et des credentials fichiers
AWS_STS_REGIONAL_ENDPOINTS	AWS STS Points de terminaison régionalisés
AWS_USE_DUALSTACK_ENDPOINT	Points de terminaison à double pile et FIPS
AWS_USE_FIPS_ENDPOINT	Points de terminaison à double pile et FIPS
AWS_WEB_IDENTITY_TOKEN_FILE	Assumer le rôle de fournisseur d'informations d'identification

Liste des propriétés du système JVM

Vous pouvez utiliser les propriétés du système JVM suivantes pour le AWS SDK for Java et Kit AWS SDK pour Kotlin (en ciblant la JVM). Consultez Comment définir les propriétés du système JVM les instructions sur la façon de définir les propriétés du système JVM.

Nom du paramètre	Détails
aws.accessKeyId	AWS clés d'accès
aws.configFile	Emplacement du partage config et des credentials fichiers
aws.defaultsMode	Paramètres de configuration intelligents par défaut
aws.disableEc2MetadataV1	fournisseur d'informations d'identification IMDS
aws.disableRequestCompression	Compression des demandes
aws.ec2MetadataServiceEndpoint	fournisseur d'informations d'identification IMDS
aws.ec2MetadataServiceEndpointMode	fournisseur d'informations d'identification IMDS
aws.endpointDiscoveryEnabled	Découverte des terminaux
aws.endpointUrl	Points de terminaison spécifiques au service
aws.endpointUrl<ServiceName>	Points de terminaison spécifiques au service
aws.ignoreConfiguredEndpointUrls	Points de terminaison spécifiques au service
aws.maxAttempts	Comportement des nouvelles tentatives
aws.profile	Partage config et credentials fichiers
aws.region	Région AWS
aws.requestMinCompressionSizeBytes	Compression des demandes
aws.retryMode	Comportement des nouvelles tentatives
aws.roleArn	Assumer le rôle de fournisseur d'informations d'identification
aws.roleSessionName	Assumer le rôle de fournisseur d'informations d'identification
aws.s3DisableMultiRegionAccessPoints	Amazon S3 Multi-Region Access Points
aws.s3UseArnRegion	Points d'accès Amazon S3
aws.secretAccessKey	AWS clés d'accès
aws.sessionToken	AWS clés d'accès
aws.sharedCredentialsFile	Emplacement du partage config et des credentials fichiers
aws.useDualstackEndpoint	Points de terminaison à double pile et FIPS
aws.useFipsEndpoint	Points de terminaison à double pile et FIPS
aws.userAgentAppId	ID d'application
aws.webIdentityTokenFile	Assumer le rôle de fournisseur d'informations d'identification