Prasyarat Langkah 1: Membuat file alias Langkah 2: Membuat alias Langkah 3: Memanggil alias Contoh repositori alias Sumber daya

Buat dan gunakan pintasan AWS CLI perintah yang disebut alias

Alias adalah pintasan yang dapat Anda buat di AWS Command Line Interface (AWS CLI) untuk mempersingkat perintah atau skrip yang sering Anda gunakan. Anda membuat alias dalam alias file yang terletak di folder konfigurasi Anda.

Prasyarat

Untuk menggunakan perintah alias, Anda harus menyelesaikan yang berikut ini:

Instal dan konfigurasikan AWS CLI. Untuk informasi selengkapnya, lihat Instal atau perbarui ke versi terbaru AWS CLI dan Otentikasi dan akses kredensional.
Gunakan AWS CLI versi minimum 1.11.24 atau 2.0.0.
(Opsional) Untuk menggunakan skrip AWS CLI alias bash, Anda harus menggunakan terminal yang kompatibel dengan bash.

Langkah 1: Membuat file alias

Untuk membuat alias file, Anda dapat menggunakan navigasi file dan editor teks, atau menggunakan terminal pilihan Anda dengan menggunakan step-by-step prosedur. Untuk membuat file alias Anda dengan cepat, gunakan blok perintah berikut.

Untuk membuat file alias

Buat folder bernama cli di folder AWS CLI konfigurasi Anda. Secara default folder konfigurasi ada ~/.aws/ di Linux atau macOS dan %USERPROFILE%\.aws\ di Windows. Anda dapat membuat ini melalui navigasi file Anda atau dengan menggunakan perintah berikut.
Linux and macOS
```
$ mkdir -p ~/.aws/cli
```
Windows
```
C:\> md %USERPROFILE%\.aws\cli
```
Jalur default cli folder yang dihasilkan ada ~/.aws/cli/ di Linux atau macOS dan %USERPROFILE%\.aws\cli di Windows.
Di cli folder, buat file teks bernama alias tanpa ekstensi dan tambahkan [toplevel] ke baris pertama. Anda dapat membuat file ini melalui editor teks pilihan Anda atau menggunakan perintah berikut.
Linux and macOS
```
$ echo '[toplevel]' > ~/.aws/cli/alias
```
Windows
```
C:\> echo [toplevel] > %USERPROFILE%/.aws/cli/alias
```

Langkah 2: Membuat alias

Anda dapat membuat alias menggunakan perintah dasar atau bash scripting.

Membuat alias perintah dasar

Anda dapat membuat alias Anda dengan menambahkan perintah menggunakan sintaks berikut dalam alias file yang Anda buat pada langkah sebelumnya.

Sintaksis


aliasname = command [--options]

Bagian aliasname adalah apa yang Anda sebut alias Anda. Bagian command adalah perintah yang ingin Anda panggil, yang dapat menyertakan alias lainnya. Anda dapat menyertakan opsi atau parameter dalam alias Anda, atau menambahkannya saat memanggil alias Anda.

Contoh berikut membuat alias bernama aws whoami menggunakan perintah. Karena alias ini memanggil AWS CLI perintah yang ada, Anda dapat menulis perintah tanpa aws awalan.


whoami = sts get-caller-identity

Contoh berikut mengambil whoami contoh sebelumnya dan menambahkan output opsi Account filter dan teks.


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

Membuat alias sub-perintah

catatan

Fitur alias sub-perintah memerlukan AWS CLI versi minimum 1.11.24 atau 2.0.0

Anda dapat membuat alias untuk sub-perintah dengan menambahkan perintah menggunakan sintaks berikut dalam alias file yang Anda buat pada langkah sebelumnya.

Sintaksis


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

Bagian commandGroup adalah namespace perintah, misalnya Perintah aws ec2 describe-regions berada di bawah grup ec2 perintah. Bagian aliasname adalah apa yang Anda sebut alias Anda. Bagian command adalah perintah yang ingin Anda panggil, yang dapat menyertakan alias lainnya. Anda dapat menyertakan opsi atau parameter dalam alias Anda, atau menambahkannya saat memanggil alias Anda.

Contoh berikut membuat alias bernama aws ec2 regions menggunakan perintah. Karena alias ini memanggil AWS CLI perintah yang ada di bawah namespace ec2 perintah, Anda dapat menulis perintah tanpa awalan. aws ec2


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

Untuk membuat alias dari perintah di luar namespace perintah, awali perintah lengkap dengan tanda seru. Contoh berikut membuat alias bernama aws ec2 instance-profiles menggunakan perintah.


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

catatan

Alias hanya menggunakan ruang nama perintah yang ada dan Anda tidak dapat membuat yang baru. misalnya Anda tidak dapat membuat alias dengan [command johnsmith] bagian karena namespace johnsmith perintah belum ada.

Membuat alias skrip bash

Awas

Untuk menggunakan skrip AWS CLI alias bash, Anda harus menggunakan terminal yang kompatibel dengan bash

Anda dapat membuat alias menggunakan skrip bash untuk proses yang lebih maju menggunakan sintaks berikut.

Sintaksis


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

Bagian aliasname adalah apa yang Anda sebut alias Anda dan script content adalah skrip yang ingin Anda jalankan saat Anda memanggil alias.

Contoh berikut digunakan opendns untuk menampilkan alamat IP Anda saat ini. Karena Anda dapat menggunakan alias di alias lain, alias berikut berguna untuk mengizinkan atau mencabut akses untuk alamat IP Anda dari dalam myip alias lain.


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

Contoh skrip berikut memanggil aws myip alias sebelumnya untuk mengotorisasi alamat IP Anda untuk masuknya grup EC2 keamanan Amazon.


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

Saat Anda memanggil alias yang menggunakan skrip bash, variabel selalu diteruskan dalam urutan yang Anda masukkan. Dalam skrip bash, nama variabel tidak dipertimbangkan, hanya urutan kemunculannya. Dalam contoh textalert alias berikut, variabel untuk --message opsi adalah yang pertama dan --phone-number opsi kedua.


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

Langkah 3: Memanggil alias

Untuk menjalankan alias yang Anda buat dalam alias file Anda gunakan sintaks berikut. Anda dapat menambahkan opsi tambahan saat memanggil alias Anda.

Sintaksis


$ aws aliasname

Contoh berikut menggunakan alias aws whoami perintah.


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

Contoh berikut menggunakan aws whoami alias dengan opsi tambahan untuk hanya mengembalikan Account nomor dalam text output.


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

Contoh berikut menggunakan alias aws ec2 regions sub-perintah.


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

Memanggil alias menggunakan variabel skrip bash

Saat Anda memanggil alias yang menggunakan skrip bash, variabel dilewatkan dalam urutan yang dimasukkan. Dalam bash scripting, nama variabel tidak dipertimbangkan, hanya urutan mereka muncul. Misalnya, dalam textalert alias berikut, variabel untuk opsi --message adalah yang pertama dan --phone-number kedua.


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

Saat Anda memanggil textalert alias, Anda harus meneruskan variabel dalam urutan yang sama seperti yang dijalankan di alias. Dalam contoh berikut kita menggunakan variabel $message dan$phone. $messageVariabel dilewatkan ${1} untuk --message opsi dan $phone variabel dilewatkan ${2} untuk --phone-number opsi. Ini menghasilkan berhasil memanggil textalert alias untuk mengirim pesan.


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

Dalam contoh berikut, urutan dialihkan saat memanggil alias ke $phone dan. $message $phoneVariabel dilewatkan ${1} untuk --message opsi dan $message variabel dilewatkan ${2} untuk --phone-number opsi. Karena variabel rusak, alias melewati variabel secara tidak benar. Ini menyebabkan kesalahan karena konten $message tidak sesuai dengan persyaratan pemformatan nomor telepon untuk --phone-number opsi tersebut.


$ 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

Contoh repositori alias

Repositori AWS CLI alias di GitHubberisi contoh AWS CLI alias yang dibuat oleh tim AWS CLI pengembang dan komunitas. Anda dapat menggunakan seluruh contoh alias file atau mengambil alias individual untuk Anda gunakan sendiri.

Awas

Menjalankan perintah di bagian ini akan menghapus alias file yang ada. Untuk menghindari penimpaan file alias yang ada, ubah lokasi unduhan Anda.

Untuk menggunakan alias dari repositori

Instal Git. Untuk petunjuk penginstalan, lihat Memulai - Menginstal Git di Dokumentasi Git.
Instal jp perintah. jpPerintah ini digunakan dalam tostring alias. Untuk petunjuk penginstalan, lihat JMESPath(jp) README .md di GitHub.
Instal jq perintah. jqPerintah ini digunakan dalam tostring-with-jq alias. Untuk petunjuk penginstalan, lihat JSONprosesor (jq) aktif. GitHub
Unduh alias file dengan melakukan salah satu hal berikut:
- Jalankan perintah berikut yang mengunduh dari repositori dan menyalin alias file ke folder konfigurasi Anda.
  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
- Unduh langsung dari repositori dan simpan ke cli folder di folder AWS CLI konfigurasi Anda. Secara default folder konfigurasi ada ~/.aws/ di Linux atau macOS dan %USERPROFILE%\.aws\ di Windows.

Untuk memverifikasi alias berfungsi, jalankan alias berikut.


$ aws whoami

Ini menampilkan respons yang sama dengan aws sts get-caller-identity perintah:


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

Sumber daya

Repositori AWS CLI alias pada GitHubberisi contoh AWS CLI alias yang dibuat oleh tim AWS CLI pengembang dan kontribusi komunitas. AWS CLI
Pengumuman fitur alias dari AWS re:Invent 2016: The Effective User on. AWS CLI YouTube
aws sts get-caller-identity
aws ec2 describe-instances
aws sns publish

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Penyihir

Contoh kode