Partage config et credentials fichiers

Les credentials fichiers partagés AWS config contiennent un ensemble de profils. Un profil est un ensemble de paramètres de configuration, exprimés en paires clé-valeur, utilisés par le AWS Command Line Interface (AWS CLI) AWS SDKs, le et d'autres outils. Les valeurs de configuration sont attachées à un profil afin de configurer certains aspects du SDK /tool lorsque ce profil est utilisé. Ces fichiers sont « partagés » dans la mesure où les valeurs ont un effet sur les applications, les processus ou SDKs sur l'environnement local d'un utilisateur.

Les fichiers partagés config et credentials les fichiers sont des fichiers en texte brut contenant uniquement des ASCII caractères (encodés en UTF -8). Ils prennent la forme de ce que l'on appelle généralement des INIfichiers.

Profils

Les paramètres du partage config et credentials des fichiers sont associés à un profil spécifique. Plusieurs profils peuvent être définis dans le fichier afin de créer différentes configurations de paramètres à appliquer dans différents environnements de développement.

Le [default] profil contient les valeurs utilisées par une opération SDK ou un outil si aucun profil nommé spécifique n'est spécifié. Vous pouvez également créer des profils distincts auxquels vous pouvez explicitement faire référence par leur nom. Chaque profil peut utiliser des paramètres et des valeurs différents selon les besoins de votre application et de votre scénario.

Note

[default]est simplement un profil anonyme. Ce profil est nommé default car il s'agit du profil par défaut utilisé par le SDK si l'utilisateur ne spécifie aucun profil. Il ne fournit pas de valeurs par défaut héritées aux autres profils. Si vous définissez un élément dans le [default] profil et que vous ne le définissez pas dans un profil nommé, la valeur n'est pas définie lorsque vous utilisez le profil nommé.

Définissez un profil nommé

Le [default] profil et plusieurs profils nommés peuvent exister dans le même fichier. Utilisez le paramètre suivant pour sélectionner les paramètres du profil utilisés par votre outil SDK ou par votre outil lors de l'exécution de votre code. Les profils peuvent également être sélectionnés dans le code ou par commande lorsque vous travaillez avec le AWS CLI.

Configurez cette fonctionnalité en définissant l'une des options suivantes :

AWS_PROFILE- variable d'environnement

Lorsque cette variable d'environnement est définie sur un profil nommé ou « par défaut », l'ensemble SDK du code et des AWS CLI commandes utilisent les paramètres de ce profil.

Exemple Linux/macOS de définition de variables d'environnement via la ligne de commande :

export AWS_PROFILE="my_default_profile_name";

Exemple Windows de définition de variables d'environnement via la ligne de commande :

setx AWS_PROFILE "my_default_profile_name"

aws.profile- propriété JVM du système

SDKPour Kotlin sur Java 2.x JVM et SDK pour Java 2.x, vous pouvez définir la propriété du aws.profile système. Lorsque le client de service SDK crée, il utilise les paramètres du profil nommé, sauf si le paramètre est remplacé dans le code. La version 1.x de SDK for Java ne prend pas en charge cette propriété système.

Note

Si votre application se trouve sur un serveur exécutant plusieurs applications, nous vous recommandons de toujours utiliser des profils nommés plutôt que le profil par défaut. Le profil par défaut est automatiquement sélectionné par n'importe quelle AWS application de l'environnement et est partagé entre elles. Ainsi, si quelqu'un d'autre met à jour le profil par défaut de son application, cela peut avoir un impact involontaire sur les autres. Pour éviter cela, définissez un profil nommé dans le config fichier partagé, puis utilisez-le dans votre application en définissant le profil nommé dans votre code. Vous pouvez utiliser la variable d'environnement ou la propriété JVM système pour définir le profil nommé si vous savez que sa portée n'affecte que votre application.

Format du fichier de configuration

Le config fichier est organisé en sections. 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.

Le config fichier est un fichier en texte brut qui utilise le format suivant :

• Toutes les entrées d'une section prennent la forme générale desetting-name=value.

• Les lignes peuvent être commentées en commençant par un hashtag (#).

Types de sections

Une définition de section est une ligne qui donne un nom à un ensemble de paramètres. Les lignes de définition de section commencent et se terminent par des crochets ([]). À l'intérieur des crochets, il y a un identifiant de type de section et un nom personnalisé pour la section. Vous pouvez utiliser des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_), mais pas d'espaces.

Type de section : default

Exemple de ligne de définition de section : [default]

[default]est le seul profil qui ne nécessite pas l'identifiant de profile section.

L'exemple suivant montre un config fichier de base avec un [default] profil. Il définit le regionréglage. Tous les paramètres qui suivent cette ligne, jusqu'à ce qu'une autre définition de section soit trouvée, font partie de ce profil.

[default]
#Full line comment, this text is ignored.
region = us-east-2

Type de section : profile

Exemple de ligne de définition de section : [profile dev]

La ligne de définition de profile section est un groupe de configuration nommé que vous pouvez appliquer à différents scénarios de développement. Pour mieux comprendre les profils nommés, consultez la section précédente sur les profils.

L'exemple suivant montre un config fichier avec une ligne de définition de profile section et un profil nommé appeléfoo. Tous les paramètres qui suivent cette ligne, jusqu'à ce qu'une autre définition de section soit trouvée, font partie de ce profil nommé.

[profile foo]
...settings...

Certains paramètres possèdent leur propre groupe imbriqué de sous-paramètres, tels que le s3 paramètre et les sous-paramètres de l'exemple suivant. Associez les sous-paramètres au groupe en les indentant d'un ou de plusieurs espaces.

[profile test]
region = us-west-2
s3 =
    max_concurrent_requests=10
    max_queue_size=1000

Type de section : sso-session

Exemple de ligne de définition de section : [sso-session my-sso]

La ligne de définition de sso-session section nomme un groupe de paramètres que vous utilisez pour configurer un profil afin de résoudre les AWS informations d'identification utilisées AWS IAM Identity Center. Pour plus d'informations sur la configuration de l'authentification unique, consultezIAMAuthentification Identity Center pour votre outil SDK ORL. Un profil est lié à une sso-session section par une paire clé-valeur où sso-session est la clé et le nom de votre sso-session section est la valeur, par exemple. sso-session = <name-of-sso-session-section>

L'exemple suivant configure un profil qui obtiendra des informations d' AWS identification à court terme pour le IAM rôle « » dans le compte « 111122223333 SampleRole » à l'aide d'un jeton du « my-sso ». La section « my-sso » est référencée dans la sso-session profile section par son nom à l'aide de la sso-session clé.

[profile dev]
sso_session = my-sso
sso_account_id = 111122223333
sso_role_name = SampleRole

[sso-session my-sso]
sso_region = us-east-1
sso_start_url = https://my-sso-portal.awsapps.com/start

Type de section : services

Exemple de ligne de définition de section : [services dev]

Note

La services section prend en charge les personnalisations de point de terminaison spécifiques au service et n'est disponible que dans les SDKs outils qui incluent cette fonctionnalité. Pour savoir si cette fonctionnalité est disponible pour vousSDK, consultez les points de Compatibilité avec AWS SDKs terminaison spécifiques au service.

La ligne de définition de services section nomme un groupe de paramètres qui configurent les points de terminaison personnalisés pour les Service AWS demandes. Un profil est lié à une services section par une paire clé-valeur où services est la clé et le nom de votre services section est la valeur, par exemple. services = <name-of-services-section>

La services section est ensuite 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, consultezIdentifiants pour les points de terminaison spécifiques au service. 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 utilise une services définition pour configurer le point de terminaison à utiliser pour les demandes adressées uniquement au Amazon DynamoDB service. La "local-dynamodb" services section est référencée dans la profile section par son nom à l'aide de la services clé. La clé Service AWS d'identification estdynamodb. La sous-section des Amazon DynamoDB services commence sur la lignedynamodb = . Toutes les lignes indentées qui suivent immédiatement sont incluses dans cette sous-section et s'appliquent à ce service.

[profile dev]
services = local-dynamodb

[services local-dynamodb]
dynamodb = 
  endpoint_url = http://localhost:8000

Pour plus d'informations sur la configuration personnalisée des points de terminaison, consultezPoints de terminaison spécifiques au service.

Format du fichier d'informations d'identification

Les règles du credentials fichier sont généralement identiques à celles du config fichier, sauf que les sections du profil ne commencent pas par le motprofile. Utilisez uniquement le nom du profil lui-même entre crochets. L'exemple suivant montre un credentials fichier dont la section de profil nommée est appeléefoo.

[foo]
...credential settings...

Seuls les paramètres considérés comme « secrets » ou sensibles peuvent être enregistrés dans le credentials fichier :aws_access_key_id,aws_secret_access_key, etaws_session_token. Bien que ces paramètres puissent également être placés dans le config fichier partagé, nous vous recommandons de conserver ces valeurs sensibles dans un credentials fichier distinct. Ainsi, vous pouvez fournir des autorisations distinctes pour chaque fichier, si nécessaire.

L'exemple suivant montre un credentials fichier de base avec un [default] profil. Il définit les paramètres aws_access_key_idaws_secret_access_key, et aws_session_token globaux.

[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
aws_session_token=IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZ2luX2IQoJb3JpZVERYLONGSTRINGEXAMPLE

Que vous utilisiez un profil nommé ou un « default » dans votre credentials fichier, tous les paramètres de ce fichier seront combinés avec ceux de votre config fichier qui utilisent le même nom de profil. 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é.