Konfigurasi dan pengaturan file kredensi

Jalankan perintah ini untuk mengatur dan melihat kredensil, Wilayah, dan format output dengan cepat. Contoh berikut menunjukkan nilai sampel.

$ aws configure
AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE
AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Default region name [None]: us-west-2
Default output format [None]: json

Anda dapat mengatur kredensi atau pengaturan konfigurasi apa pun menggunakan. aws configure set Tentukan profil yang ingin Anda lihat atau modifikasi dengan --profile pengaturan.

Misalnya, perintah berikut menetapkan region dalam profil bernamainteg.

$ aws configure set region us-west-2 --profile integ

Untuk menghapus pengaturan, gunakan string kosong sebagai nilai, atau hapus pengaturan secara manual di credentials file Anda config dan dalam editor teks.

$ aws configure set cli_pager "" --profile integ

Anda dapat mengambil semua kredensi atau pengaturan konfigurasi yang telah Anda tetapkan. aws configure get Tentukan profil yang ingin Anda lihat atau modifikasi dengan --profile pengaturan.

Misalnya, perintah berikut mengambil region pengaturan di profil bernamainteg.

$ aws configure get region --profile integ
us-west-2

Jika output kosong, pengaturan tidak secara eksplisit diatur dan menggunakan nilai default.

Untuk membuat daftar data konfigurasi, gunakan aws configure list perintah. Perintah ini mencantumkan profil, kunci akses, kunci rahasia, dan informasi konfigurasi wilayah yang digunakan untuk profil yang ditentukan. Untuk setiap item konfigurasi, ini menunjukkan nilai, di mana nilai konfigurasi diambil, dan nama variabel konfigurasi.

Misalnya, jika Anda memberikan variabel Wilayah AWS dalam lingkungan, perintah ini menunjukkan nama wilayah yang telah Anda konfigurasi, bahwa nilai ini berasal dari variabel lingkungan, dan nama variabel lingkungan.

Untuk metode kredensi sementara seperti peran dan Pusat Identitas IAM, perintah ini menampilkan kunci akses cache sementara dan kunci akses rahasia ditampilkan.

$ aws configure list
      Name                    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

Beberapa AWS layanan mempertahankan beberapa versi API untuk mendukung kompatibilitas mundur. Secara default, AWS CLI perintah menggunakan versi API terbaru yang tersedia. Anda dapat menentukan versi API yang akan digunakan untuk profil dengan menyertakan api_versions setelan dalam config file.

Ini adalah pengaturan “bersarang” yang diikuti oleh satu atau lebih baris indentasi yang masing-masing mengidentifikasi satu AWS layanan dan versi API yang akan digunakan. Lihat dokumentasi untuk setiap layanan untuk memahami versi API mana yang tersedia.

Contoh berikut menunjukkan cara menentukan versi API untuk dua AWS layanan. Versi API ini hanya digunakan untuk perintah yang berjalan di bawah profil yang berisi pengaturan ini.

api_versions =
    ec2 = 2015-03-01
    cloudfront = 2015-09-017

Pengaturan ini tidak memiliki variabel lingkungan atau parameter baris perintah yang setara.

Menentukan kunci AWS akses yang digunakan sebagai bagian dari kredensyal untuk mengautentikasi permintaan perintah. Meskipun ini dapat disimpan dalam config file, kami sarankan Anda menyimpannya di credentials file.

Dapat diganti oleh variabel lingkungan. AWS_ACCESS_KEY_ID Anda tidak dapat menentukan ID kunci akses sebagai opsi baris perintah.

aws_access_key_id = AKIAIOSFODNN7EXAMPLE

Menentukan kunci AWS rahasia yang digunakan sebagai bagian dari kredensyal untuk mengautentikasi permintaan perintah. Meskipun ini dapat disimpan dalam config file, kami sarankan Anda menyimpannya di credentials file.

Dapat diganti oleh variabel lingkungan. AWS_SECRET_ACCESS_KEY Anda tidak dapat menentukan kunci akses rahasia sebagai opsi baris perintah.

aws_secret_access_key = wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Menentukan token AWS sesi. Token sesi hanya diperlukan jika Anda secara manual menentukan kredensil keamanan sementara. Meskipun ini dapat disimpan dalam config file, kami sarankan Anda menyimpannya di credentials file.

Dapat diganti oleh variabel lingkungan. AWS_SESSION_TOKEN Anda tidak dapat menentukan token sesi sebagai opsi baris perintah.

aws_session_token = AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4Olgk

Menentukan bundel sertifikat CA (file dengan .pem ekstensi) yang digunakan untuk memverifikasi sertifikat SSL.

Dapat diganti oleh variabel AWS_CA_BUNDLE lingkungan atau opsi --ca-bundle baris perintah.

ca_bundle = dev/apps/ca-certs/cabundle-2019mar05.pem

Menentukan apakah AWS CLI upaya untuk mengikuti link URL dalam parameter baris perintah yang dimulai dengan http:// atauhttps://. Saat diaktifkan, konten yang diambil digunakan sebagai nilai parameter, bukan URL.

Entri ini tidak memiliki variabel lingkungan yang setara atau opsi baris perintah.

cli_follow_urlparam = false

Dinonaktifkan secara default. Pengaturan ini memungkinkan riwayat perintah untuk file AWS CLI. Setelah mengaktifkan pengaturan ini, AWS CLI catatan sejarah aws perintah.

cli_history = enabled

Anda dapat membuat daftar riwayat Anda menggunakan aws history list perintah, dan menggunakan aws history show perintah yang dihasilkan command_ids untuk detailnya. Untuk informasi lebih lanjut lihat aws historydi panduan AWS CLI referensi.

Menentukan format nilai timestamp termasuk dalam output. Anda dapat menentukan salah satu dari nilai berikut:

Entri ini tidak memiliki variabel lingkungan yang setara atau opsi baris perintah.

cli_timestamp_format = iso8601

Menentukan perintah eksternal yang AWS CLI berjalan untuk menghasilkan atau mengambil kredensi otentikasi untuk digunakan untuk perintah ini. Perintah harus mengembalikan kredensi dalam format tertentu. Untuk informasi selengkapnya tentang cara menggunakan setelan ini, lihatKredensi sumber dengan proses eksternal.

Entri ini tidak memiliki variabel lingkungan yang setara atau opsi baris perintah.

credential_process = /opt/bin/awscreds-retriever --username susan

Digunakan dalam instans atau container Amazon EC2 untuk menentukan di mana kredenal AWS CLI dapat ditemukan yang akan digunakan untuk mengambil peran yang Anda tentukan dengan parameter. role_arn Anda tidak dapat menentukan keduanya source_profile dan credential_source di profil yang sama.

Parameter ini dapat memiliki salah satu dari tiga nilai:

credential_source = Ec2InstanceMetadata

Menentukan durasi maksimum sesi peran, dalam hitungan detik. Nilai dapat berkisar dari 900 detik (15 menit) hingga pengaturan durasi sesi maksimum untuk peran (yang bisa maksimal 43200). Ini adalah parameter opsional dan secara default, nilainya diatur ke 3600 detik.

Menentukan endpoint yang digunakan untuk semua permintaan layanan. Jika pengaturan ini digunakan di servicesbagian config file, maka titik akhir hanya digunakan untuk layanan yang ditentukan.

Contoh berikut menggunakan endpoint global http://localhost:1234 dan endpoint khusus layanan untuk Amazon http://localhost:4567 S3.

[profile dev]
endpoint_url = http://localhost:1234
services = s3-specific

[services s3-specific]
s3 = 
  endpoint_url = http://localhost:4567

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

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

ignore_configure_endpoint_urls = true

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

Menentukan pengenal unik yang digunakan oleh pihak ketiga untuk mengambil peran dalam akun pelanggan mereka. Ini memetakan ke ExternalId parameter dalam AssumeRole operasi. Parameter ini diperlukan hanya jika kebijakan kepercayaan untuk peran menentukan nilai untukExternalId. Untuk informasi selengkapnya, lihat Cara menggunakan ID eksternal saat memberikan akses ke AWS sumber daya Anda kepada pihak ketiga dalam Panduan Pengguna IAM.

Menentukan nilai percobaan ulang maksimum yang digunakan oleh penangan AWS CLI coba lagi, di mana panggilan awal diperhitungkan terhadap nilai yang Anda berikan. max_attempts

Anda dapat mengganti nilai ini dengan menggunakan variabel AWS_MAX_ATTEMPTS lingkungan.

max_attempts = 3

Nomor identifikasi perangkat MFA yang akan digunakan saat mengambil peran. Ini wajib hanya jika kebijakan kepercayaan dari peran yang diasumsikan mencakup kondisi yang memerlukan otentikasi MFA. Nilai dapat berupa nomor seri untuk perangkat keras (sepertiGAHT12345678) atau Amazon Resource Name (ARN) untuk perangkat MFA virtual (seperti). arn:aws:iam::123456789012:mfa/user

Menentukan format output default untuk perintah yang diminta menggunakan profil ini. Anda dapat menentukan salah satu nilai berikut:

Dapat diganti oleh variabel AWS_DEFAULT_OUTPUT lingkungan atau opsi --output baris perintah.

output = table

Menentukan apakah AWS CLI klien mencoba untuk memvalidasi parameter sebelum mengirim mereka ke endpoint AWS layanan.

Entri ini tidak memiliki variabel lingkungan yang setara atau opsi baris perintah.

parameter_validation = false

Menentukan Wilayah AWS untuk mengirim permintaan untuk perintah yang diminta menggunakan profil ini.

Anda dapat mengganti nilai ini dengan menggunakan AWS_DEFAULT_REGION lingkungan, atau opsi baris --region perintah.

region = us-west-2

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 CLImencoba lagi.

Anda dapat mengganti nilai ini dengan menggunakan variabel AWS_RETRY_MODE lingkungan.

retry_mode = standard

Menentukan Amazon Resource Name (ARN) dari peran IAM yang ingin Anda gunakan untuk menjalankan perintah. AWS CLI Anda juga harus menentukan salah satu parameter berikut untuk mengidentifikasi kredensil yang memiliki izin untuk mengambil peran ini:

role_arn = arn:aws:iam::123456789012:role/role-name

Variabel lingkungan AWS_ROLE_ARNmengesampingkan pengaturan ini.

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

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

role_session_name = maria_garcia_role

Variabel lingkungan AWS_ROLE_SESSION_NAMEmengesampingkan pengaturan ini.

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

Menentukan konfigurasi layanan yang akan digunakan untuk profil Anda.

[profile dev-s3-specific-and-global]
endpoint_url = http://localhost:1234
services = s3-specific

[services s3-specific]
s3 = 
  endpoint_url = http://localhost:4567

Untuk informasi lebih lanjut tentang services bagian ini, lihatJenis bagian: services.

Variabel lingkungan AWS_ROLE_SESSION_NAMEmengesampingkan pengaturan ini.

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

Menentukan profil bernama dengan kredensi jangka panjang yang AWS CLI dapat digunakan untuk mengambil peran yang Anda tentukan dengan parameter. role_arn Anda tidak dapat menentukan keduanya source_profile dan credential_source di profil yang sama.

source_profile = production-profile

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:

Pengaturan ini dapat ditimpa dengan menggunakan variabel AWS_STS_REGIONAL_ENDPOINTS lingkungan. Anda tidak dapat mengatur nilai ini sebagai parameter baris perintah.

Mengaktifkan penggunaan titik akhir dual-stack untuk mengirim permintaan. AWS Untuk mempelajari lebih lanjut tentang titik akhir dual-stack, yang mendukung lalu lintas IPv4 dan IPv6, 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.

Ini saling eksklusif dengan use_accelerate_endpoint pengaturan.

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

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

Jika pengaturan ini diaktifkan, tetapi titik akhir FIPS 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 titik akhir FIPS menurut Wilayah AWS, lihat Titik Akhir FIPS menurut Layanan.

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

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.

Variabel lingkungan AWS_WEB_IDENTITY_TOKEN_FILE mengesampingkan pengaturan ini.

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

Menentukan apakah AWS CLI klien menggunakan paket TCP keep-alive.

Entri ini tidak memiliki variabel lingkungan yang setara atau opsi baris perintah.

tcp_keepalive = false

Menentukan gaya pengalamatan yang akan digunakan. Ini mengontrol apakah nama bucket ada di nama host atau merupakan bagian dari URL. Nilai yang valid adalah:path,virtual, danauto. Nilai default-nya adalah auto.

Ada dua gaya membangun endpoint Amazon S3. Yang pertama dipanggil virtual dan menyertakan nama bucket sebagai bagian dari nama host. Misalnya: https://bucketname.s3.amazonaws.com. Atau, dengan path gaya, Anda memperlakukan nama bucket seolah-olah itu adalah jalur di URI; misalnya,https://s3.amazonaws.com/bucketname. Nilai default dalam CLI adalah untuk menggunakanauto, yang mencoba menggunakan virtual gaya di mana ia bisa, tetapi akan kembali ke path gaya bila diperlukan. Misalnya, jika nama bucket Anda tidak kompatibel dengan DNS, nama bucket tidak dapat menjadi bagian dari nama host dan harus berada di jalur. Denganauto, CLI akan mendeteksi kondisi ini dan secara otomatis beralih ke path gaya untuk Anda. Jika Anda menyetel gaya pengalamatanpath, Anda harus memastikan bahwa AWS Wilayah yang Anda konfigurasikan AWS CLI cocok dengan Wilayah bucket Anda.

Menentukan apakah untuk SHA256 menandatangani sigv4 payloads. Secara default, ini dinonaktifkan untuk streaming upload (UploadPartdanPutObject) saat menggunakan HTTPS. Secara default, ini diatur ke false untuk streaming upload (UploadPartdanPutObject), tetapi hanya jika ContentMD5 ada (dihasilkan secara default) dan titik akhir menggunakan HTTPS.

Jika disetel ke true, permintaan S3 menerima validasi konten tambahan dalam bentuk checksum SHA256 yang dihitung untuk Anda dan disertakan dalam tanda tangan permintaan. Jika disetel ke false, checksum tidak dihitung. Menonaktifkan ini dapat berguna untuk mengurangi overhead kinerja yang dibuat oleh perhitungan checksum.

Gunakan titik akhir Amazon S3 Accelerate untuk semua s3 dan perintah. s3api Nilai default adalah false. Ini saling eksklusif dengan use_dualstack_endpoint pengaturan.

Jika disetel ke true, akan AWS CLI mengarahkan semua permintaan Amazon S3 ke titik akhir S3 Accelerate di. s3-accelerate.amazonaws.com Untuk menggunakan endpoint ini, Anda harus mengaktifkan bucket untuk digunakanS3 Accelerate. Semua permintaan dikirim menggunakan gaya virtual pengalamatan bucket:my-bucket.s3-accelerate.amazonaws.com. SetiapListBuckets,CreateBucket, dan DeleteBucket permintaan tidak dikirim ke titik akhir S3 Accelerate karena titik akhir tersebut tidak mendukung operasi tersebut. Perilaku ini juga dapat diatur jika --endpoint-url parameter diatur ke https://s3-accelerate.amazonaws.com atau http://s3-accelerate.amazonaws.com untuk setiap s3 atau s3api perintah.

Menentukan bandwidth maksimum yang dapat dikonsumsi untuk mengunggah dan mengunduh data ke dan dari Amazon S3. Defaultnya tidak ada batas.

Ini membatasi bandwidth maksimum yang dapat digunakan perintah S3 untuk mentransfer data ke dan dari Amazon S3. Nilai ini hanya berlaku untuk unggahan dan unduhan; itu tidak berlaku untuk salinan atau penghapusan. Nilai dinyatakan sebagai byte per detik. Nilai dapat ditentukan sebagai:

Secara umum, kami menyarankan Anda terlebih dahulu mencoba menurunkan konsumsi bandwidth dengan menurunkanmax_concurrent_requests. Jika itu tidak cukup membatasi konsumsi bandwidth ke tingkat yang diinginkan, Anda dapat menggunakan max_bandwidth pengaturan untuk membatasi konsumsi bandwidth lebih lanjut. Ini karena max_concurrent_requests mengontrol berapa banyak utas yang sedang berjalan. Jika Anda lebih dulu menurunkan max_bandwidth tetapi meninggalkan max_concurrent_requests pengaturan tinggi, itu dapat mengakibatkan utas harus menunggu yang tidak perlu. Hal ini dapat menyebabkan konsumsi sumber daya berlebih dan batas waktu koneksi.

Menentukan jumlah maksimum permintaan bersamaan. Nilai default adalah 10.

Perintah aws s3 transfer multithreaded. Pada waktu tertentu, beberapa permintaan Amazon S3 dapat berjalan. Misalnya, ketika Anda menggunakan perintah aws s3 cp localdir s3://bucket/ --recursive untuk mengunggah file ke bucket S3, AWS CLI dapat mengunggah filelocaldir/file1,localdir/file2, dan localdir/file3 secara paralel. Pengaturan max_concurrent_requests menentukan jumlah maksimum operasi transfer yang dapat berjalan pada saat yang sama.

Anda mungkin perlu mengubah nilai ini karena beberapa alasan:

Menentukan jumlah maksimum tugas dalam antrian tugas. Nilai default adalah 1000.

AWS CLI Secara internal menggunakan model di mana ia mengantri tugas Amazon S3 yang kemudian dijalankan oleh konsumen yang jumlahnya dibatasi oleh. max_concurrent_requests Sebuah tugas umumnya memetakan ke satu operasi Amazon S3. Misalnya, tugas bisa berupaPutObjectTask, atau aGetObjectTask, atauUploadPartTask. Tingkat di mana tugas ditambahkan ke antrian bisa jauh lebih cepat daripada tingkat di mana konsumen menyelesaikan tugas. Untuk menghindari pertumbuhan tak terbatas, ukuran antrian tugas dibatasi ke ukuran tertentu. Pengaturan ini mengubah nilai angka maksimum itu.

Anda biasanya tidak perlu mengubah pengaturan ini. Pengaturan ini juga sesuai dengan jumlah tugas yang AWS CLI disadari perlu dijalankan. Ini berarti bahwa secara default hanya AWS CLI dapat melihat 1000 tugas di depan. Meningkatkan nilai ini berarti bahwa AWS CLI dapat lebih cepat mengetahui jumlah total tugas yang dibutuhkan, dengan asumsi bahwa tingkat antrian lebih cepat daripada tingkat penyelesaian tugas. Penggantiannya adalah max_queue_size yang lebih besar membutuhkan lebih banyak memori.

Menentukan ukuran potongan yang AWS CLI digunakan untuk transfer multipart file individual. Nilai default adalah 8 MB, dengan minimal 5 MB.

Ketika transfer file melebihimultipart_threshold, AWS CLI membagi file menjadi potongan-potongan ukuran ini. Nilai ini dapat ditentukan menggunakan sintaks yang sama sepertimultipart_threshold, baik sebagai jumlah byte sebagai integer, atau dengan menggunakan ukuran dan akhiran.

Menentukan ambang batas ukuran yang AWS CLI digunakan untuk transfer multipart file individual. Nilai default adalah 8 MB.

Saat mengunggah, mengunduh, atau menyalin file, perintah Amazon S3 beralih ke operasi multibagian jika file melebihi ukuran ini. Anda dapat menentukan nilai ini dengan salah satu dari dua cara: