Configuration externe des clients de service pour la AWS SDK pour PHP version 3 - AWS SDK pour PHP

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.

Configuration externe des clients de service pour la AWS SDK pour PHP version 3

De nombreux paramètres de configuration peuvent être gérés en dehors de votre code. La plupart des paramètres de configuration peuvent être définis sous forme de variables d'environnement ou dans un AWS config fichier partagé distinct. Le config fichier AWS partagé peut gérer des ensembles de paramètres distincts, appelés profils, afin de fournir différentes configurations pour différents environnements ou tests. Pour une discussion complète sur le AWS partage config et les credentials fichiers, consultez le guide de référence des outils AWS SDKs et des outils.

La plupart des variables d'environnement et des paramètres de config fichiers partagés sont standardisés AWS SDKs et partagés entre des outils permettant de garantir des fonctionnalités cohérentes entre les différents langages de programmation et applications.

Pour voir tous les paramètres que le SDK peut résoudre à partir des variables d'environnement ou des fichiers de configuration, consultez la référence des paramètres dans le guide de référence des outils AWS SDKs et des outils.

Chaîne de fournisseurs de configuration pour la configuration du client

Le SDK vérifie plusieurs emplacements (ou sources) pour trouver des valeurs de configuration.

  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.

  2. Variables d’environnement

    • Pour plus de détails sur la définition des variables d'environnement, voir les variables d'environnement dans le guide de référence AWS SDKs et Tools.

    • Notez que vous pouvez configurer des variables d'environnement pour un shell à différents niveaux de portée : à l'échelle du système, à l'échelle de l'utilisateur et pour une session de terminal spécifique.

  3. Partage config et credentials fichiers

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

    • Certaines propriétés, telles que Region, n'ont pas de valeur par défaut. Vous devez les spécifier de manière explicite dans le code, dans un paramètre d'environnement ou dans le config fichier partagé. Si le SDK ne parvient pas à résoudre la configuration requise, les demandes d'API peuvent échouer lors de l'exécution.

Outre cette chaîne de configuration générale, la AWS SDK pour PHP version 3 utilise également des chaînes de fournisseurs spécialisées, notamment la chaîne de fournisseurs d'informations d'identification et la chaîne de Région AWS résolution. Ces chaînes spécialisées ajoutent des fournisseurs supplémentaires qui tiennent compte de l'environnement dans lequel le SDK s'exécute. Par exemple, dans un conteneur ou une EC2 instance.

Création d'un client de service configuré à l'aide de paramètres externes

Vous devez créer un client de service dans votre application pour parler à un Service AWS. Les clients du service sont votre lien essentiel. Services AWS Ils gèrent tous les détails complexes des communications afin que vous n'ayez pas à vous soucier d'eux. Ils prennent en charge des tâches importantes telles que la sécurité, la gestion des erreurs et les nouvelles tentatives automatiquement, ce qui vous permet de vous concentrer sur le développement de votre application plutôt que sur les complications techniques.

Construire un client de service à l'aide d'un constructeur sans paramètres

Si tous les paramètres de configuration dont vous avez besoin proviennent de sources externes, vous pouvez créer un client de service en utilisant un constructeur vide :

require 'vendor/autoload.php'; use Aws\S3\S3Client; $s3 = new S3Client([]);

L'extrait de code précédent crée une S3Client instance. Lors de la création, le SDK analyse les paramètres dans la chaîne des fournisseurs de configuration. Une fois que le SDK trouve une valeur de paramètre, il l'utilise.

La chaîne Région AWS de fournisseurs par défaut et la chaîne de fournisseurs d'informations d'identification par défaut seront également utilisées dans le processus de création. À un stade quelconque de la chaîne, le SDK doit résoudre les paramètres Région AWS à utiliser et à rechercher qui lui permettent de récupérer les informations d'identification pour les demandes de signature. Si le SDK ne trouve pas ces valeurs, la création du client échoue.

AWS SDK pour PHP Variables d'environnement version 3

Au-delà des paramètres cross-sdk pris en charge par la plupart AWS SDKs, la AWS SDK pour PHP version 3 fonctionne avec les variables d'environnement suivantes :

AWS_SDK_CHARGER_NONDEFAULT_CONFIG

Lorsqu'elle est définie, cette variable d'environnement indique au SDK de charger les informations d'identification à partir du ~/.aws/credential ou des AWS config fichiers en plus du ou des credentials fichiers. ~/.aws/config

AWS_SDK_UA_APP_ID

Définit un identifiant d'application personnalisé qui est inclus dans l'en-tête User-Agent pour les demandes effectuées par le SDK.

AWS_SUPPRESS_AVERTISSEMENT D'OBSOLESCENCE PHP

Lorsqu'il est défini sur true, il supprime les avertissements d'obsolescence PHP que le SDK pourrait générer.