Erstellen und verwenden Sie AWS CLI Befehlskürzel, die als Aliasse bezeichnet werden - AWS Command Line Interface

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

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.

Erstellen und verwenden Sie AWS CLI Befehlskürzel, die als Aliasse bezeichnet werden

Aliase sind Verknüpfungen, die Sie in der AWS Command Line Interface (AWS CLI) erstellen können, um Befehle oder Skripts zu verkürzen, die Sie häufig verwenden. Sie erstellen Aliase in der alias-Datei in Ihrem Konfigurationsordner.

Voraussetzungen

Um Alias-Befehle zu verwenden, führen Sie die folgenden Schritte aus:

Schritt 1: Erstellen der Aliasdatei

Um die alias Datei zu erstellen, können Sie Ihre Dateinavigation und einen Texteditor oder Ihr bevorzugtes Terminal verwenden, indem Sie das step-by-step Verfahren verwenden. Verwenden Sie den folgenden Befehlsblock, um schnell Ihre Aliasdatei zu erstellen.

Linux and macOS
$ mkdir -p ~/.aws/cli $ echo '[toplevel]' > ~/.aws/cli/alias
Windows
C:\> md %USERPROFILE%\.aws\cli C:\> echo [toplevel] > %USERPROFILE%/.aws/cli/alias
So erstellen Sie die Aliasdatei
  1. Erstellen Sie einen Ordner mit dem Namen cli in Ihrem AWS CLI Konfigurationsordner. Standardmäßig ist der Konfigurationsordner ~/.aws/ (Linux oder macOS) und %USERPROFILE%\.aws\ (Windows). Sie können dies über Ihre Dateinavigation oder mit dem folgenden Befehl erstellen.

    Linux and macOS
    $ mkdir -p ~/.aws/cli
    Windows
    C:\> md %USERPROFILE%\.aws\cli

    Der resultierende Standardpfad des cli-Ordners ist ~/.aws/cli/ unter Linux oder macOS und %USERPROFILE%\.aws\cli unter Windows.

  2. Erstellen Sie im cli-Ordner eine Textdatei namens alias ohne Erweiterung und fügen Sie [toplevel] in die erste Zeile ein. Sie können diese Datei über Ihren bevorzugten Texteditor erstellen oder den folgenden Befehl verwenden.

    Linux and macOS
    $ echo '[toplevel]' > ~/.aws/cli/alias
    Windows
    C:\> echo [toplevel] > %USERPROFILE%/.aws/cli/alias

Schritt 2: Erstellen eines Alias

Sie können einen Alias mithilfe von Basisbefehlen oder Bash-Skripten erstellen.

Erstellen eines Basisbefehls-Alias

Sie können Ihren Alias erstellen, indem Sie in der alias-Datei, die Sie im vorherigen Schritt erstellt haben, einen Befehl mit der folgenden Syntax hinzufügen.

Syntax

aliasname = command [--options]

Der Aliasname ist das, was Sie Ihren Alias nennen. Der Befehl ist der Befehl, den Sie aufrufen möchten, der andere Aliase enthalten kann. Sie können Optionen oder Parameter in Ihren Alias aufnehmen oder sie hinzufügen, wenn Sie Ihren Alias aufrufen.

Im folgenden Beispiel wird mit dem Befehl aws sts get-caller-identity ein Alias namens aws whoami erstellt. Da dieser Alias einen vorhandenen AWS CLI -Befehl aufruft, können Sie den Befehl ohne aws-Präfix schreiben.

whoami = sts get-caller-identity

Im folgenden Beispiel wird das vorherige whoami-Beispiel verwendet und die Account-Filter- und Textoptionen output hinzugefügt.

whoami2 = sts get-caller-identity --query Account --output text

Erstellen eines Alias für Unterbefehle

Anmerkung

Die Aliasfunktion für Unterbefehle erfordert eine AWS CLI Mindestversion von 1.11.24 oder 2.0.0

Sie können einen Alias für Unterbefehle erstellen, indem Sie in der alias-Datei, die Sie im vorherigen Schritt erstellt haben, einen Befehl mit der folgenden Syntax hinzufügen.

Syntax

[command commandGroup] aliasname = command [--options]

Bei CommandGroup handelt es sich um den Befehls-Namespace. Der Befehl aws ec2 describe-regions beispielsweise befindet sich unter der Befehlsgruppe ec2. Der Aliasname ist das, was Sie Ihren Alias nennen. Der Befehl ist der Befehl, den Sie aufrufen möchten, der andere Aliase enthalten kann. Sie können Optionen oder Parameter in Ihren Alias aufnehmen oder sie hinzufügen, wenn Sie Ihren Alias aufrufen.

Im folgenden Beispiel wird mit dem Befehl aws ec2 describe-regions ein Alias namens aws ec2 regions erstellt. Da dieser Alias einen vorhandenen AWS CLI -Befehl unter dem Befehls-Namespace ec2 aufruft, können Sie den Befehl ohne das Präfix aws ec2 schreiben.

[command ec2] regions = describe-regions --query Regions[].RegionName

Um Aliase von Befehlen außerhalb des Befehls-Namespace zu erstellen, stellen Sie dem vollständigen Befehl ein Ausrufezeichen voran. Im folgenden Beispiel wird mit dem Befehl aws iam list-instance-profiles ein Alias namens aws ec2 instance-profiles erstellt.

[command ec2] instance-profiles = !aws iam list-instance-profiles
Anmerkung

Aliase verwenden nur bestehende Befehls-Namespaces und Sie können keine neuen erstellen. Sie können beispielsweise keinen Alias mit dem Abschnitt [command johnsmith] erstellen, da der Befehls-Namespace johnsmith noch nicht vorhanden ist.

Erstellen eines Bash-Scripting-Alias

Warnung

Um AWS CLI Alias-Bash-Skripte zu verwenden, müssen Sie ein Bash-kompatibles Terminal verwenden

Sie können einen Alias mit Bash-Skripten für erweiterte Prozesse mit der folgenden Syntax erstellen.

Syntax

aliasname = !f() { script content }; f

Der Aliasname ist das, was Sie Ihren Alias nennen und Skriptinhalt ist das Skript, das Sie ausführen möchten, wenn Sie den Alias aufrufen.

Im folgenden Beispiel wird opendns verwendet, um Ihre aktuelle IP-Adresse auszugeben. Da Sie Aliase in anderen Aliasen verwenden können, ist der folgende myip-Alias nützlich, um den Zugriff für Ihre IP-Adresse aus anderen Aliasen heraus zuzulassen oder zu widerrufen.

myip = !f() { dig +short myip.opendns.com @resolver1.opendns.com }; f

Das folgende Skriptbeispiel ruft den vorherigen aws myip-Alias auf, um Ihre IP-Adresse für einen eingehenden Amazon-EC2-Sicherheitsgruppen-Eingang zu autorisieren.

authorize-my-ip = !f() { ip=$(aws myip) aws ec2 authorize-security-group-ingress --group-id ${1} --cidr $ip/32 --protocol tcp --port 22 }; f

Wenn Sie Aliase aufrufen, die Bash-Skripting verwenden, werden die Variablen immer in der Reihenfolge übergeben, in der Sie sie eingegeben haben. Beim Bash-Skripting werden die Variablennamen nicht berücksichtigt, sondern nur die Reihenfolge, in der sie erscheinen. Im folgenden textalert-Alias-Beispiel ist die Variable für die --message-Option die erste und die --phone-number-Option ist die zweite.

textalert = !f() { aws sns publish --message "${1}" --phone-number ${2} }; f

Schritt 3: Aufruf eines Alias

Verwenden Sie die folgende Syntax, um den in Ihrer alias-Datei erstellten Alias auszuführen. Sie können zusätzliche Optionen hinzufügen, wenn Sie Ihren Alias aufrufen.

Syntax

$ aws aliasname

Im folgenden Beispiel wird der Befehlsalias aws whoami verwendet.

$ aws whoami { "UserId": "A12BCD34E5FGHI6JKLM", "Account": "1234567890987", "Arn": "arn:aws:iam::1234567890987:user/userName" }

Im folgenden Beispiel wird der aws whoami-Alias mit zusätzlichen Optionen verwendet, um nur die Account-Zahl in der text-Ausgabe zurückzugeben.

$ aws whoami --query Account --output text 1234567890987

Im folgenden Beispiel wird der Unterbefehlsalias aws ec2 regions verwendet.

$ aws ec2 regions [ "ap-south-1", "eu-north-1", "eu-west-3", "eu-west-2", ...

Aufrufen eines Alias mit Bash-Skriptvariablen

Wenn Sie Aliase aufrufen, die Bash-Skripting verwenden, werden Variablen in der Reihenfolge übergeben, in der sie eingegeben werden. Beim Bash-Skripting wird der Name der Variablen nicht berücksichtigt, sondern nur die Reihenfolge, in der sie erscheinen. Im folgenden textalert-Alias beispielsweise ist die Variable für die Option --message die erste und --phone-number die zweite.

textalert = !f() { aws sns publish --message "${1}" --phone-number ${2} }; f

Wenn Sie den textalert-Alias aufrufen, müssen Sie Variablen in der gleichen Reihenfolge übergeben, in der sie im Alias ausgeführt werden. Im folgenden Beispiel verwenden wir die Variablen $message und $phone. Die $message-Variable wird als ${1} für die --message-Option und die $phone-Variable wird als ${2} für die --phone-number-Option übergeben. Dies führt zu einem erfolgreichen Aufruf des textalert-Alias, um eine Nachricht zu senden.

$ aws textalert $message $phone { "MessageId": "1ab2cd3e4-fg56-7h89-i01j-2klmn34567" }

Im folgenden Beispiel wird die Bestellung umgeschaltet, wenn Sie den Alias in $phone und $message aufrufen. Die $phone-Variable wird als ${1} für die --message-Option und die $message-Variable wird als ${2} für die --phone-number-Option übergeben. Da die Variablen nicht in Ordnung sind, übergibt der Alias die Variablen falsch. Dies führt zu einem Fehler, da der Inhalt von $message nicht den Formatierungsanforderungen für die Telefonnummer für die Option --phone-number entspricht.

$ aws textalert $phone $message usage: aws [options] <command> <subcommand> [<subcommand> ...] [parameters] To see help text, you can run: aws help aws <command> help aws <command> <subcommand> help Unknown options: text

Beispiele für das Alias-Repository

Das AWS CLI Alias-Repository auf GitHub enthält AWS CLI Aliasbeispiele, die vom AWS CLI Entwicklerteam und der Community erstellt wurden. Sie können das gesamte alias-Dateibeispiel verwenden oder einzelne Aliase für Ihren eigenen Gebrauch verwenden.

Warnung

Durch Ausführen der Befehle in diesem Abschnitt wird Ihre vorhandene alias-Datei gelöscht. Um das Überschreiben der vorhandenen Aliasdatei zu vermeiden, ändern Sie den Downloadort.

So verwenden Sie Aliase aus dem Repository
  1. Installieren Sie Git. Installationsanweisungen finden Sie unter Erste Schritte – Git installieren in der Git-Dokumentation.

  2. Installieren Sie den jp-Befehl. Der jp-Befehl wird in im tostring-Alias verwendet. Installationsanweisungen finden Sie unter JMESPath (jp) README.md auf GitHub.

  3. Installieren Sie den jq-Befehl. Der jq-Befehl wird in im tostring-with-jq-Alias verwendet. Installationsanweisungen finden Sie unter JSON-Prozessor (jq) auf GitHub.

  4. Laden Sie die alias-Datei herunter, indem Sie einen der folgenden Schritte ausführen:

    • Führen Sie die folgenden Befehle aus, die aus dem Repository heruntergeladen werden und kopieren Sie die alias-Datei in Ihren Konfigurationsordner.

      Linux and macOS
      $ git clone https://github.com/awslabs/awscli-aliases.git $ mkdir -p ~/.aws/cli $ cp awscli-aliases/alias ~/.aws/cli/alias
      Windows
      C:\> git clone https://github.com/awslabs/awscli-aliases.git C:\> md %USERPROFILE%\.aws\cli C:\> copy awscli-aliases\alias %USERPROFILE%\.aws\cli
    • Laden Sie direkt aus dem Repository herunter und speichern Sie im cli Ordner in Ihrem AWS CLI Konfigurationsordner. Standardmäßig ist der Konfigurationsordner ~/.aws/ (Linux oder macOS) und %USERPROFILE%\.aws\ (Windows).

  5. Um zu überprüfen, ob die Aliase funktionieren, führen Sie den folgenden Alias aus.

    $ aws whoami

    Dies zeigt die gleiche Antwort wie der aws sts get-caller-identity-Befehl:

    { "Account": "012345678901", "UserId": "AIUAINBADX2VEG2TC6HD6", "Arn": "arn:aws:iam::012345678901:user/myuser" }

Ressourcen