Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Einstellungen für die Konfiguration und die Anmeldeinformationsdatei in der AWS CLI
Sie können Ihre häufig verwendeten Konfigurationseinstellungen und Anmeldeinformationen in Dateien speichern, die von der AWS CLI verwaltet werden.
Die Dateien sind in profiles unterteilt. Standardmäßig AWS CLI verwendet der die Einstellungen des genannten Profilsdefault. Wenn Sie alternative Einstellungen verwenden möchten, können Sie zusätzliche Profile erstellen und referenzieren.
Sie können eine einzelne Einstellung überschreiben, indem Sie entweder eine der unterstützten Umgebungsvariablen definieren oder einen Befehlszeilenparameter verwenden. Weitere Informationen zum Vorrang der Konfigurationseinstellungen finden Sie unter Konfiguration der Einstellungen für den AWS CLI.
Anmerkung
Weitere Informationen zum Einrichten Ihrer Anmeldeinformationen finden Sie unter Authentifizierungs- und Zugangsdaten für die AWS CLI.
Themen
Formatieren der Konfigurations- und Anmeldeinformationsdateien
Die Dateien config und credentials sind in Abschnitte unterteilt. Die Abschnitte lauten profiles, sso-sessions und services. Ein Abschnitt ist eine benannte Sammlung von Einstellungen und reicht bis zur nächsten Abschnittsdefinitionszeile. Mehrere Profile und Abschnitte können in den config- und credentials-Dateien gespeichert werden.
Diese Dateien sind Klartextdateien, die folgendes Format verwenden:
-
Abschnittsnamen werden in eckige Klammern [] eingeschlossen, z. B.
[default],[profileunduser1][sso-session]. -
Alle Einträge in einem Abschnitt haben das allgemeine Format
setting_name=value. -
Zeilen können auskommentiert werden, indem die Zeile mit einem Hash-Zeichen (
#) begonnen wird.
Die Dateien config und credentials enthalten die folgenden Abschnittstypen:
Abschnittstyp: profile
Je nach Datei verwenden Profilabschnittsnamen folgendes Format:
-
Konfigurationsdatei:
[default][profileuser1] -
Anmeldeinformationsdatei:
[default][user1]Verwenden Sie beim Erstellen eines Eintrags in der
credentials-Datei nicht das Wortprofile.
Jedes Profil kann unterschiedliche Anmeldeinformationen und auch verschiedene AWS –Regionen und Ausgabeformate angeben. Fügen Sie beim Benennen des Profils in einer config-Datei das Präfixwort "profile„ ein. Dieses darf jedoch nicht in der credentials-Datei enthalten sein.
Die folgenden Beispiele zeigen eine credentials- und eine config-Datei mit zwei angegebenen Profilen, Region und Ausgabe. Die erste Datei [default] wird verwendet, wenn Sie einen AWS CLI
-Befehl ohne Profil ausführen. Die zweite Option wird verwendet, wenn Sie einen AWS CLI Befehl mit dem --profile user1 Parameter ausführen.
Weitere Informationen und zusätzliche Autorisierungs- und Anmeldeinformationsmethoden finden Sie unter Authentifizierung mit IAM-Benutzeranmeldedaten für AWS CLI.
Abschnittstyp: sso-session
Der sso-session Abschnitt der config Datei wird verwendet, um Konfigurationsvariablen für den Erwerb von SSO-Zugriffstoken zu gruppieren, die dann zum Abrufen von AWS Anmeldeinformationen verwendet werden können. Die folgenden Einstellungen werden verwendet:
-
(Erforderlich)
sso_start_url -
(Erforderlich)
sso_region
Sie definieren einen sso-session-Abschnitt und ordnen ihn einem Profil zu. sso_region und sso_start_url müssen innerhalb des sso-session-Abschnitts festgelegt werden. Normalerweise müssen sso_account_id und sso_role_name im profile-Abschnitt festgelegt werden, damit das SDK SSO-Anmeldeinformationen anfordern kann.
Im folgenden Beispiel wird das SDK für die Anforderung von SSO-Anmeldeinformationen konfiguriert und es wird eine automatische Token-Aktualisierung unterstützt:
[profiledev] sso_session =my-ssosso_account_id =111122223333sso_role_name =SampleRole[sso-sessionmy-sso] sso_region =us-east-1sso_start_url =https://my-sso-portal.awsapps.com/start
Dadurch können sso-session-Konfigurationen zudem auch in mehreren Profilen wiederverwendet werden:
[profiledev] sso_session =my-ssosso_account_id =111122223333sso_role_name =SampleRole[profileprod] sso_session =my-ssosso_account_id =111122223333sso_role_name =SampleRole2[sso-sessionmy-sso] sso_region =us-east-1sso_start_url =https://my-sso-portal.awsapps.com/start
sso_account_id und sso_role_name sind jedoch nicht für alle Szenarien der SSO-Token-Konfiguration erforderlich. Wenn Ihre Anwendung nur AWS -Services verwendet, die die Bearer-Authentifizierung unterstützen, sind herkömmliche AWS
-Anmeldeinformationen nicht erforderlich. Bei der Bearer-Authentifizierung handelt es sich um ein HTTP-Authentifizierungsschema, das Sicherheitstoken, sogenannte Bearer-Token, verwendet. In diesem Szenario sind sso_account_id und sso_role_name nicht erforderlich. Sehen Sie sich die individuelle Anleitung für Ihren AWS Dienst an, um festzustellen, ob er die Bearer-Token-Autorisierung unterstützt.
Darüber hinaus können Registrierungsbereiche als Teil von sso-session konfiguriert werden. Scope ist ein Mechanismus in OAuth 2.0, mit dem der Zugriff einer Anwendung auf das Konto eines Benutzers beschränkt werden kann. Eine Anwendung kann einen oder mehrere Bereiche anfordern und das an die Anwendung ausgegebene Zugriffstoken ist auf die gewährten Bereiche beschränkt. Diese Bereiche definieren die Berechtigungen, die für die Autorisierung für den registrierten OIDC-Client angefordert werden, und die vom Client abgerufenen Zugriffstoken. Im folgenden Beispiel wird sso_registration_scopes so festgelegt, dass der Zugriff zum Auflisten von Konten/Rollen möglich ist:
[sso-sessionmy-sso] sso_region =us-east-1sso_start_url =https://my-sso-portal.awsapps.com/startsso_registration_scopes =sso:account:access
Das Authentifizierungs-Token wird auf der Festplatte unter dem Verzeichnis ~/.aws/sso/cache mit einem Dateinamen zwischengespeichert, der auf dem Sitzungsnamen basiert.
Weitere Informationen zu diesem Konfigurationstyp finden Sie unter Konfiguration der IAM Identity Center-Authentifizierung mit dem AWS CLI.
Abschnittstyp: services
Bei services diesem Abschnitt handelt es sich um eine Gruppe von Einstellungen, mit denen benutzerdefinierte Endpunkte für AWS-Service Anfragen konfiguriert werden. Ein Profil wird dann mit einem services-Abschnitt verknüpft.
[profiledev] services =my-services
Der services-Abschnitt ist durch <SERVICE> = -Zeilen in Unterabschnitte unterteilt, wobei <SERVICE> der AWS-Service -ID-Schlüssel ist. Der AWS-Service Bezeichner basiert auf dem API-Modell, indem alle Leerzeichen serviceId durch Unterstriche ersetzt und alle Buchstaben klein geschrieben werden. Eine Liste aller Service-ID-Schlüssel, die im services-Abschnitt verwendet werden können, finden Sie unter Verwenden von Endpunkten in der AWS CLI. Auf den Service-ID-Schlüssel folgen verschachtelte Einstellungen, die jeweils in einer eigenen Zeile stehen, welche durch zwei Leerzeichen eingerückt sind.
Im folgenden Beispiel wird der Endpunkt so konfiguriert, dass er für Anfragen an den Amazon DynamoDB Dienst in dem my-services Abschnitt verwendet wird, der im Profil verwendet wird. dev Alle unmittelbar folgenden Zeilen, die eingerückt sind, sind in diesem Unterabschnitt enthalten und gelten für diesen Service.
[profiledev] services =my-services[servicesmy-services] dynamodb = endpoint_url =http://localhost:8000
Weitere Informationen zu servicespezifischen Endpunkten finden Sie unter Verwenden von Endpunkten in der AWS CLI.
Wenn Ihr Profil über rollenbasierte Anmeldeinformationen verfügt, die über einen source_profile-Parameter für die IAM-Funktion „Rolle übernehmen“ konfiguriert wurden, verwendet das SDK nur Servicekonfigurationen für das angegebene Profil. Es verwendet keine Profile mit verketteten Rollen. Verwenden Sie beispielsweise die folgende freigegebene config-Datei:
[profileA] credential_source =Ec2InstanceMetadataendpoint_url =https://profile-a-endpoint.aws/[profileB] source_profile =Arole_arn =arn:aws:iam::123456789012:role/roleBservices =profileB[servicesprofileB] ec2 = endpoint_url =https://profile-b-ec2-endpoint.aws
Wenn Sie das Profil verwenden B und in Ihrem Code Amazon anrufen EC2, wird der Endpunkt als https://profile-b-ec2-endpoint.aws aufgelöst. Wenn Ihr Code eine Anforderung für einen anderen Service stellt, folgt die Endpunktauflösung keiner benutzerdefinierten Logik. Der Endpunkt wird nicht zu dem im Profil A definierten globalen Endpunkt aufgelöst. Damit ein globaler Endpunkt für das Profil B wirksam wird, müssten Sie endpoint_url direkt im Profil B festlegen.
Wo werden Konfigurationseinstellungen gespeichert?
Der AWS CLI speichert vertrauliche Anmeldeinformationen, die Sie mit angeben, aws
configure in einer lokalen Datei mit dem Namencredentials, in einem Ordner mit dem Namen in Ihrem Home-Verzeichnis. Die weniger vertraulichen Konfigurationsoptionen, die Sie mit .awsaws configure angeben, werden in einer lokalen Datei namens config gespeichert, die sich ebenfalls im Ordner Ihres Stammverzeichnisses befindet. .aws
Speichern von Anmeldeinformationen in der Konfigurationsdatei
Sie können alle Ihre Profileinstellungen in einer einzigen Datei speichern, da sie Anmeldeinformationen aus der config Datei lesen AWS CLI können. Wenn in beiden Dateien Anmeldeinformationen für ein Profil mit demselben Namen vorhanden sind, haben die Schlüssel in der Anmeldeinformationsdatei Vorrang. Wir empfehlen, die Anmeldeinformationen in den credentials-Dateien zu speichern. Diese Dateien werden auch von den verschiedenen Software-Entwicklungskits für Sprachen verwendet (SDKs). Wenn Sie zusätzlich zu den eine SDKs der Optionen verwenden AWS CLI, überprüfen Sie, ob die Anmeldeinformationen in einer eigenen Datei gespeichert werden sollen.
Der Speicherort Ihres Stammverzeichnis hängt vom Betriebssystem ab. Die folgenden Umgebungsvariablen verweisen auf dieses: %UserProfile% in Windows und $HOME oder ~ (Tilde) in Unix-basierten Systemen. Sie können auch einen Nicht-Standard-Speicherort für die Dateien angeben, indem Sie die Umgebungsvariablen AWS_CONFIG_FILE und AWS_SHARED_CREDENTIALS_FILE auf einen anderen lokalen Pfad festlegen. Details dazu finden Sie unter Konfiguration von Umgebungsvariablen für AWS CLI.
Wenn Sie ein gemeinsam genutztes Profil verwenden, das eine AWS Identity and Access Management (IAM-) Rolle spezifiziert, wird der AWS STS AssumeRole Vorgang zum Abrufen temporärer Anmeldeinformationen AWS CLI aufgerufen. Diese Anmeldeinformationen werden dann (in ) gespeichert. Nachfolgende AWS CLI Befehle verwenden die zwischengespeicherten temporären Anmeldeinformationen, bis sie ablaufen, und an diesem Punkt AWS CLI
werden die Anmeldeinformationen automatisch aktualisiert.~/.aws/cli/cache
Verwenden von benannten Profilen
Wenn kein Profil explizit definiert ist, wird das default-Profil verwendet.
Um ein benanntes Profil zu verwenden, fügen Sie dem Befehl die Option --profile
hinzu. Das folgende Beispiel listet alle Ihre EC2 Amazon-Instances mit den im profile-nameuser1 Profil definierten Anmeldeinformationen und Einstellungen auf.
$aws ec2 describe-instances --profile user1
Wenn ein benanntes Profil für mehrere Befehle verwendet werden soll, müssen Sie das Profil nicht in jedem Befehl angeben. Legen Sie stattdessen die Umgebungsvariable AWS_PROFILE als Standardprofil fest. Sie können diese Einstellung mithilfe des --profile-Parameters außer Kraft setzen.
Festlegen und Anzeigen von Konfigurationseinstellungen mithilfe von Befehlen
Es gibt mehrere Möglichkeiten, Ihre Konfigurationseinstellungen mithilfe von Befehlen anzuzeigen und festzulegen.
aws configure-
Führen Sie diesen Befehl aus, um Ihre -Anmeldeinformationen, Ihre Region und das Ausgabeformat schnell festzulegen und anzuzeigen. Das folgende Beispiel zeigt Beispielwerte.
$aws configureAWS Access Key ID [None]:AWS Secret Access Key [None]:AKIAIOSFODNN7EXAMPLEDefault region name [None]:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEYDefault output format [None]:us-west-2json aws configure set-
Sie können alle Anmeldeinformationen oder Konfigurationseinstellungen mit
aws configure setfestlegen. Geben Sie das Profil an, das Sie mit der--profile-Einstellung anzeigen oder ändern möchten.Mit dem folgenden Befehl beispielsweise wird die
regionin dem Profil mit dem Namenintegfestgelegt.$aws configure set regionus-west-2--profileintegUm eine Einstellung zu entfernen, löschen Sie die Einstellung in Ihren
credentialsDateienconfigund in einem Texteditor manuell. aws configure get-
Sie können alle Anmeldeinformationen oder Konfigurationseinstellungen abrufen, die Sie mit
aws configure getfestgelegt haben. Geben Sie das Profil an, das Sie mit der--profile-Einstellung anzeigen oder ändern möchten.Beispielsweise wird mit dem folgenden Befehl die
region-Einstellung in dem Profil mit dem Namenintegabgerufen.$aws configure getregion--profileintegus-west-2Wenn die Ausgabe leer ist, ist die Einstellung nicht explizit festgelegt und es wird der Standardwert verwendet.
aws configure import-
Importieren Sie
CSV-Anmeldeinformationen, die von der IAM-Webkonsole generiert wurden. Dies gilt nicht für Anmeldeinformationen, die von IAM Identity Center generiert wurden. Kunden, die IAM Identity Center verwenden, sollten „aws configure sso“ verwenden. Eine CSV-Datei wird importiert, wobei der Profilname mit dem Benutzernamen übereinstimmt. Die CSV-Datei muss die folgenden Header enthalten.-
Benutzername
-
Zugriffsschlüssel-ID
-
Geheimer Zugriffsschlüssel
Anmerkung
Während der ersten Erstellung des Schlüsselpaares können Sie nach dem Schließen des Dialogfelds Download .csv file (CSV-Datei herunterladen) nicht mehr auf Ihren geheimen Zugriffsschlüssel zugreifen. Wenn Sie eine
.csv-Datei benötigen, müssen Sie selbst eine mit den erforderlichen Headern und Ihren gespeicherten Schlüsselpaarinformationen erstellen. Wenn Sie keinen Zugriff auf Ihre Schlüsselpaar-Informationen haben, müssen Sie ein neues Schlüsselpaar erstellen.$aws configure import --csvfile://credentials.csv -
aws configure list-
Um Konfigurationsdaten aufzulisten, verwenden Sie den Befehl
aws configure list. Dieser Befehl listet das Profil, den Zugriffsschlüssel, den geheimen Schlüssel und die Regionskonfigurationsinformationen auf, die für das angegebene Profil verwendet werden. Für jedes Konfigurationselement werden der Wert, der Ort, an dem der Konfigurationswert abgerufen wurde, und der Name der Konfigurationsvariablen angezeigt.Wenn Sie beispielsweise die AWS-Region in einer Umgebungsvariablen angeben, zeigt Ihnen dieser Befehl den Namen der Region, die Sie konfiguriert haben, dass dieser Wert aus einer Umgebungsvariablen stammt, und den Namen der Umgebungsvariablen.
Bei Methoden mit temporären Anmeldeinformationen wie Rollen und IAM Identity Center zeigt dieser Befehl den temporär zwischengespeicherten Zugriffsschlüssel an, und der geheime Zugriffsschlüssel wird angezeigt.
$aws configure listName Value Type Location ---- ----- ---- -------- profile <not set> None None access_key ****************ABCD shared-credentials-file secret_key ****************ABCD shared-credentials-file region us-west-2 env AWS_DEFAULT_REGION aws configure list-profiles-
Um alle Profilnamen aufzulisten, verwenden Sie den Befehl
aws configure list-profiles.$aws configure list-profilesdefault test aws configure sso-
Führen Sie diesen Befehl aus, um Ihre AWS IAM Identity Center Anmeldeinformationen, Ihre Region und Ihr Ausgabeformat schnell festzulegen und anzuzeigen. Das folgende Beispiel zeigt Beispielwerte.
$aws configure ssoSSO session name (Recommended):my-ssoSSO start URL [None]:https://my-sso-portal.awsapps.com/startSSO region [None]:us-east-1SSO registration scopes [None]:sso:account:access aws configure sso-session-
Führen Sie diesen Befehl aus, um Ihre AWS IAM Identity Center Anmeldeinformationen, Ihre Region und das Ausgabeformat im Abschnitt sso-session der Dateien und schnell festzulegen
credentialsundconfiganzuzeigen. Das folgende Beispiel zeigt Beispielwerte.$aws configure sso-sessionSSO session name:my-ssoSSO start URL [None]:https://my-sso-portal.awsapps.com/startSSO region [None]:us-east-1SSO registration scopes [None]:sso:account:access aws configure export-credentials-
Führen Sie diesen Befehl aus, um die aktuell eingestellten Anmeldeinformationen im angegebenen Format zu exportieren. Standardmäßig exportiert der Befehl die Standardanmeldedaten in dem
processFormat, einem JSON-Format, das vom Anmeldeinformationsformat AWS SDKs und Tools unterstützt wird.$aws configure export-credentials{ "Version": 1, "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }Verwenden Sie die
--formatOptionen und, um ein bestimmtes Profil und ein bestimmtes Format zu exportieren.--profileDie Formatoptionen lauten wie folgt:-
(Standard)
process‐ Das JSON-Format, das von dercredential_processKonfiguration AWS SDKs und den Tools unterstützt wird. -
env‐ Umgebungsvariablen im exportierten Shell-Format. -
env-no-export‐ Nicht exportierte Umgebungsvariablen im Shell-Format. -
powershell‐ Umgebungsvariablen im PowerShell Format. -
windows-cmd‐ Umgebungsvariablen im Windows-Befehlszeilenformat.
Das folgende Beispiel exportiert das
user1Profil in ein exportiertes Shell-Format.$aws configure export-credentials--profile user1 --format envexport AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY -
Befehlsbeispiele für das Festlegen neuer Konfigurationen und Anmeldeinformationen
Die folgenden Beispiele zeigen die Konfiguration eines Standardprofils mit Anmeldeinformationen, Region und Ausgabe, die für verschiedene Authentifizierungsmethoden angegeben sind.
Unterstützte Einstellungen in der config-Datei
Die folgenden Einstellungen werden in der config-Datei unterstützt. Es werden die Werte in dem angegebenen Profil (oder dem Standardprofil) verwendet, es sei denn, sie werden durch eine gleichnamige Umgebungsvariable oder eine gleichnamige Befehlszeilenoption überschrieben. Weitere Informationen darüber, welche Rangfolgeeinstellungen Vorrang haben, finden Sie unter Konfiguration der Einstellungen für den AWS CLI
Globale Einstellungen
-
account_id_endpoint_mode -
Gibt an, ob ein AWS kontobasierter Endpunkt IDs für Aufrufe von Supported verwendet werden soll. AWS-Services Weitere Informationen zu kontobasierten Endpunkten finden Sie unter. Kontobasierte Endpunkte
Diese Einstellung kann wie folgt festgelegt werden:
-
(Standard)
preferred— Der Endpunkt sollte die Konto-ID enthalten, falls verfügbar. -
disabled— Ein aufgelöster Endpunkt enthält keine Konto-ID. -
required— Der Endpunkt muss die Konto-ID enthalten. Wenn die Konto-ID nicht verfügbar ist, gibt das SDK einen Fehler aus.
Kann von der Umgebungsvariablen
AWS_ACCOUNT_ID_ENDPOINT_MODEüberschrieben werden. Um kontobasierte Endpunkte verwenden zu können, muss die ID in derAWS_ACCOUNT_IDUmgebungsvariablen oder -einstellung festgelegt werden.aws_account_idaccount_id_endpoint_mode =preferredRangfolge der Endpunkte
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. Der AWS CLI überprüft diese Endpunkteinstellungen in einer bestimmten Reihenfolge und verwendet die Endpunkteinstellung mit der höchsten Priorität. Eine Liste der Endpunktprioritäten finden Sie unter. Priorität der Endpunktkonfiguration und der Einstellungen
-
-
aws_access_key_id -
Gibt den AWS Zugriffsschlüssel an, der als Teil der Anmeldeinformationen zur Authentifizierung der Befehlsanforderung verwendet wird. Zwar kann dieses in der
config-Datei gespeichert werden, wir empfehlen Ihnen jedoch, es in dercredentials-Datei zu speichern.Kann von der Umgebungsvariablen
AWS_ACCESS_KEY_IDüberschrieben werden. Es ist nicht möglich, die Zugriffsschlüssel-ID als Befehlszeilenoption anzugeben.aws_access_key_id =AKIAIOSFODNN7EXAMPLE -
aws_account_id -
Gibt die AWS kontobasierte Endpunkt-ID an, die für Anrufe an den Support verwendet werden soll. AWS-Services Weitere Informationen zu kontobasierten Endpunkten finden Sie unter. Kontobasierte Endpunkte
Kann von der Umgebungsvariablen
AWS_ACCOUNT_IDüberschrieben werden. DieAWS_ACCOUNT_ID_ENDPOINT_MODEUmgebungsvariable oderaccount_id_endpoint_modeEinstellung muss aufpreferredoder gesetzt sein, um diese Einstellung verwendenrequiredzu können.aws_account_id =123456789EXAMPLERangfolge der Endpunkte
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. Der AWS CLI überprüft diese Endpunkteinstellungen in einer bestimmten Reihenfolge und verwendet die Endpunkteinstellung mit der höchsten Priorität. Eine Liste der Endpunktprioritäten finden Sie unter. Priorität der Endpunktkonfiguration und der Einstellungen
aws_secret_access_key-
Gibt den AWS geheimen Schlüssel an, der als Teil der Anmeldeinformationen zur Authentifizierung der Befehlsanforderung verwendet wird. Zwar kann dieses in der
config-Datei gespeichert werden, wir empfehlen Ihnen jedoch, es in dercredentials-Datei zu speichern.Kann von der Umgebungsvariablen
AWS_SECRET_ACCESS_KEYüberschrieben werden. Es ist nicht möglich, den geheimen Zugriffsschlüssel als Befehlszeilenoption anzugeben.aws_secret_access_key =wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY aws_session_token-
Gibt ein AWS Sitzungstoken an. Ein Sitzungs-Token ist nur erforderlich, wenn Sie manuell temporäre Anmeldeinformationen angeben. Zwar kann dieses in der
config-Datei gespeichert werden, wir empfehlen Ihnen jedoch, es in dercredentials-Datei zu speichern.Kann von der Umgebungsvariablen
AWS_SESSION_TOKENüberschrieben werden. Es ist nicht möglich, das Sitzungs-Token als Befehlszeilenoption anzugeben.aws_session_token =AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk ca_bundle-
Gibt eine CA-Zertifikat-Bundle (eine Datei mit der Erweiterung
.pem) an, die zur Überprüfung von SSL-Zertifikaten verwendet wird.Kann von der Umgebungsvariablen
AWS_CA_BUNDLEoder mit der Befehlszeilenoption--ca-bundleüberschrieben werden.ca_bundle =dev/apps/ca-certs/cabundle-2019mar05.pem cli_auto_prompt-
Aktiviert die automatische Eingabeaufforderung für AWS CLI Version 2. Es gibt zwei Einstellungen, die verwendet werden können:
-
onverwendet den vollständigen automatischen Prompt-Modus jedes Mal, wenn Sie versuchen, einenaws-Befehl auszuführen. Dazu gehört das Drücken der EINGABETASTE sowohl nach einem vollständigen Befehl als auch nach einem unvollständigen Befehl.cli_auto_prompt = on -
on-partialverwendet den partiellen automatischen Prompt-Modus. Wenn ein Befehl unvollständig ist oder aufgrund clientseitiger Validierungsfehler nicht ausgeführt werden kann, wird die automatische Eingabeaufforderung verwendet. Dieser Modus ist besonders nützlich, wenn Sie über bereits vorhandene Skripts oder Runbooks verfügen oder nur für Befehle, mit denen Sie nicht vertraut sind, automatisch aufgefordert werden möchten, anstatt bei jedem Befehl gefragt zu werden.cli_auto_prompt = on-partial
Sie können diese
aws_cli_auto_prompt-Umgebungsvariable mithilfe des--cli-auto-prompt- und--no-cli-auto-prompt-Befehlszeilenparameters überschreiben.Informationen zur automatischen Eingabeaufforderungsfunktion von AWS CLI Version 2 finden Sie unterAktivieren und Verwenden von Eingabeaufforderungen in AWS CLI.
-
cli_binary_format-
Gibt an, wie AWS CLI Version 2 binäre Eingabeparameter interpretiert. Dabei kann es sich um einen der folgenden Werte handeln:
-
base64 – Dies ist der Standardwert. Ein Eingabeparameter, der als BLOB (Binary Large Object) eingegeben wird, akzeptiert eine base64-kodierte Zeichenfolge. Um echten binären Inhalt zu übergeben, legen Sie den Inhalt in eine Datei und geben den Pfad und den Namen der Datei mit dem Präfix
fileb://als Wert des Parameters an. Um in einer Datei enthaltenen base64-kodierten Text zu übergeben, geben Sie den Pfad und den Namen der Datei mit dem Präfixfile://als Wert des Parameters an. -
raw-in-base64-out — Standard für AWS CLI Version 1. Wenn der Wert der Einstellung
raw-in-base64-outlautet, werden Dateien, auf die mit dem Präfixfile://verwiesen wird, als Text gelesen und dann versucht die AWS CLI , sie in Binärform zu codieren.
Dieser Eintrag verfügt über keine entsprechende Umgebungsvariable. Sie können den Wert in einem einzelnen Befehl mit dem Parameter
--cli-binary-format raw-in-base64-outangeben.cli_binary_format = raw-in-base64-outWenn Sie mithilfe der
fileb://Präfix-Notation auf einen Binärwert in einer Datei verweisen, erwartet The AWS CLI immer, dass die Datei unformatierte Binärinhalte enthält, und versucht nicht, den Wert zu konvertieren.Wenn Sie mithilfe der
file://Präfixnotation auf einen Binärwert in einer Datei verweisen, AWS CLI behandelt der die Datei entsprechend der aktuellencli_binary_formatEinstellung. Wenn der Wert dieser Einstellung istbase64(der Standardwert, wenn er nicht explizit festgelegt ist), AWS CLI erwartet der, dass die Datei Base64-codierten Text enthält. Wenn der Wert dieser Einstellung istraw-in-base64-out, AWS CLI erwartet der, dass die Datei binären Rohinhalt enthält. -
cli_history-
Standardmäßig deaktiviert. Diese Einstellung aktiviert den Befehlsverlauf für die AWS CLI. Nach dem Aktivieren dieser Einstellung AWS CLI zeichnet der den Verlauf der
awsBefehle auf.cli_history = enabledSie können Ihren Verlauf mit dem Befehl
aws history listauflisten und die resultierendencommand_idsim Befehlaws history showverwenden, um Details abzurufen. Weitere Informationen finden Sie unteraws historyim AWS CLI -Referenzhandbuch. cli_pager-
Gibt das für die Ausgabe verwendete Pager-Programm an. Standardmäßig gibt AWS CLI Version 2 die gesamte Ausgabe über das Standard-Pager-Programm Ihres Betriebssystems zurück.
Kann von der Umgebungsvariablen AWS_PAGER überschrieben werden.
cli_pager=less cli_timestamp_format-
Gibt das Ausgabeformat von Zeitstempelwerten an. Sie können einen der folgenden Werte angeben:
-
iso8601 — Der Standardwert für Version 2. AWS CLI Falls angegeben, AWS CLI werden alle Zeitstempel in der Ausgabe gemäß ISO 8601 neu formatiert.
Gemäß ISO 8601 formatierte Zeitstempel sehen wie die folgenden Beispiele aus. Das folgende Beispiel zeigt, wie die Uhrzeit formatiert wird, indem Datum und Uhrzeit durch ein getrennt Tund ein hinter der Uhrzeit steht.ZYYYY-MM-DDThh:mm:ssZDas folgende Beispiel zeigt einen Zeitstempel, der die vorherige Formatierung verwendet.
2024-05-08T15:16:43Z -
wire — Der Standardwert für die AWS CLI Version 1. Falls angegeben, AWS CLI werden alle Zeitstempelwerte genau so angezeigt, wie sie in der HTTP-Abfrageantwort empfangen wurden.
Für diese Einstellung gibt es keine äquivalente Umgebungsvariable oder Befehlszeilenoption. Diese Einstellung ändert keine Zeitstempeleingaben, sondern nur die Ausgabeformatierung.
cli_timestamp_format = iso8601 -
credential_process-
Gibt einen externen Befehl an, der AWS CLI ausgeführt wird, um Anmeldeinformationen für diesen Befehl zu generieren oder abzurufen. Der Befehl muss die Anmeldeinformationen in einem bestimmten Format zurückgeben. Weitere Informationen zur Verwendung dieser Einstellung finden Sie unter Beschaffung von Referenzen mit einem externen Prozess in der AWS CLI.
Zu diesem Eintrag gibt es keine entsprechende Umgebungsvariable oder Befehlszeilenoption.
credential_process =/opt/bin/awscreds-retriever --username susan credential_source-
Wird innerhalb von EC2 Amazon-Instances oder Containern verwendet, um anzugeben, wo sie Anmeldeinformationen finden AWS CLI können, die sie verwenden können, um die Rolle anzunehmen, die Sie mit dem
role_arnParameter angegeben haben. Sie könnensource_profileundcredential_sourcenicht im selben Profil angeben.Dieser Parameter kann einen von drei Werten haben:
-
Umgebung — Gibt an, dass Quellanmeldedaten aus Umgebungsvariablen abgerufen werden sollen. AWS CLI
-
Ec2 InstanceMetadata — Gibt an, dass die dem AWS CLI EC2 Instanzprofil zugeordnete IAM-Rolle zum Abrufen der Quellanmeldedaten verwendet werden soll.
-
EcsContainer— Gibt an, dass die dem AWS CLI ECS-Container zugeordnete IAM-Rolle als Quellanmeldedaten verwendet werden soll.
credential_source = Ec2InstanceMetadata -
duration_seconds-
Gibt die maximale Dauer der Rollensitzung in Sekunden an. Der Wert kann zwischen 900 Sekunden (15 Minuten) und der maximalen Sitzungsdauer für die Rolle liegen maximal 43 200). Dieser Parameter ist optional. Standardmäßig ist der Wert auf 3 600 Sekunden festgelegt.
endpoint_url-
Gibt den Endpunkt an, der für alle Serviceanforderungen verwendet wird. Wenn diese Einstellung im services-Abschnitt der
config-Datei verwendet wird, wird der Endpunkt nur für den angegebenen Service genutzt. Weitere Informationen finden Sie unter Legen Sie den globalen Endpunkt für alle fest AWS-Services.Im folgenden Beispiel wird der globale Endpunkt
http://localhost:1234und ein servicespezifischer Endpunkt namenshttp://localhost:4567für Amazon S3 verwendet.[profile dev] endpoint_url = http://localhost:1234 services = s3-specific [services s3-specific] s3 = endpoint_url = http://localhost:4567Priorität der Endpunkte
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. Der AWS CLI überprüft diese Endpunkteinstellungen in einer bestimmten Reihenfolge und verwendet die Endpunkteinstellung mit der höchsten Priorität. Eine Liste der Endpunktprioritäten finden Sie unter. Priorität der Endpunktkonfiguration und der Einstellungen
ignore_configure_endpoint_urls-
Wenn diese Option aktiviert ist, AWS CLI ignoriert sie alle in der Datei angegebenen benutzerdefinierten Endpunktkonfigurationen.
configGültige Werte sindtrueundfalse.ignore_configure_endpoint_urls = trueRangfolge der Endpunkte
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. Der AWS CLI überprüft diese Endpunkteinstellungen in einer bestimmten Reihenfolge und verwendet die Endpunkteinstellung mit der höchsten Priorität. Eine Liste der Endpunktprioritäten finden Sie unter. Priorität der Endpunktkonfiguration und der Einstellungen
external_id-
Gibt eine eindeutige Kennung an, die von Dritten verwendet wird, um eine Rolle in den Konten ihrer Kunden zu übernehmen. Dies entspricht dem Parameter
ExternalIdin der OperationAssumeRole. Dieser Parameter ist nur erforderlich, wenn die Vertrauensrichtlinie für die Rolle einen Wert fürExternalIdangibt. Weitere Informationen finden Sie im IAM-Benutzerhandbuch unter So verwenden Sie eine externe ID, wenn Sie einem Dritten Zugriff auf Ihre AWS Ressourcen gewähren. 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
max_attemptsWert angerechnet wird.Sie können diesen Wert überschreiben, indem Sie die Umgebungsvariable
AWS_MAX_ATTEMPTSverwenden.max_attempts =3 mfa_serial-
Die ID eines MFA-Geräts, das verwendet werden soll, wenn eine Rolle übernommen wird. Diese ist nur erforderlich, wenn die Vertrauensrichtlinie der übernommenen Rolle eine Bedingung enthält, für die eine MFA-Authentifizierung erforderlich ist. Der Wert kann entweder eine Seriennummer für ein Hardwaregerät (z. B.
GAHT12345678) oder ein Amazon-Ressourcenname (ARN) für ein virtuelles MFA-Gerät (z. B.arn:aws:iam::123456789012:mfa/) sein.user output-
Gibt das Standardausgabeformat für Befehle an, die mit diesem Profil angefordert wurden. Sie können alle folgenden Werte angeben:
-
yaml-stream – Die Ausgabe erfolgt im YAML
-Format und wird so auch gestreamt. Streaming ermöglicht eine schnellere Handhabung großer Datentypen. -
text – Die Ausgabe wird als mehrere Zeilen mit tabulatorgetrennten Zeichenfolgenwerten formatiert. Dies kann nützlich sein, um die Ausgabe an einen Textprozessor wie
grep,sedoderawkzu übergeben. -
table – Die Ausgabe erfolgt in Form einer Tabelle mit den Zeichen +|-, um die Zellenrahmen zu bilden. Normalerweise wird die Information in einem benutzerfreundlichen Format wiedergegeben, das viel einfacher zu lesen ist als die anderen, jedoch programmatisch nicht so nützlich ist.
Kann von der Umgebungsvariablen
AWS_DEFAULT_OUTPUToder mit der Befehlszeilenoption--outputüberschrieben werden.output =table parameter_validation-
Gibt an, ob der AWS CLI Client versucht, Parameter zu überprüfen, bevor er sie an den AWS Dienstendpunkt sendet.
-
true (wahr) – Dies ist der Standardwert. Falls angegeben, AWS CLI führt der eine lokale Überprüfung der Befehlszeilenparameter durch.
-
false — Falls angegeben, überprüft der die Befehlszeilenparameter AWS CLI nicht, bevor sie an den AWS Dienstendpunkt gesendet werden.
Zu diesem Eintrag gibt es keine entsprechende Umgebungsvariable oder Befehlszeilenoption.
parameter_validation = false -
region-
Gibt an AWS-Region , an welche Anfragen für Befehle gesendet werden sollen, die mit diesem Profil angefordert wurden.
-
Sie können einen der für den ausgewählten Service verfügbaren Regionscodes angeben, die unter AWS -Regionen und -Endpunkte in der Allgemeine Amazon Web Services-Referenz aufgeführt sind.
-
aws_globalermöglicht es Ihnen, den globalen Endpunkt für Services anzugeben, die zusätzlich zu regionalen Endpunkten wie AWS Security Token Service (AWS STS) und Amazon Simple Storage Service (Amazon S3) einen globalen Endpunkt unterstützen.
Sie können diesen Wert überschreiben, indem Sie die
AWS_REGION-Umgebungsvariable, dieAWS_DEFAULT_REGION-Umgebungsvariable oder die Befehlszeilenoption--regionverwenden.region =us-west-2 -
request_checksum_calculation-
Gibt an, wann eine Prüfsumme für Anforderungs-Payloads berechnet wird, und bietet die folgenden Optionen:
-
when_supported— (Standard) Die Prüfsumme der Anforderungs-Payload wird berechnet, wenn eine Operation entweder einen Prüfsummenalgorithmus in ihrem Servicemodell spezifiziert oder Anforderungsprüfsummen erfordert. -
when_required— Die Prüfsumme der Anforderungs-Payload wird berechnet, wenn eine Operation Anforderungsprüfsummen erfordert oder wenn ein Benutzer eine angibt, die von der modelliert wird.requestAlgorithmMemberAWS-Service
request_checksum_calculation =when_supportedDie Umgebungsvariable AWS_REQUEST_CHECKSUM_CALCULATION überschreibt diese Einstellung.
-
response_checksum_validation-
Gibt an, wann die Prüfsummenvalidierung für Antwortnutzlasten durchgeführt wird, und bietet die folgenden Optionen:
-
when_supported— (Standard) Die Prüfsummenvalidierung der Antwortnutzdaten wird durchgeführt, wenn eine Operation in ihrem Servicemodell einen Antwortalgorhythmus spezifiziert, den sie unterstützt. AWS CLI -
when_required— Die Überprüfung der Antwort-Payload-Prüfsumme wird durchgeführt, wenn eine Operation in ihrem Servicemodell einen Antwortalgorhythmus spezifiziert, den sie AWS CLI unterstützt, und Sie den modellierten in der OperationseingaberequestValidationModeMemberaufENABLEDfestlegen.
response_checksum_validation =when_supportedDie Umgebungsvariable AWS_RESPONSE_CHECKSUM_VALIDATION überschreibt diese Einstellung.
-
retry_mode-
Gibt an, welcher Wiederholungsmodus verwendet wird. AWS CLI Es sind drei Wiederholungsmodi verfügbar:
standard(Standard),legacy(Standard) und.adaptiveWeitere Informationen zu Wiederholversuchen finden Sie unter AWS CLI Wiederholungen in der AWS CLI.Sie können diesen Wert überschreiben, indem Sie die Umgebungsvariable
AWS_RETRY_MODEverwenden.retry_mode =standard role_arn-
Gibt den Amazon-Ressourcennamen (ARN) einer IAM-Rolle an, die Sie zur Ausführung der AWS CLI Befehle verwenden möchten. Sie müssen auch einen der folgenden Parameter angeben, um die Anmeldeinformationen zu identifizieren, die berechtigt sind, diese Rolle zu übernehmen:
-
source_profile
-
credential_source
role_arn = arn:aws:iam::123456789012:role/role-nameDiese Umgebungsvariable überschreibt die AWS_ROLE_ARN-Einstellung.
Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.
-
role_session_name-
Gibt den Namen an, der der Rollensitzung zugeordnet werden soll. Dieser Wert wird dem Parameter
RoleSessionNamebereitgestellt, wenn die AWS CLI die OperationAssumeRoleaufruft, und wird Teil des Benutzer-ARN der übernommenen Rolle:arn:aws:sts::Dieser Parameter ist optional. Wenn Sie diesen Wert nicht angeben, wird automatisch ein Sitzungsname generiert. Dieser Name wird in den AWS CloudTrail -Protokollen für Einträge angezeigt, die dieser Sitzung zugeordnet sind.123456789012:assumed-role/role_name/role_session_namerole_session_name =maria_garcia_roleDie Umgebungsvariable AWS_ROLE_SESSION_NAME überschreibt diese Einstellung.
Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.
services-
Gibt die Servicekonfiguration an, die für Ihr Profil verwendet werden soll.
[profiledev-s3-specific-and-global] endpoint_url =http://localhost:1234services =s3-specific[servicess3-specific] s3 = endpoint_url =http://localhost:4567Weitere Informationen zum Abschnitt
servicesfinden Sie unter Abschnittstyp: services.Die Umgebungsvariable AWS_ROLE_SESSION_NAME überschreibt diese Einstellung.
Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.
sdk_ua_app_id-
Eine einzelne AWS-Konto kann von mehreren Kundenanwendungen verwendet werden, um Anrufe zu AWS-Services tätigen. Die Anwendungs-ID identifiziert, welche Quellanwendung eine Reihe von Aufrufen mithilfe von getätigt hat AWS-Service. AWS SDKs und Dienste verwenden oder interpretieren diesen Wert nur, um ihn in der Kundenkommunikation wieder zum Vorschein zu bringen. Dieser Wert kann beispielsweise in betriebliche E-Mails aufgenommen werden, um eindeutig zu identifizieren, welche Ihrer Anwendungen mit der Benachrichtigung verknüpft ist.
Die Anwendungs-ID ist eine Zeichenfolge mit einer maximalen Länge von 50 Zeichen. Buchstaben, Zahlen und die folgenden Sonderzeichen sind zulässig:
! $ % & * + - . , ^ _ ` | ~Standardmäßig wird kein Wert zugewiesen.sdk_ua_app_id =prod1Diese Einstellung kann mit der Umgebungsvariablen AWS_SDK_UA_APP_ID überschrieben werden. Sie können diesen Wert nicht als Befehlszeilenparameter festlegen.
sigv4a_signing_region_set-
Gibt die Regionen, die beim Signieren mit SigV4a verwendet werden sollen, mithilfe einer kommagetrennten Liste an. Wenn diese Variable nicht gesetzt ist, verwendet der den Standard, der von der AWS CLI verwendet wird. AWS-Service Wenn für kein Standardwert angegeben AWS-Service ist, wird die Anforderungssignatur mit dem Wert von in allen Regionen gültig
*.sigv4a_signing_region_set =us-west-2, us-east-1Weitere Informationen zu SigV4a finden Sie unter AWS Signature Version 4 für API-Anfragen im IAM-Benutzerhandbuch
Diese Einstellung kann mit der Umgebungsvariablen AWS_SIGV4A_SIGNING_REGION_SET überschrieben werden. Sie können diesen Wert nicht als Befehlszeilenparameter festlegen.
source_profile-
Gibt ein benanntes Profil mit langfristigen Anmeldeinformationen an, die die AWS CLI verwenden kann, um eine Rolle zu übernehmen, die Sie mit dem Parameter
role_arnangegeben haben. Sie könnensource_profileundcredential_sourcenicht im selben Profil angeben.source_profile =production-profile sso_account_id-
Gibt die AWS Konto-ID an, die die IAM-Rolle mit der Berechtigung enthält, die Sie dem zugehörigen IAM Identity Center-Benutzer gewähren möchten.
Diese Einstellung verfügt nicht über eine Umgebungsvariable oder eine Befehlszeilenoption.
sso_account_id = 123456789012 sso_region-
Gibt die AWS Region an, in der sich der AWS Access Portal-Host befindet. Diese ist getrennt vom
region-Standard-CLI-Parameter und kann eine andere Region sein.Diese Einstellung verfügt nicht über eine Umgebungsvariable oder eine Befehlszeilenoption.
sso_region = us_west-2 sso_registration_scopes-
Eine durch Kommas getrennte Liste der für die
sso-sessionzu autorisierenden Bereiche. Bereiche autorisieren den Zugriff auf über IAM-Identity-Center-Bearer-Token autorisierte Endpunkte. Ein gültiger Bereich ist eine Zeichenfolge, beispielsweisesso:account:access. Diese Einstellung gilt nicht für die nicht aktualisierbare Legacy-Konfiguration.sso_registration_scopes = sso:account:access sso_role_name-
Gibt den Anzeigenamen der IAM-Rolle an, die die Berechtigungen des Benutzers bei der Verwendung dieses Profils definiert.
Diese Einstellung verfügt nicht über eine Umgebungsvariable oder eine Befehlszeilenoption.
sso_role_name = ReadAccess sso_start_url-
Gibt die URL an, die auf das AWS Zugriffsportal der Organisation verweist. Der AWS CLI verwendet diese URL, um eine Sitzung mit dem IAM Identity Center-Dienst einzurichten, um seine Benutzer zu authentifizieren. Verwenden Sie eine der folgenden Methoden, um die URL Ihres AWS Zugriffsportals zu ermitteln:
-
Öffnen Sie Ihre Einladungs-E-Mail. Die URL des AWS Zugriffsportals ist aufgeführt.
-
Öffnen Sie die AWS IAM Identity Center Konsole unter https://console.aws.amazon.com/singlesignon/
. Die URL des AWS Zugriffsportals ist in Ihren Einstellungen aufgeführt.
Diese Einstellung verfügt nicht über eine Umgebungsvariable oder eine Befehlszeilenoption.
sso_start_url =https://my-sso-portal.awsapps.com/start -
use_dualstack_endpoint-
Ermöglicht die Verwendung von Dual-Stack-Endpunkten zum Senden AWS von Anfragen. Weitere Informationen zu Dual-Stack-Endpunkten, die IPv4 sowohl IPv6 Datenverkehr als auch unterstützen, finden Sie unter Verwenden von Amazon S3 S3-Dual-Stack-Endpunkten im Amazon Simple Storage Service-Benutzerhandbuch. Dual-Stack-Endpunkte sind für einige Services in einigen Regionen verfügbar. Wenn kein Dual-Stack-Endpunkt für den Service oder AWS-Region existiert, schlägt die Anfrage fehl. Gültige Einstellungen sind
trueundfalse. Diese ist standardmäßig deaktiviert. Weitere Informationen finden Sie unter So einstellen, dass Dual-Stack-Endpunkte für alle AWS-Services verwendet werden.Diese Einstellung und die Einstellung
use_accelerate_endpointschließen sich gegenseitig aus.Rangfolge der Endpunkte
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. Der AWS CLI überprüft diese Endpunkteinstellungen in einer bestimmten Reihenfolge und verwendet die Endpunkteinstellung mit der höchsten Priorität. Eine Liste der Endpunktprioritäten finden Sie unter. Priorität der Endpunktkonfiguration und der Einstellungen
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 Dienst FIPS unterstützt, gibt diese Einstellung an, welchen FIPS-Endpunkt verwendet werden soll. AWS CLI 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. Weitere Informationen finden Sie unter So eingestellt, dass FIPs Endpunkte für alle verwendet werden AWS-Services. 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.Rangfolge der Endpunkte
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. Der AWS CLI überprüft diese Endpunkteinstellungen in einer bestimmten Reihenfolge und verwendet die Endpunkteinstellung mit der höchsten Priorität. Eine Liste der Endpunktprioritäten finden Sie unter. Priorität der Endpunktkonfiguration und der Einstellungen
web_identity_token_file-
Gibt den Pfad zu einer Datei an, die ein OAuth 2.0-Zugriffstoken oder ein 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 OperationAssumeRoleWithWebIdentity.Diese Umgebungsvariable überschreibt die
AWS_WEB_IDENTITY_TOKEN_FILE-Einstellung.Weitere Informationen zur Verwendung von Webidentitäten finden Sie unter Übernehmen einer Rolle mit Web-Identität.
tcp_keepalive-
Gibt an, ob der AWS CLI Client TCP-Keep-Alive-Pakete verwendet.
Zu diesem Eintrag gibt es keine entsprechende Umgebungsvariable oder Befehlszeilenoption.
tcp_keepalive = false
Einstellungen für benutzerdefinierte S3-Befehle
Amazon S3 unterstützt mehrere Einstellungen, mit denen konfiguriert wird, wie Amazon AWS CLI S3-Operationen ausgeführt werden. Einige gelten für alle S3-Befehle in den s3-Namespaces und den s3api-Namespaces. Andere sind speziell für die „benutzerdefinierten“ S3-Befehle vorgesehen, die allgemeine Operationen abstrahieren und mehr als nur eine one-to-one Zuordnung zu einer API-Operation ermöglichen. Für die aws s3-Übertragungsbefehle cp, sync, mv und rm gibt es zusätzliche Einstellungen, die Sie zur Steuerung von S3-Übertragungen verwenden können.
Alle diese Optionen können durch Angabe der verschachtelten Einstellung s3 in Ihrer config-Datei konfiguriert werden. Jede Einstellung wird dann in einer eigenen Zeile eingerückt.
Anmerkung
Diese Einstellungen sind völlig optional. Die aws s3-Übertragungsbefehle müssten auch ohne Konfiguration dieser Einstellungen erfolgreich ausgeführt werden können. Die Einstellungen werden bereitgestellt, damit Sie die Leistung verbessern oder die besondere Umgebung berücksichtigen können, in der Sie diese aws
s3-Befehle ausführen.
Diese Einstellungen werden alle unter einem s3-Schlüssel der obersten Ebene in der config-Datei festgelegt, wie im folgenden Beispiel für das development-Profil dargestellt.
[profile development] s3 = max_concurrent_requests = 20 max_queue_size = 10000 multipart_threshold = 64MB multipart_chunksize = 16MB max_bandwidth = 50MB/s use_accelerate_endpoint = true addressing_style = path
Die folgenden Einstellungen gelten für alle S3-Befehle in den s3- oder s3api-Namespaces.
addressing_style-
Gibt an, welcher Adressierungsstil verwendet werden soll. Dieser Wert steuert, ob der Bucketname im Hostnamen enthalten oder Teil der URL ist. Gültige Werte sind:
path,virtualundauto. Der Standardwert istauto.Es gibt zwei Möglichkeiten, einen Amazon-S3-Endpunkt zu erstellen. Die erste wird als
virtualbezeichnet und beinhaltet den Bucket-Namen als Teil des Hostnamens. Beispiel:https://. Alternativ können Sie mit dembucketname.s3.amazonaws.com.rproxy.govskope.capath-Stil den Bucket-Namen wie einen Pfad im URI behandeln. Beispiel:https://s3.amazonaws.com/. Standardmäßig wird in der CLIbucketnameautoverwendet. Dabei wird versucht, möglichst denvirtual-Stil zu verwenden, gegebenenfalls wird jedoch auf denpath-Stil zurückgegriffen. Wenn Ihr Bucket-Name beispielsweise nicht DNS-kompatibel ist, kann er nicht Teil des Hostnamens sein und muss im Pfad enthalten sein. Bei Verwendung vonautoerkennt die CLI diese Bedingung und schaltet automatisch zumpath-Stil um. Wenn Sie den Adressierungsstil auf festlegenpath, müssen Sie sicherstellen, dass die AWS Region, in der Sie konfiguriert haben, AWS CLI mit der Region Ihres Buckets übereinstimmt. payload_signing_enabled-
Gibt an, ob Sigv4-Payloads SHA256 signiert werden sollen. Standardmäßig ist diese Einstellung bei Verwendung von HTTPS für Streaming-Uploads (
UploadPartundPutObject) deaktiviert. Standardmäßig ist die Einstellung für Streaming-Uploads (UploadPartundPutObject) auffalsegesetzt, allerdings nur, wennContentMD5vorhanden ist (wird standardmäßig generiert) und der Endpunkt HTTPS verwendet.Wenn dieser Wert auf true gesetzt ist, erhalten S3-Anfragen eine zusätzliche Inhaltsvalidierung in Form einer SHA256 Prüfsumme, die für Sie berechnet und in die Anforderungssignatur aufgenommen wird. Wenn „false” festgelegt ist, wird die Prüfsumme nicht berechnet. Eine Deaktivierung dieser Einstellung kann nützlich sein, um den durch die Prüfsummenberechnung entstandenen Leistungsaufwand zu reduzieren.
use_accelerate_endpoint-
Verwendet den Amazon-S3-Accelerate-Endpunkt für alle
s3- unds3api-Befehle. Der Standardwert ist "false". Diese Einstellung und die Einstellunguse_dualstack_endpointschließen sich gegenseitig aus.Wenn auf true gesetzt, AWS CLI leitet der alle Amazon S3 S3-Anfragen an den
S3 AccelerateEndpunkt unter weiters3-accelerate.amazonaws.com. Um diesen Endpunkt zu verwenden, müssen Sie Ihrem Bucket die Verwendung vonS3 Accelerateermöglichen. Alle Anforderungen werden unter Verwendung der virtuellen Bucket-Adressierungsformgesendet.my-bucket.s3-accelerate.amazonaws.com.rproxy.govskope.caListBuckets-,CreateBucket- undDeleteBucket-Anfragen werden nicht an den S3-Accelerate-Endpunkt gesendet, da dieser Endpunkt diese Operationen nicht unterstützt. Dieses Verhalten kann auch festgelegt werden, wenn der Parameter--endpoint-urlfür einens3- oders3api-Befehl aufhttps://s3-accelerate.amazonaws.com.rproxy.govskope.caoderhttp://s3-accelerate.amazonaws.comgesetzt ist. use_dualstack_endpoint-
Ermöglicht die Verwendung von Dual-Stack-Endpunkten zum Senden
s3von Anfragen.s3apiWeitere Informationen zu Dual-Stack-Endpunkten, die IPv4 sowohl IPv6 Datenverkehr als auch unterstützen, finden Sie unter Verwenden von Amazon S3 S3-Dual-Stack-Endpunkten im Amazon Simple Storage Service-Benutzerhandbuch. Dual-Stack-Endpunkte sind für einige Services in einigen Regionen verfügbar. Wenn kein Dual-Stack-Endpunkt für den Service oder AWS-Region existiert, schlägt die Anfrage fehl. Gültige Einstellungen sindtrueundfalse. Diese ist standardmäßig deaktiviert. Weitere Informationen finden Sie unter So einstellen, dass Dual-Stack-Endpunkte für alle AWS-Services verwendet werden.Diese Einstellung und die Einstellung
use_accelerate_endpointschließen sich gegenseitig aus.
Die folgenden Einstellungen gelten nur für Befehle im Befehlssatz für den s3-Namespace.
max_bandwidth-
Gibt die maximale Bandbreite an, die zum Hoch- und Herunterladen von Daten in und aus Amazon S3 verbraucht werden kann. Standardmäßig ist kein Grenzwert festgelegt.
Diese Einstellung begrenzt die maximale Bandbreite, die S3-Befehle zur Übertragung von Daten an und aus Amazon S3 nutzen können. Der Wert gilt nur für Uploads und Downloads, nicht für Kopien oder Löschvorgänge. Der Wert wird in Bytes pro Sekunde ausgedrückt. Der Wert kann wie folgt angegeben werden:
-
Als ganze Zahl. Bei Angabe von
1048576wird für die maximale Bandbreitennutzung beispielsweise 1 Megabyte pro Sekunde festgelegt. -
Als ganze Zahl, gefolgt von einem Suffix für die Rate. Sie können Suffixe unter Verwendung von
KB/s,MB/soderGB/sangeben. Zum Beispiel300KB/s,10MB/s.
Im Allgemeinen empfehlen wir, zunächst durch Verringerung des Werts für
max_concurrent_requestseine niedrigere Bandbreitennutzung anzugeben. Wenn der Bandbreitenverbrauch dadurch nicht angemessen auf die gewünschte Rate begrenzt werden kann, können Sie die Einstellungmax_bandwidthverwenden, um den Bandbreitenverbrauch weiter zu begrenzen. Dies liegt daran, dassmax_concurrent_requestssteuert, wie viele Threads zurzeit ausgeführt werden. Wenn Sie stattdessen zuerstmax_bandwidthsenken, es aber bei einer hohenmax_concurrent_requests-Einstellung belassen, kann dies dazu führen, dass Threads unnötig warten müssen. Dies kann zu einem übermäßigen Ressourcenverbrauch und Verbindungszeitüberschreitungen führen. -
max_concurrent_requests-
Gibt die maximale Anzahl gleichzeitiger Anforderungen an. Der Standardwert lautet 10.
Die
aws s3-Übertragungsbefehle sind Multithread-Befehle. Zu jedem Zeitpunkt können mehrere Amazon-S3-Anforderungen ausgeführt werden. Wenn Sie beispielsweise den Befehl verwenden,aws s3 cp localdir s3://bucket/ --recursiveum Dateien in einen S3-Bucket hochzuladen, AWS CLI können sie die Dateienlocaldir/file1,localdir/file2, undlocaldir/file3parallel hochladen. Die Einstellungmax_concurrent_requestsgibt die maximale Anzahl von Übertragungsoperationen an, die gleichzeitig ausgeführt werden können.Unter Umständen müssen Sie diesen Wert aus einem der folgenden Gründe ändern:
-
Verringerung dieses Werts – in einigen Umgebungen kann der Standardwert von 10 gleichzeitigen Anforderungen zu einer Überlastung des Systems führen. Die Folge können Zeitüberschreitungen bei der Verbindung oder eine herabgesetzte Reaktionsfähigkeit des Systems sein. Wenn Sie diesen Wert senken, sind die S3-Übertragungsbefehle weniger ressourcenintensiv. Der Nachteil ist jedoch, dass S3-Übertragungen länger dauern können. Eine Senkung dieses Wertes könnte erforderlich sein, wenn Sie ein Tool zur Begrenzung der Bandbreite verwenden.
-
Erhöhung dieses Werts – in einigen Fällen kann es sinnvoll sein, die Amazon-S3-Übertragungen so schnell wie möglich durchzuführen und dabei so viel Netzwerkbandbreite wie nötig zu beanspruchen. In einem solchen Fall reicht die standardmäßige Anzahl gleichzeitiger Anforderungen möglicherweise nicht aus, um die gesamte verfügbare Netzwerkbandbreite zu nutzen. Eine Erhöhung dieses Werts kann dazu führen, dass sich die Zeit für die Durchführung einer Amazon-S3-Übertragung verkürzt.
-
max_queue_size-
Gibt die maximale Anzahl von Aufgaben in der Aufgabenwarteschlange an. Der Standardwert lautet 1000.
Das verwendet AWS CLI intern ein Modell, bei dem Amazon S3 S3-Aufgaben in eine Warteschlange gestellt werden, die dann von Verbrauchern ausgeführt werden, deren Anzahl begrenzt ist durch
max_concurrent_requests. Eine Aufgabe entspricht im Allgemeinen einer einzelnen Amazon-S3-Operation. Eine mögliche Aufgabe könnte beispielsweisePutObjectTask,GetObjectTaskoderUploadPartTasksein. Die Aufgaben können der Warteschlange viel schneller hinzugefügt werden, als die Konsumenten die Aufgaben abschließen. Um ein unbegrenztes Wachstum zu vermeiden, ist die Größe der Aufgabenwarteschlange begrenzt. Diese Einstellung ändert den Wert dieser maximalen Anzahl.Im Allgemeinen müssen Sie diese Einstellung nicht ändern. Diese Einstellung entspricht auch der Anzahl der Aufgaben, von denen sie weiß, dass sie ausgeführt werden müssen. AWS CLI Das bedeutet, dass sie standardmäßig nur 1000 Aufgaben vor sich sehen AWS CLI können. Wenn dieser Wert erhöht wird, AWS CLI können sie schneller die Gesamtzahl der benötigten Aufgaben ermitteln, vorausgesetzt, dass die Warteschlangenrate schneller ist als die Geschwindigkeit, mit der die Aufgaben abgeschlossen werden. Der Nachteil besteht darin, dass für eine größere maximale Warteschlangengröße mehr Speicher benötigt wird.
multipart_chunksize-
Gibt die Blockgröße an, die für mehrteilige Übertragungen einzelner Dateien AWS CLI verwendet wird. Der Standardwert ist 8 MB und mindestens 5 MB.
Wenn eine Datei den
multipart_threshold-Wert überschreitet, teilt die AWS CLI die Datei in Blöcke dieser Größe. Dieser Wert kann mit derselben Syntax wiemultipart_thresholdangegeben werden, also entweder als ganzzahlige Bytezahl oder unter Verwendung einer Größe und eines Suffixes. multipart_threshold-
Gibt den Größenschwellenwert an, der für mehrteilige Übertragungen einzelner Dateien AWS CLI verwendet wird. Der Standardwert ist 8 MB.
Beim Hochladen, Herunterladen oder Kopieren einer Datei gehen die Amazon-S3-Befehle zu mehrteiligen Operationen über, wenn die Datei diese Größe überschreitet. Sie können diesen Wert auf zwei Arten angeben:
-
Dateigröße in Bytes. Beispiel,
1048576. -
Dateigröße mit einem Größensuffix. Sie können
KB,MB,GBoderTBverwenden. Zum Beispiel:10MB,1GBAnmerkung
S3 kann Beschränkungen für gültige Werte anwenden, die für mehrteilige Operationen verwendet werden können. Weitere Informationen finden Sie in der S3-Dokumentation zu mehrteiligen Uploads im Benutzerhandbuch zu Amazon Simple Storage Service.
-