Variabel lingkungan untuk mengkonfigurasi AWS CLI

AWS CLI Mendukung variabel lingkungan berikut.

AWS_ACCESS_KEY_ID

Menentukan kunci AWS akses yang terkait dengan IAM akun.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. aws_access_key_id Anda tidak dapat menentukan ID kunci akses dengan menggunakan opsi baris perintah.

AWS_CA_BUNDLE

Menentukan jalur ke bundel sertifikat yang akan digunakan untuk validasi HTTPS sertifikat.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. ca_bundle Anda dapat mengganti variabel lingkungan ini dengan menggunakan parameter baris --ca-bundle perintah.

AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS

Jika bucket sumber dan tujuan sama saat menggunakan kustom s3 mv perintah, file sumber atau objek dapat dipindahkan ke dirinya sendiri, yang dapat mengakibatkan penghapusan file sumber atau objek Anda secara tidak sengaja. Variabel dan --validate-same-s3-paths opsi AWS_CLI_S3_MV_VALIDATE_SAME_S3_PATHS lingkungan menentukan apakah akan memvalidasi alias titik akses ARNs atau titik akses Anda di sumber atau tujuan Amazon S3 Anda. URIs

catatan

Validasi jalur untuk s3 mv membutuhkan API panggilan tambahan.

AWS_CONFIG_FILE

Menentukan lokasi file yang AWS CLI digunakan untuk menyimpan profil konfigurasi. Jalur defaultnya adalah~/.aws/config.

Anda tidak dapat menentukan nilai ini dalam setelan profil bernama atau dengan menggunakan parameter baris perintah.

AWS_DATA_PATH

Daftar direktori tambahan untuk memeriksa di luar jalur pencarian bawaan ~/.aws/models saat memuat AWS CLI data. Menyetel variabel lingkungan ini menunjukkan direktori tambahan untuk diperiksa terlebih dahulu sebelum kembali ke jalur pencarian bawaan. Beberapa entri harus dipisahkan dengan os.pathsep karakter, yang ada : di Linux atau macOS ; dan di Windows.

AWS_DEFAULT_OUTPUT

Menentukan format output untuk digunakan.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. output Anda dapat mengganti variabel lingkungan ini dengan menggunakan parameter baris --output perintah.

AWS_DEFAULT_REGION

Default region nameIni mengidentifikasi AWS Wilayah yang servernya ingin Anda kirimi permintaan Anda secara default. Ini biasanya Wilayah yang paling dekat dengan Anda, tetapi bisa berupa Wilayah mana pun. Misalnya, Anda dapat mengetik us-west-2 untuk menggunakan US West (Oregon). Ini adalah Wilayah tempat semua permintaan selanjutnya dikirim, kecuali jika Anda menentukan sebaliknya dalam perintah individual.

catatan

Anda harus menentukan AWS Region saat menggunakan AWS CLI, baik secara eksplisit atau dengan menyetel Region default. Untuk daftar Wilayah yang tersedia, lihat Wilayah dan Titik Akhir. Penunjuk Wilayah yang digunakan oleh AWS CLI adalah nama yang sama dengan yang Anda lihat di AWS Management Console URLs dan titik akhir layanan.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. region Anda dapat mengganti variabel lingkungan ini dengan menggunakan parameter baris --region perintah .

AWS_EC2_METADATA_DISABLED

Menonaktifkan penggunaan layanan metadata EC2 instans Amazon (). IMDS

Jika disetel ke true, kredensi atau konfigurasi pengguna (seperti Wilayah) tidak diminta dari. IMDS

AWS_ENDPOINT_URL

Menentukan endpoint yang digunakan untuk semua permintaan layanan.

Pengaturan konfigurasi titik akhir terletak di beberapa tempat, seperti variabel sistem atau lingkungan pengguna, file AWS konfigurasi lokal, atau secara eksplisit dideklarasikan pada baris perintah sebagai parameter. Pengaturan konfigurasi AWS CLI titik akhir diutamakan dalam urutan sebagai berikut:

1. Opsi baris --endpoint-url perintah.

2. Jika diaktifkan, variabel lingkungan endpoint AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global atau pengaturan profil ignore_configure_endpoint_urls untuk mengabaikan endpoint kustom.

3. Nilai yang diberikan oleh variabel lingkungan khusus layananAWS_ENDPOINT_URL_<SERVICE>, seperti. AWS_ENDPOINT_URL_DYNAMODB

4. Nilai yang disediakan olehAWS_USE_DUALSTACK_ENDPOINT,AWS_USE_FIPS_ENDPOINT, dan variabel AWS_ENDPOINT_URL lingkungan.

5. Nilai endpoint khusus layanan yang disediakan oleh endpoint_url pengaturan dalam services bagian file bersama. config

6. Nilai yang diberikan oleh endpoint_url pengaturan profile dalam config file bersama.

7. use_dualstack_endpoint,use_fips_endpoint, dan endpoint_url pengaturan.

8. Setiap titik akhir default URL untuk masing-masing AWS service digunakan terakhir. Untuk daftar titik akhir layanan standar yang tersedia di setiap Wilayah, lihat AWS Wilayah dan Titik Akhir di. Referensi Umum Amazon Web Services

AWS_ENDPOINT_URL_<SERVICE>

Menentukan endpoint kustom yang digunakan untuk layanan tertentu, di mana <SERVICE> diganti dengan identifier. AWS service Misalnya, Amazon DynamoDB memiliki a serviceId dari DynamoDB. Untuk layanan ini, variabel URL lingkungan endpoint adalahAWS_ENDPOINT_URL_DYNAMODB.

Untuk daftar semua variabel lingkungan khusus layanan, lihat. Daftar pengidentifikasi khusus layanan

Pengaturan konfigurasi titik akhir terletak di beberapa tempat, seperti variabel sistem atau lingkungan pengguna, file AWS konfigurasi lokal, atau secara eksplisit dideklarasikan pada baris perintah sebagai parameter. Pengaturan konfigurasi AWS CLI titik akhir diutamakan dalam urutan sebagai berikut:

1. Opsi baris --endpoint-url perintah.

2. Jika diaktifkan, variabel lingkungan endpoint AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global atau pengaturan profil ignore_configure_endpoint_urls untuk mengabaikan endpoint kustom.

3. Nilai yang diberikan oleh variabel lingkungan khusus layananAWS_ENDPOINT_URL_<SERVICE>, seperti. AWS_ENDPOINT_URL_DYNAMODB

4. Nilai yang disediakan olehAWS_USE_DUALSTACK_ENDPOINT,AWS_USE_FIPS_ENDPOINT, dan variabel AWS_ENDPOINT_URL lingkungan.

5. Nilai endpoint khusus layanan yang disediakan oleh endpoint_url pengaturan dalam services bagian file bersama. config

6. Nilai yang diberikan oleh endpoint_url pengaturan profile dalam config file bersama.

7. use_dualstack_endpoint,use_fips_endpoint, dan endpoint_url pengaturan.

8. Setiap titik akhir default URL untuk masing-masing AWS service digunakan terakhir. Untuk daftar titik akhir layanan standar yang tersedia di setiap Wilayah, lihat AWS Wilayah dan Titik Akhir di. Referensi Umum Amazon Web Services

AWS_IGNORE_CONFIGURED_ENDPOINT_URLS

Jika diaktifkan, AWS CLI mengabaikan semua konfigurasi titik akhir kustom. Nilai yang valid adalah true dan false.

Pengaturan konfigurasi titik akhir terletak di beberapa tempat, seperti variabel sistem atau lingkungan pengguna, file AWS konfigurasi lokal, atau secara eksplisit dideklarasikan pada baris perintah sebagai parameter. Pengaturan konfigurasi AWS CLI titik akhir diutamakan dalam urutan sebagai berikut:

1. Opsi baris --endpoint-url perintah.

2. Jika diaktifkan, variabel lingkungan endpoint AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global atau pengaturan profil ignore_configure_endpoint_urls untuk mengabaikan endpoint kustom.

3. Nilai yang diberikan oleh variabel lingkungan khusus layananAWS_ENDPOINT_URL_<SERVICE>, seperti. AWS_ENDPOINT_URL_DYNAMODB

4. Nilai yang disediakan olehAWS_USE_DUALSTACK_ENDPOINT,AWS_USE_FIPS_ENDPOINT, dan variabel AWS_ENDPOINT_URL lingkungan.

5. Nilai endpoint khusus layanan yang disediakan oleh endpoint_url pengaturan dalam services bagian file bersama. config

6. Nilai yang diberikan oleh endpoint_url pengaturan profile dalam config file bersama.

7. use_dualstack_endpoint,use_fips_endpoint, dan endpoint_url pengaturan.

8. Setiap titik akhir default URL untuk masing-masing AWS service digunakan terakhir. Untuk daftar titik akhir layanan standar yang tersedia di setiap Wilayah, lihat AWS Wilayah dan Titik Akhir di. Referensi Umum Amazon Web Services

AWS_MAX_ATTEMPTS

Menentukan nilai percobaan ulang maksimum yang digunakan oleh penangan AWS CLI coba lagi, di mana panggilan awal diperhitungkan terhadap nilai yang Anda berikan. Untuk informasi lebih lanjut tentang pencobaan ulang, lihat AWS CLI mencoba lagi.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. max_attempts

AWS_METADATA_SERVICE_NUM_ATTEMPTS

Saat mencoba mengambil kredensil pada EC2 instans Amazon yang telah dikonfigurasi dengan IAM peran, AWS CLI upaya untuk mengambil kredensil sekali dari layanan metadata instans sebelum berhenti. Jika Anda tahu perintah Anda akan berjalan pada EC2 instance Amazon, Anda dapat meningkatkan nilai ini untuk AWS CLI mencoba lagi beberapa kali sebelum menyerah.

AWS_METADATA_SERVICE_TIMEOUT

Jumlah detik sebelum koneksi ke layanan metadata instance harus habis. Saat mencoba mengambil kredensil pada EC2 instans Amazon yang dikonfigurasi dengan IAM peran, koneksi ke layanan metadata instans akan habis setelah 1 detik secara default. Jika Anda tahu bahwa Anda menjalankan EC2 instans Amazon dengan IAM peran yang dikonfigurasi, Anda dapat meningkatkan nilai ini jika diperlukan.

AWS_PROFILE

Menentukan nama AWS CLI profil dengan kredensi dan pilihan untuk digunakan. Ini bisa berupa nama profil yang disimpan dalam config file credentials atau, atau nilai default untuk menggunakan profil default.

Jika didefinisikan, variabel lingkungan ini mengesampingkan perilaku menggunakan profil bernama [default] dalam file konfigurasi. Anda dapat mengganti variabel lingkungan ini dengan menggunakan parameter baris --profile perintah.

AWS_RETRY_MODE

Menentukan modus AWS CLI coba lagi yang menggunakan. Ada tiga mode coba lagi yang tersedia: legacy (default), standar, dan adaptif. Untuk informasi lebih lanjut tentang pencobaan ulang, lihat AWS CLI mencoba lagi.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. retry_mode

AWS_ROLE_ARN

Menentukan Amazon Resource Name (ARN) IAM peran dengan penyedia identitas web yang ingin Anda gunakan untuk menjalankan AWS CLI perintah.

Digunakan dengan variabel AWS_WEB_IDENTITY_TOKEN_FILE dan AWS_ROLE_SESSION_NAME lingkungan.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. role_arn Anda tidak dapat menentukan nama sesi peran sebagai parameter baris perintah.

catatan

Variabel lingkungan ini hanya berlaku untuk peran yang diasumsikan dengan penyedia identitas web yang tidak berlaku untuk konfigurasi penyedia peran asumsi umum.

Untuk informasi selengkapnya tentang penggunaan identitas web, lihatAsumsikan peran dengan identitas web.

AWS_ROLE_SESSION_NAME

Menentukan nama untuk melampirkan ke sesi peran. Nilai ini diberikan ke RoleSessionName parameter ketika AWS CLI memanggil AssumeRole operasi, dan menjadi bagian dari peran yang diasumsikan penggunaARN: arn:aws:sts::123456789012:assumed-role/role_name/role_session_name. Ini adalah parameter opsional. Jika Anda tidak memberikan nilai ini, nama sesi dihasilkan secara otomatis. Nama ini muncul di AWS CloudTrail log untuk entri yang terkait dengan sesi ini.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. role_session_name

Digunakan dengan variabel AWS_ROLE_ARN dan AWS_WEB_IDENTITY_TOKEN_FILE lingkungan.

Untuk informasi selengkapnya tentang penggunaan identitas web, lihatAsumsikan peran dengan identitas web.

catatan

Variabel lingkungan ini hanya berlaku untuk peran yang diasumsikan dengan penyedia identitas web yang tidak berlaku untuk konfigurasi penyedia peran asumsi umum.

AWS_SDK_UA_APP_ID

Satu Akun AWS dapat digunakan oleh beberapa aplikasi pelanggan untuk melakukan panggilan ke AWS services. ID Aplikasi mengidentifikasi aplikasi sumber mana yang membuat serangkaian panggilan menggunakan file AWS service. AWS SDKsdan layanan tidak menggunakan atau menafsirkan nilai ini selain untuk memunculkannya kembali dalam komunikasi pelanggan. Misalnya, nilai ini dapat dimasukkan dalam email operasional untuk mengidentifikasi secara unik aplikasi mana yang terkait dengan notifikasi.

Secara default, tidak ada nilai.

ID Aplikasi adalah string dengan panjang maksimum 50 karakter. Huruf, angka, dan karakter khusus berikut diperbolehkan:

! $ % & * + - . , ^ _ ` | ~

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. sdk_ua_app_id Anda tidak dapat menentukan ID Aplikasi sebagai opsi baris perintah.

AWS_SECRET_ACCESS_KEY

Menentukan kunci rahasia yang terkait dengan kunci akses. Ini pada dasarnya adalah “kata sandi” untuk kunci akses.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. aws_secret_access_key Anda tidak dapat menentukan ID kunci akses rahasia sebagai opsi baris perintah.

AWS_SESSION_TOKEN

Menentukan nilai token sesi yang diperlukan jika Anda menggunakan kredensil keamanan sementara yang Anda ambil langsung dari operasi. AWS STS Untuk informasi selengkapnya, lihat bagian Output dari perintah assume-role di Command Reference.AWS CLI

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. aws_session_token

AWS_SHARED_CREDENTIALS_FILE

Menentukan lokasi file yang AWS CLI digunakan untuk menyimpan kunci akses. Jalur defaultnya adalah~/.aws/credentials.

Anda tidak dapat menentukan nilai ini dalam setelan profil bernama atau dengan menggunakan parameter baris perintah.

AWS_STS_REGIONAL_ENDPOINTS

Menentukan bagaimana AWS CLI menentukan endpoint AWS layanan yang digunakan AWS CLI klien untuk berbicara dengan AWS Security Token Service ()AWS STS. Nilai default untuk AWS CLI versi 1 adalahlegacy.

Anda dapat menentukan salah satu dari dua nilai:

• legacy— Menggunakan STS titik akhir global,sts.amazonaws.com, untuk AWS Wilayah berikut:ap-northeast-1,,,,ap-south-1,ap-southeast-1,ap-southeast-2,aws-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-2us-west-1, danus-west-2. Semua Wilayah lainnya secara otomatis menggunakan titik akhir Regional masing-masing.

• regional— AWS CLI Selalu menggunakan AWS STS titik akhir untuk Wilayah yang saat ini dikonfigurasi. Misalnya, jika klien dikonfigurasi untuk digunakanus-west-2, semua panggilan ke AWS STS dilakukan ke titik akhir Regional, sts.us-west-2.amazonaws.com bukan titik sts.amazonaws.com akhir global. Untuk mengirim permintaan ke titik akhir global saat pengaturan ini diaktifkan, Anda dapat menyetel Wilayah keaws-global.

AWS_USE_DUALSTACK_ENDPOINT

Mengaktifkan penggunaan titik akhir dual-stack untuk mengirim permintaan. AWS Untuk mempelajari lebih lanjut tentang titik akhir dual-stack, yang mendukung keduanya IPv4 dan IPv6 lalu lintas, lihat Menggunakan titik akhir tumpukan ganda Amazon S3 di Panduan Pengguna Layanan Penyimpanan Sederhana Amazon. Titik akhir dual-stack tersedia untuk beberapa layanan di beberapa wilayah. Jika titik akhir tumpukan ganda tidak ada untuk layanan atau Wilayah AWS, permintaan gagal. Ini dinonaktifkan secara default.

Pengaturan konfigurasi titik akhir terletak di beberapa tempat, seperti variabel sistem atau lingkungan pengguna, file AWS konfigurasi lokal, atau secara eksplisit dideklarasikan pada baris perintah sebagai parameter. Pengaturan konfigurasi AWS CLI titik akhir diutamakan dalam urutan sebagai berikut:

1. Opsi baris --endpoint-url perintah.

2. Jika diaktifkan, variabel lingkungan endpoint AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global atau pengaturan profil ignore_configure_endpoint_urls untuk mengabaikan endpoint kustom.

3. Nilai yang diberikan oleh variabel lingkungan khusus layananAWS_ENDPOINT_URL_<SERVICE>, seperti. AWS_ENDPOINT_URL_DYNAMODB

4. Nilai yang disediakan olehAWS_USE_DUALSTACK_ENDPOINT,AWS_USE_FIPS_ENDPOINT, dan variabel AWS_ENDPOINT_URL lingkungan.

5. Nilai endpoint khusus layanan yang disediakan oleh endpoint_url pengaturan dalam services bagian file bersama. config

6. Nilai yang diberikan oleh endpoint_url pengaturan profile dalam config file bersama.

7. use_dualstack_endpoint,use_fips_endpoint, dan endpoint_url pengaturan.

8. Setiap titik akhir default URL untuk masing-masing AWS service digunakan terakhir. Untuk daftar titik akhir layanan standar yang tersedia di setiap Wilayah, lihat AWS Wilayah dan Titik Akhir di. Referensi Umum Amazon Web Services

AWS_USE_FIPS_ENDPOINT

Beberapa AWS layanan menawarkan titik akhir yang mendukung Federal Information Processing Standard (FIPS) 140-2 di beberapa. Wilayah AWS Ketika AWS layanan mendukungFIPS, pengaturan ini menentukan FIPS titik akhir apa yang AWS CLI harus digunakan. Tidak seperti AWS endpoint standar, FIPS endpoint menggunakan pustaka TLS perangkat lunak yang sesuai dengan 140-2. FIPS Titik akhir ini mungkin diperlukan oleh korporasi yang berinteraksi dengan pemerintah Amerika Serikat.

Jika pengaturan ini diaktifkan, tetapi FIPS titik akhir tidak ada untuk layanan di Anda Wilayah AWS, AWS perintah mungkin gagal. Dalam hal ini, tentukan secara manual titik akhir yang akan digunakan dalam perintah menggunakan --endpoint-url opsi atau gunakan titik akhir khusus layanan.

Untuk informasi selengkapnya tentang menentukan FIPS titik akhir menurut Wilayah AWS, lihat FIPSTitik Akhir menurut Layanan.

Pengaturan konfigurasi titik akhir terletak di beberapa tempat, seperti variabel sistem atau lingkungan pengguna, file AWS konfigurasi lokal, atau secara eksplisit dideklarasikan pada baris perintah sebagai parameter. Pengaturan konfigurasi AWS CLI titik akhir diutamakan dalam urutan sebagai berikut:

1. Opsi baris --endpoint-url perintah.

2. Jika diaktifkan, variabel lingkungan endpoint AWS_IGNORE_CONFIGURED_ENDPOINT_URLS global atau pengaturan profil ignore_configure_endpoint_urls untuk mengabaikan endpoint kustom.

3. Nilai yang diberikan oleh variabel lingkungan khusus layananAWS_ENDPOINT_URL_<SERVICE>, seperti. AWS_ENDPOINT_URL_DYNAMODB

4. Nilai yang disediakan olehAWS_USE_DUALSTACK_ENDPOINT,AWS_USE_FIPS_ENDPOINT, dan variabel AWS_ENDPOINT_URL lingkungan.

5. Nilai endpoint khusus layanan yang disediakan oleh endpoint_url pengaturan dalam services bagian file bersama. config

6. Nilai yang diberikan oleh endpoint_url pengaturan profile dalam config file bersama.

7. use_dualstack_endpoint,use_fips_endpoint, dan endpoint_url pengaturan.

8. Setiap titik akhir default URL untuk masing-masing AWS service digunakan terakhir. Untuk daftar titik akhir layanan standar yang tersedia di setiap Wilayah, lihat AWS Wilayah dan Titik Akhir di. Referensi Umum Amazon Web Services

AWS_WEB_IDENTITY_TOKEN_FILE

Menentukan path ke file yang berisi token akses OAuth 2.0 atau token OpenID Connect ID yang disediakan oleh penyedia identitas. AWS CLI Memuat isi file ini dan meneruskannya sebagai WebIdentityToken argumen untuk AssumeRoleWithWebIdentity operasi.

Digunakan dengan variabel AWS_ROLE_ARN dan AWS_ROLE_SESSION_NAME lingkungan.

Jika didefinisikan, variabel lingkungan ini mengesampingkan nilai untuk pengaturan profil. web_identity_token_file

Untuk informasi selengkapnya tentang penggunaan identitas web, lihatAsumsikan peran dengan identitas web.

catatan

Variabel lingkungan ini hanya berlaku untuk peran yang diasumsikan dengan penyedia identitas web yang tidak berlaku untuk konfigurasi penyedia peran asumsi umum.