Référence des paramètres - AWS SDKset outils
Création de clients de servicePriorité des paramètresPages de paramètresConfigliste des paramètres de fichierCredentialsliste des paramètres de fichierListe des variables d'environnementJVMliste des propriétés du système

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.

Référence des paramètres

SDKsfournir des informations spécifiques à la langue APIs pour. Services AWS Ils prennent en charge certaines des tâches les plus lourdes nécessaires à la réussite des API appels, notamment l'authentification, le comportement des nouvelles tentatives, etc. Pour ce faire, SDKs ils disposent de stratégies flexibles pour obtenir des informations d'identification à utiliser pour vos demandes, pour maintenir les paramètres à utiliser avec chaque service et pour 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 :

Création de clients de service

Pour y accéder par programmation Services AWS, SDKs utilisez une classe/un objet client pour chacun. Service AWS Par exemple, si votre application doit accéder à AmazonEC2, elle crée un objet EC2 client Amazon pour interagir avec ce service. Vous utilisez ensuite le client du service pour y faire des demandes Service AWS. Dans la plupart des casSDKs, un objet client de service est immuable. Vous devez donc créer un nouveau client pour chaque service auquel vous faites 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 SDKs utilisateurs et ayant un large impact sur tous Services AWS. Tous SDKs ont une série de lieux (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. Par exempleSDK, les assignations 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 personne. API

  2. Java/Kotlin uniquement : la propriété JVM système du 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. SDKVérifie le paramètre dans le credentials 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, il l'SDKutilise.

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

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

Note

Certains SDKs outils peuvent être enregistrés dans un ordre différent. En outre, certains SDKs outils prennent en charge d'autres méthodes de stockage et de récupération des paramètres. Par exemple, il AWS SDK for .NET prend en charge une source supplémentaire appelée SDKStore. Pour plus d'informations sur les fournisseurs spécifiques à un outil SDK ou, consultez le guide spécifique à l'outil SDK ou 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 l'outil SDK ou 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 API paramètre) ou dans le code remplacerait toutes les autres valeurs de cette commande.

Pages de paramètres

Les pages de la section de référence des paramètres de ce guide détaillent les paramètres disponibles qui peuvent être définis par le biais de différents mécanismes. Les tableaux suivants répertorient les paramètres des fichiers de configuration et d'identification, les variables d'environnement et (pour Java et KotlinSDKs) les JVM paramètres qui peuvent être utilisés en dehors de votre code pour configurer la fonctionnalité. Chaque rubrique liée dans chaque liste vous amène à la page de paramètres correspondante.

Chaque fournisseur d'informations d'identification ou fonctionnalité possède une page répertoriant les paramètres utilisés pour configurer cette fonctionnalité. Pour chaque paramètre, vous pouvez souvent définir la valeur soit en ajoutant le paramètre à un fichier de configuration, soit en définissant une variable d'environnement, soit (pour Java et Kotlin uniquement) en définissant une propriété JVM système. Chaque paramètre répertorie toutes les méthodes prises en charge pour définir la valeur dans un bloc situé au-dessus des détails de la description. Bien que la priorité varie, la fonctionnalité qui en résulte est la même, quelle que soit la manière dont vous la définissez.

La description inclura la valeur par défaut, le cas échéant, qui prend effet si vous ne faites rien. Il définit également la valeur valide pour ce paramètre.

Par exemple, examinons un paramètre de la page des Compression des demandes fonctionnalités.

Les informations du paramètre d'disable_request_compressionexemple indiquent ce qui suit :

  • Il existe trois méthodes équivalentes pour contrôler la compression des demandes en dehors de votre base de code. Vous avez le choix entre les options suivantes :

    • Définissez-le dans votre fichier de configuration en utilisant disable_request_compression

    • Définissez-la comme variable d'environnement en utilisant AWS_DISABLE_REQUEST_COMPRESSION

    • Ou, si vous utilisez Java ou KotlinSDK, définissez-le comme propriété JVM système en utilisant aws.disableRequestCompression

    Note

    Il existe peut-être également un moyen de configurer la même fonctionnalité directement dans votre code, mais cette référence ne couvre pas ce point car il est unique à chacunSDK. Si vous souhaitez définir votre configuration dans le code lui-même, consultez votre SDK guide ou API référence spécifique.

  • Si vous ne faites rien, la valeur par défaut serafalse.

  • Les seules valeurs valides pour ce paramètre booléen sont true et. false

Au bas de chaque page de fonctionnalité se trouve un AWS SDKs tableau de compatibilité avec.

Ce tableau indique si SDK vous acceptez les paramètres répertoriés sur la page. La Supported colonne indique le niveau de support avec les valeurs suivantes :

  • Yes— Les paramètres sont entièrement pris en charge par le SDK tel qu'il est écrit.

  • Partial— Certains paramètres sont pris en charge ou le comportement s'écarte de la description. En Partial effet, une note supplémentaire indique l'écart.

  • No— Aucun des paramètres n'est pris en charge. Cela ne prétend pas que les mêmes fonctionnalités peuvent être obtenues dans le code ; cela indique simplement que les paramètres de configuration externes répertoriés ne sont pas pris en charge.

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. SDKset 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 individu SDK ou un outil, consultez le guide spécifique SDK ou le guide de l'outil.

Nom du paramètre Détails
account_id_endpoint_mode Points de terminaison basés sur des comptes
api_versions Paramètres de configuration généraux
aws_access_key_id AWS clés d'accès
aws_account_id Points de terminaison basés sur des comptes
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 IMDSfournisseur d'informations d'identification
ec2_metadata_service_endpoint_mode IMDSfournisseur d'informations d'identification
ec2_metadata_v1_disabled IMDSfournisseur d'informations d'identification
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 EC2 l'instance Amazon
metadata_service_timeout Métadonnées de EC2 l'instance Amazon
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 IAMFournisseur d'identifiants Identity Center
sso_region IAMFournisseur d'identifiants Identity Center
sso_registration_scopes IAMFournisseur d'identifiants Identity Center
sso_role_name IAMFournisseur d'identifiants Identity Center
sso_start_url IAMFournisseur d'identifiants Identity Center
sts_regional_endpoints AWS STS Points de terminaison régionaux
use_dualstack_endpoint Double pile et FIPS points de terminaison
use_fips_endpoint Double pile et FIPS points de terminaison
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. SDKset 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 individu SDK ou un outil, consultez le guide spécifique SDK ou le guide de l'outil.

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 SDKs sont répertoriées dans le tableau suivant. Elles sont mondiales et concernent tout le monde Services AWS. SDKset 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 individu SDK ou un outil, consultez le guide spécifique SDK ou le guide de l'outil.

Nom du paramètre Détails
AWS_ACCESS_KEY_ID AWS clés d'accès
AWS_ACCOUNT_ID Points de terminaison basés sur des comptes
AWS_ACCOUNT_ID_ENDPOINT_MODE Points de terminaison basés sur des comptes
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 IMDSfournisseur d'informations d'identification
AWS_EC2_METADATA_SERVICE_ENDPOINT IMDSfournisseur d'informations d'identification
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE IMDSfournisseur d'informations d'identification
AWS_EC2_METADATA_V1_DISABLED IMDSfournisseur d'informations d'identification
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_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 EC2 l'instance Amazon
AWS_METADATA_SERVICE_TIMEOUT Métadonnées de EC2 l'instance Amazon
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_ROLE_ARN Assumer le rôle de fournisseur d'informations d'identification
AWS_ROLE_SESSION_NAME Assumer le rôle de fournisseur d'informations d'identification
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égionaux
AWS_USE_DUALSTACK_ENDPOINT Double pile et FIPS points de terminaison
AWS_USE_FIPS_ENDPOINT Double pile et FIPS points de terminaison
AWS_WEB_IDENTITY_TOKEN_FILE Assumer le rôle de fournisseur d'informations d'identification

JVMliste des propriétés du système

Vous pouvez utiliser les propriétés JVM système suivantes pour le AWS SDK for Java et Kit AWS SDK pour Kotlin (en ciblant leJVM). 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 JVM du système.

Nom du paramètre Détails
aws.accessKeyId AWS clés d'accès
aws.accountId Points de terminaison basés sur des comptes
aws.accountIdEndpointMode Points de terminaison basés sur des comptes
aws.configFile Emplacement du partage config et des credentials fichiers
aws.defaultsMode Paramètres de configuration intelligents par défaut
aws.disableEc2MetadataV1 IMDSfournisseur d'informations d'identification
aws.disableRequestCompression Compression des demandes
aws.ec2MetadataServiceEndpoint IMDSfournisseur d'informations d'identification
aws.ec2MetadataServiceEndpointMode IMDSfournisseur d'informations d'identification
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 Double pile et FIPS points de terminaison
aws.useFipsEndpoint Double pile et FIPS points de terminaison
aws.userAgentAppId ID d'application
aws.webIdentityTokenFile Assumer le rôle de fournisseur d'informations d'identification