Umgebungsvariablen zur Konfiguration der AWS CLI

Das AWS CLI unterstützt die folgenden Umgebungsvariablen.

AWS_ACCESS_KEY_ID

Gibt einen AWS Zugriffsschlüssel an, der einem IAM-Konto zugeordnet ist.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung aws_access_key_id. Es ist nicht möglich, die Zugriffsschlüssel-ID mithilfe einer Befehlszeilenoption anzugeben.

AWS_CA_BUNDLE

Gibt den Pfad zu einem Zertifikat-Bundle für die HTTPS-Zertifikatvalidierung an.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung ca_bundle. Sie können diese Umgebungsvariable mithilfe des --ca-bundle-Befehlszeilenparameters überschreiben.

AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS

Wenn bei der Verwendung des s3 mv Befehls Benutzerdefiniert Quell- und Ziel-Bucket identisch sind, kann die Quelldatei oder das Quellobjekt auf sich selbst verschoben werden, was zu einem versehentlichen Löschen Ihrer Quelldatei oder Ihres Quellobjekts führen kann. Die AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS Umgebungsvariable und --validate-same-s3-paths -option geben an, ob Ihre Access Point-ARNs oder Access Point-Aliase in Ihren Amazon S3 S3-Quell- oder Ziel-URIs validiert werden sollen.

Anmerkung

Die Pfadvalidierung für s3 mv erfordert zusätzliche API-Aufrufe.

AWS_CONFIG_FILE

Gibt den Speicherort der Datei an, die zum Speichern von Konfigurationsprofilen AWS CLI verwendet wird. Der Standardpfad ist ~/.aws/config.

Sie können diesen Wert nicht in einer benannten Profileinstellung oder mithilfe eines Befehlszeilenparameters angeben.

AWS_DATA_PATH

Eine Liste zusätzlicher Verzeichnisse, die ~/.aws/models beim Laden von AWS CLI Daten außerhalb des integrierten Suchpfads überprüft werden sollen. Durch die Festlegung dieser Umgebungsvariable werden zusätzliche Verzeichnisse angegeben, die zuerst überprüft werden, bevor auf die integrierten Suchpfade zurückgegriffen wird. Mehrere Einträge sollten mit dem os.pathsep-Zeichen getrennt werden (unter Linux oder macOS : und unter Windows ;).

AWS_DEFAULT_OUTPUT

Gibt das zu verwendende Ausgabeformat an.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung output. Sie können diese Umgebungsvariable mithilfe des --output-Befehlszeilenparameters überschreiben.

AWS_DEFAULT_REGION

Der Default region name identifiziert die AWS Region, an deren Server Sie Ihre Anfragen standardmäßig senden möchten. Dies ist in der Regel die nächstgelegene Region, aber jede Region ist zulässig. Sie können beispielsweise us-west-2 eingeben, um USA West (Oregon) zu verwenden. Dies ist die Region, an die alle späteren Anfragen gesendet werden, es sei denn, Sie geben in einem Befehl etwas anderes an.

Anmerkung

Sie müssen eine AWS Region angeben, wenn Sie die verwenden AWS CLI, entweder explizit oder indem Sie eine Standardregion festlegen. Eine Liste der verfügbaren Regionen finden Sie unter Regionen und Endpunkte. Die von der verwendeten Regionsbezeichnungen AWS CLI sind dieselben Namen, die Sie in AWS Management Console URLs und Dienstendpunkten sehen.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung region. Sie können diese Umgebungsvariable überschreiben, indem Sie den --region Befehlszeilenparameter Umgebungsvariable verwenden.

AWS_EC2_METADATA_DISABLED

Deaktiviert die Verwendung des Amazon-EC2-Instance-Metadaten-Services (IMDS).

Wenn auf „true“ gesetzt, werden Benutzeranmeldeinformationen oder -konfigurationen (wie die Region) nicht vom IMDS angefordert.

AWS_ENDPOINT_URL

Gibt den Endpunkt an, der für alle Serviceanforderungen verwendet wird.

Die Einstellungen für die Endpunktkonfiguration befinden sich an mehreren Stellen, z. B. in den System- oder Benutzerumgebungsvariablen, in lokalen AWS Konfigurationsdateien, oder werden explizit in der Befehlszeile als Parameter deklariert. Die AWS CLI -Endpunktkonfigurationseinstellungen haben Vorrang in der folgenden Reihenfolge:

1. Die Befehlszeilenoption --endpoint-url

2. Bei aktivierter Option die globale Endpunkt-Umgebungsvariable AWS_IGNORE_CONFIGURED_ENDPOINT_URLS oder die Profileinstellung ignore_configure_endpoint_urls zum Ignorieren von benutzerdefinierten Endpunkten

3. Der Wert, der von einer servicespezifischen Umgebungsvariablen AWS_ENDPOINT_URL_<SERVICE> bereitgestellt wird, z. B. AWS_ENDPOINT_URL_DYNAMODB

4. Die von den AWS_USE_DUALSTACK_ENDPOINT-, AWS_USE_FIPS_ENDPOINT- und AWS_ENDPOINT_URL-Umgebungsvariablen bereitgestellten Werte.

5. Der servicespezifische Endpunktwert, der durch die Einstellung endpoint_url in einem services-Abschnitt der freigegebenen config-Datei bereitgestellt wird

6. Der Wert, der durch die Einstellung endpoint_url in einem profile der freigegebenen config-Datei bereitgestellt wird

7. use_dualstack_endpoint-, use_fips_endpoint- und endpoint_url-Einstellungen.

8. Jede Standard-Endpunkt-URL für den jeweiligen Endpunkt AWS-Service wird zuletzt verwendet. Eine Liste der Standard-Service-Endpunkte, die in den einzelnen Regionen verfügbar sind, finden Sie unter AWS -Regionen und -Endpunkte im Allgemeine Amazon Web Services-Referenz.

AWS_ENDPOINT_URL_<SERVICE>

Gibt einen benutzerdefinierten Endpunkt an, der für einen bestimmten Dienst verwendet <SERVICE> wird und der durch den AWS-Service Bezeichner ersetzt wird. Amazon DynamoDB Hat zum Beispiel ein serviceId von DynamoDB. Für diesen Service lautet die Umgebungsvariable für die Endpunkt-URL AWS_ENDPOINT_URL_DYNAMODB.

Eine Liste aller servicespezifischen Umgebungsvariablen finden Sie unter Liste der servicespezifischen Kennungen.

Die Einstellungen für die Endpunktkonfiguration befinden sich an mehreren Stellen, z. B. in den System- oder Benutzerumgebungsvariablen, in lokalen AWS Konfigurationsdateien, oder sie werden explizit in der Befehlszeile als Parameter deklariert. Die AWS CLI -Endpunktkonfigurationseinstellungen haben Vorrang in der folgenden Reihenfolge:

1. Die Befehlszeilenoption --endpoint-url

2. Bei aktivierter Option die globale Endpunkt-Umgebungsvariable AWS_IGNORE_CONFIGURED_ENDPOINT_URLS oder die Profileinstellung ignore_configure_endpoint_urls zum Ignorieren von benutzerdefinierten Endpunkten

3. Der Wert, der von einer servicespezifischen Umgebungsvariablen AWS_ENDPOINT_URL_<SERVICE> bereitgestellt wird, z. B. AWS_ENDPOINT_URL_DYNAMODB

4. Die von den AWS_USE_DUALSTACK_ENDPOINT-, AWS_USE_FIPS_ENDPOINT- und AWS_ENDPOINT_URL-Umgebungsvariablen bereitgestellten Werte.

5. Der servicespezifische Endpunktwert, der durch die Einstellung endpoint_url in einem services-Abschnitt der freigegebenen config-Datei bereitgestellt wird

6. Der Wert, der durch die Einstellung endpoint_url in einem profile der freigegebenen config-Datei bereitgestellt wird

7. use_dualstack_endpoint-, use_fips_endpoint- und endpoint_url-Einstellungen.

8. Jede Standard-Endpunkt-URL für den jeweiligen Endpunkt AWS-Service wird zuletzt verwendet. Eine Liste der Standard-Service-Endpunkte, die in den einzelnen Regionen verfügbar sind, finden Sie unter AWS -Regionen und -Endpunkte im Allgemeine Amazon Web Services-Referenz.

AWS_IGNORE_CONFIGURED_ENDPOINT_URLS

Wenn diese Option aktiviert ist, AWS CLI ignoriert sie alle benutzerdefinierten Endpunktkonfigurationen. Gültige Werte sind true und false.

Die Einstellungen für die Endpunktkonfiguration befinden sich an mehreren Stellen, z. B. in den System- oder Benutzerumgebungsvariablen, in lokalen AWS Konfigurationsdateien oder werden explizit in der Befehlszeile als Parameter deklariert. Die AWS CLI -Endpunktkonfigurationseinstellungen haben Vorrang in der folgenden Reihenfolge:

1. Die Befehlszeilenoption --endpoint-url

2. Bei aktivierter Option die globale Endpunkt-Umgebungsvariable AWS_IGNORE_CONFIGURED_ENDPOINT_URLS oder die Profileinstellung ignore_configure_endpoint_urls zum Ignorieren von benutzerdefinierten Endpunkten

3. Der Wert, der von einer servicespezifischen Umgebungsvariablen AWS_ENDPOINT_URL_<SERVICE> bereitgestellt wird, z. B. AWS_ENDPOINT_URL_DYNAMODB

4. Die von den AWS_USE_DUALSTACK_ENDPOINT-, AWS_USE_FIPS_ENDPOINT- und AWS_ENDPOINT_URL-Umgebungsvariablen bereitgestellten Werte.

5. Der servicespezifische Endpunktwert, der durch die Einstellung endpoint_url in einem services-Abschnitt der freigegebenen config-Datei bereitgestellt wird

6. Der Wert, der durch die Einstellung endpoint_url in einem profile der freigegebenen config-Datei bereitgestellt wird

7. use_dualstack_endpoint-, use_fips_endpoint- und endpoint_url-Einstellungen.

8. Jede Standard-Endpunkt-URL für den jeweiligen Endpunkt AWS-Service wird zuletzt verwendet. Eine Liste der Standard-Service-Endpunkte, die in den einzelnen Regionen verfügbar sind, finden Sie unter AWS -Regionen und -Endpunkte im Allgemeine Amazon Web Services-Referenz.

AWS_MAX_ATTEMPTS

Gibt einen Wert für die maximale Anzahl von Wiederholungsversuchen an, die der AWS CLI Wiederholungshandler verwendet, wobei der erste Aufruf auf den von Ihnen angegebenen Wert angerechnet wird. Weitere Informationen zu Wiederholversuchen finden Sie unter AWS CLI-Wiederholungen.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung max_attempts.

AWS_METADATA_SERVICE_NUM_ATTEMPTS

Beim Versuch, Anmeldeinformationen für eine Amazon EC2 EC2-Instance abzurufen, die mit einer IAM-Rolle konfiguriert wurde, wird AWS CLI versucht, Anmeldeinformationen einmal vom Instance-Metadaten-Service abzurufen, bevor der Vorgang beendet wird. Wenn Sie wissen, dass Ihr Code auf einer Amazon-EC2-Instance ausgeführt wird, können Sie diesen Wert erhöhen, damit die AWS CLI mehrere Versuche unternimmt, bevor sie aufgibt.

AWS_METADATA_SERVICE_TIMEOUT

Die Anzahl der Sekunden, bevor bei einer Verbindung zum Instance-Metadaten-Service eine Zeitüberschreitung eintritt. Wenn Sie versuchen, Anmeldeinformationen auf einer Amazon-EC2-Instance abzurufen, die mit einer IAM-Rolle konfiguriert wurden, tritt für eine Verbindung zum Instance-Metadaten-Service eine Zeitüberschreitung nach standardmäßig einer Sekunde ein. Wenn Sie wissen, dass Sie eine Amazon-EC2-Instance mit einer konfigurierten IAM-Rolle ausführen, können Sie diesen Wert bei Bedarf erhöhen.

AWS_PROFILE

Gibt den Namen des AWS CLI Profils mit den zu verwendenden Anmeldeinformationen und Optionen an. Dabei kann es sich um den Namen eines Profils handeln, das in einer credentials- oder config-Datei gespeichert ist, oder um den Wert default zur Nutzung des Standardprofils.

Ist sie definiert, überschreibt diese Umgebungsvariable das Verhalten, bei dem das Profil mit dem Namen [default] in der Konfigurationsdatei verwendet wird. Sie können diese Umgebungsvariable mithilfe des --profile-Befehlszeilenparameters überschreiben.

AWS_RETRY_MODE

Gibt an, welcher Wiederholungsmodus AWS CLI verwendet wird. Es stehen drei Wiederholungsmodi zur Verfügung: Legacy (Standard), Standard und Adaptiv. Weitere Informationen zu Wiederholversuchen finden Sie unter AWS CLI-Wiederholungen.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung retry_mode.

AWS_ROLE_ARN

Gibt den Amazon-Ressourcennamen (ARN) einer IAM-Rolle mit einem Web-Identitätsanbieter an, den Sie zur Ausführung der AWS CLI Befehle verwenden möchten.

Wird mit AWS_WEB_IDENTITY_TOKEN_FILE- und AWS_ROLE_SESSION_NAME-Umgebungsvariablen genutzt.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung role_arn. Sie können keinen Rollensitzungsnamen als Befehlszeilenparameter angeben.

Anmerkung

Diese Umgebungsvariable gilt nur für eine Übernahmerolle mit dem Web-Identitätsanbieter, sie gilt nicht für die allgemeine Konfiguration des Rollenanbieters.

Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.

AWS_ROLE_SESSION_NAME

Gibt den Namen an, der der Rollensitzung zugeordnet werden soll. Dieser Wert wird dem RoleSessionName Parameter beim AWS CLI Aufrufen der AssumeRole Operation zur Verfügung gestellt und wird Teil des angenommenen Rollenbenutzers ARN: arn:aws:sts::123456789012:assumed-role/role_name/role_session_name. Dieser Parameter ist optional. Wenn Sie diesen Wert nicht angeben, wird automatisch ein Sitzungsname generiert. Dieser Name erscheint in den AWS CloudTrail Protokollen für Einträge, die mit dieser Sitzung verknüpft sind.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung role_session_name.

Wird mit AWS_ROLE_ARN- und AWS_WEB_IDENTITY_TOKEN_FILE-Umgebungsvariablen genutzt.

Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.

Anmerkung

Diese Umgebungsvariable gilt nur für eine Übernahmerolle mit dem Web-Identitätsanbieter, sie gilt nicht für die allgemeine Konfiguration des Rollenanbieters.

AWS_SECRET_ACCESS_KEY

Gibt den geheimen Schlüssel an, der mit dem Zugriffsschlüssel verknüpft ist. Dies ist im Wesentlichen das "Passwort" für den Zugriffsschlüssel.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung aws_secret_access_key. Es ist nicht möglich, die geheime Zugriffsschlüssel-ID als Befehlszeilenoption anzugeben.

AWS_SESSION_TOKEN

Gibt den Sitzungstokenwert an, der erforderlich ist, wenn Sie temporäre Sicherheitsanmeldeinformationen verwenden, die Sie direkt aus AWS STS -Operationen abgerufen haben. Weitere Informationen finden Sie im Ausgabeabschnitt des Befehls assume-role im AWS CLI -Befehlsverweis.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung aws_session_token.

AWS_SHARED_CREDENTIALS_FILE

Gibt den Speicherort der Datei an, die zum Speichern von Zugriffsschlüsseln AWS CLI verwendet wird. Der Standardpfad ist ~/.aws/credentials.

Sie können diesen Wert nicht in einer benannten Profileinstellung oder mithilfe eines Befehlszeilenparameters angeben.

AWS_STS_REGIONAL_ENDPOINTS

Gibt an, wie der den AWS Dienstendpunkt AWS CLI bestimmt, den der AWS CLI Client für die Kommunikation mit dem AWS Security Token Service (AWS STS) verwendet. Für den Standardwert ist für AWS CLI Version 1 ist legacy.

Sie können einen von zwei Werten angeben:

• legacy— Verwendet den globalen STS-Endpunktsts.amazonaws.com,ap-northeast-1, für die folgenden AWS Regionen: ap-south-1 ap-southeast-1 ap-southeast-2aws-global,ca-central-1,eu-central-1,eu-north-1,eu-west-1,eu-west-2,eu-west-3,sa-east-1,us-east-1,us-east-2,us-west-1, undus-west-2. Für alle anderen Regionen wird automatisch deren jeweiliger regionaler Endpunkt verwendet.

• regional— Der verwendet AWS CLI immer den AWS STS Endpunkt für die aktuell konfigurierte Region. Wenn der Client beispielsweise für die Verwendung konfiguriert istus-west-2, AWS STS werden alle Aufrufe an den regionalen Endpunkt sts.us-west-2.amazonaws.com statt an den globalen sts.amazonaws.com Endpunkt getätigt. Um eine Anforderung an den globalen Endpunkt zu senden, während diese Einstellung aktiviert ist, können Sie die Region auf aws-global festlegen.

AWS_USE_DUALSTACK_ENDPOINT

Ermöglicht die Verwendung von Dual-Stack-Endpunkten zum Senden AWS von Anfragen. Weitere Informationen zu Dual-Stack-Endpunkten, die sowohl IPv4- als auch IPv6-Datenverkehr unterstützen, finden Sie unter Verwenden von Amazon-S3-Dual-Stack-Endpunkten im Benutzerhandbuch für Amazon Simple Storage Service. Dual-Stack-Endpunkte sind für einige Services in einigen Regionen verfügbar. Wenn kein Dual-Stack-Endpunkt für den Service oder existiert AWS-Region, schlägt die Anfrage fehl. Diese ist standardmäßig deaktiviert.

Die Einstellungen für die Endpunktkonfiguration befinden sich an mehreren Stellen, z. B. in den System- oder Benutzerumgebungsvariablen, in lokalen AWS Konfigurationsdateien, oder werden explizit in der Befehlszeile als Parameter deklariert. Die AWS CLI -Endpunktkonfigurationseinstellungen haben Vorrang in der folgenden Reihenfolge:

1. Die Befehlszeilenoption --endpoint-url

2. Bei aktivierter Option die globale Endpunkt-Umgebungsvariable AWS_IGNORE_CONFIGURED_ENDPOINT_URLS oder die Profileinstellung ignore_configure_endpoint_urls zum Ignorieren von benutzerdefinierten Endpunkten

3. Der Wert, der von einer servicespezifischen Umgebungsvariablen AWS_ENDPOINT_URL_<SERVICE> bereitgestellt wird, z. B. AWS_ENDPOINT_URL_DYNAMODB

4. Die von den AWS_USE_DUALSTACK_ENDPOINT-, AWS_USE_FIPS_ENDPOINT- und AWS_ENDPOINT_URL-Umgebungsvariablen bereitgestellten Werte.

5. Der servicespezifische Endpunktwert, der durch die Einstellung endpoint_url in einem services-Abschnitt der freigegebenen config-Datei bereitgestellt wird

6. Der Wert, der durch die Einstellung endpoint_url in einem profile der freigegebenen config-Datei bereitgestellt wird

7. use_dualstack_endpoint-, use_fips_endpoint- und endpoint_url-Einstellungen.

8. Jede Standard-Endpunkt-URL für den jeweiligen Endpunkt AWS-Service wird zuletzt verwendet. Eine Liste der Standard-Service-Endpunkte, die in den einzelnen Regionen verfügbar sind, finden Sie unter AWS -Regionen und -Endpunkte im Allgemeine Amazon Web Services-Referenz.

AWS_USE_FIPS_ENDPOINT

Einige AWS Dienste bieten Endgeräte, die in einigen Fällen den Federal Information Processing Standard (FIPS) 140-2 unterstützen. AWS-Regionen Wenn der AWS -Service FIPS unterstützt, gibt diese Einstellung an, welchen FIPS-Endpunkt die AWS CLI verwenden soll. Im Gegensatz zu AWS Standardendpunkten verwenden FIPS-Endpunkte eine TLS-Softwarebibliothek, die FIPS 140-2 entspricht. Diese Endpunkte können von Unternehmen erfordert werden, die mit der US-Regierung interagieren.

Wenn diese Einstellung aktiviert ist, aber kein FIPS-Endpunkt für den Dienst in Ihrem vorhanden ist, schlägt der Befehl möglicherweise fehl. AWS-Region AWS Geben Sie in diesem Fall mithilfe der --endpoint-url-Option manuell den Endpunkt an, der im Befehl verwendet werden soll, oder verwenden Sie servicespezifische Endpunkte.

Weitere Informationen zur Angabe von FIPS-Endpunkten durch finden Sie unter FIPS-Endpunkte nach AWS-Region Dienst.

Die Einstellungen für die Endpunktkonfiguration befinden sich an mehreren Stellen, z. B. in den System- oder Benutzerumgebungsvariablen, in lokalen AWS Konfigurationsdateien, oder werden explizit in der Befehlszeile als Parameter deklariert. Die AWS CLI -Endpunktkonfigurationseinstellungen haben Vorrang in der folgenden Reihenfolge:

1. Die Befehlszeilenoption --endpoint-url

2. Bei aktivierter Option die globale Endpunkt-Umgebungsvariable AWS_IGNORE_CONFIGURED_ENDPOINT_URLS oder die Profileinstellung ignore_configure_endpoint_urls zum Ignorieren von benutzerdefinierten Endpunkten

3. Der Wert, der von einer servicespezifischen Umgebungsvariablen AWS_ENDPOINT_URL_<SERVICE> bereitgestellt wird, z. B. AWS_ENDPOINT_URL_DYNAMODB

4. Die von den AWS_USE_DUALSTACK_ENDPOINT-, AWS_USE_FIPS_ENDPOINT- und AWS_ENDPOINT_URL-Umgebungsvariablen bereitgestellten Werte.

5. Der servicespezifische Endpunktwert, der durch die Einstellung endpoint_url in einem services-Abschnitt der freigegebenen config-Datei bereitgestellt wird

6. Der Wert, der durch die Einstellung endpoint_url in einem profile der freigegebenen config-Datei bereitgestellt wird

7. use_dualstack_endpoint-, use_fips_endpoint- und endpoint_url-Einstellungen.

8. Jede Standard-Endpunkt-URL für den jeweiligen Endpunkt AWS-Service wird zuletzt verwendet. Eine Liste der Standard-Service-Endpunkte, die in den einzelnen Regionen verfügbar sind, finden Sie unter AWS -Regionen und -Endpunkte im Allgemeine Amazon Web Services-Referenz.

AWS_WEB_IDENTITY_TOKEN_FILE

Gibt den Pfad zu einer Datei an, die ein OAuth 2.0-Zugriffstoken oder OpenID Connect ID-Token enthält, das von einem Identitätsanbieter bereitgestellt wird. Die AWS CLI lädt den Inhalt dieser Datei und übergibt ihn als WebIdentityToken-Argument an die Operation AssumeRoleWithWebIdentity.

Wird mit AWS_ROLE_ARN- und AWS_ROLE_SESSION_NAME-Umgebungsvariablen genutzt.

Wenn diese Umgebungsvariable definiert ist, überschreibt sie den Wert der Profileinstellung web_identity_token_file.

Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.

Anmerkung

Diese Umgebungsvariable gilt nur für eine Übernahmerolle mit dem Web-Identitätsanbieter, sie gilt nicht für die allgemeine Konfiguration des Rollenanbieters.