Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
AWS SDKs dan referensi pengaturan alat
SDKs menyediakan bahasa khusus APIs untuk. Layanan AWS Mereka menangani beberapa pekerjaan berat yang diperlukan untuk berhasil melakukan panggilan API, termasuk otentikasi, perilaku coba lagi, dan banyak lagi. Untuk melakukan ini, SDKs memiliki strategi yang fleksibel untuk mendapatkan kredensional untuk digunakan untuk permintaan Anda, untuk mempertahankan pengaturan untuk digunakan dengan setiap layanan, dan untuk mendapatkan nilai yang akan digunakan untuk pengaturan global.
Anda dapat menemukan informasi terperinci tentang pengaturan konfigurasi di bagian berikut:
-
AWS SDKs dan Penyedia kredensi standar Alat— Penyedia kredensi umum distandarisasi di beberapa. SDKs
-
AWS SDKs dan fitur standar Alat— Fitur umum distandarisasi di beberapa. SDKs
Membuat klien layanan
Untuk mengakses secara terprogram Layanan AWS, SDKs gunakan kelas/objek klien untuk masing-masing. Layanan AWS Misalnya, jika aplikasi Anda perlu mengakses Amazon EC2, aplikasi Anda akan membuat objek EC2 klien Amazon untuk berinteraksi dengan layanan tersebut. Anda kemudian menggunakan klien layanan untuk membuat permintaan untuk itu Layanan AWS. Sebagian besar SDKs, objek klien layanan tidak dapat diubah, jadi Anda harus membuat klien baru untuk setiap layanan yang Anda minta dan untuk membuat permintaan ke layanan yang sama menggunakan konfigurasi yang berbeda.
Prioritas pengaturan
Pengaturan global mengonfigurasi fitur, penyedia kredensi, dan fungsionalitas lain yang didukung oleh sebagian besar SDKs dan memiliki dampak luas. Layanan AWS Semua SDKs memiliki serangkaian tempat (atau sumber) yang mereka periksa untuk menemukan nilai untuk pengaturan global. Berikut ini adalah prioritas pencarian pengaturan:
-
Pengaturan eksplisit apa pun yang disetel dalam kode atau pada klien layanan itu sendiri lebih diutamakan daripada yang lain.
-
Beberapa pengaturan dapat diatur berdasarkan per-operasi, dan dapat diubah sesuai kebutuhan untuk setiap operasi yang Anda panggil. Untuk AWS CLI atau Alat AWS untuk PowerShell, ini mengambil bentuk parameter per operasi yang Anda masukkan pada baris perintah. Untuk SDK, penetapan eksplisit dapat berupa parameter yang Anda tetapkan saat membuat instance Layanan AWS klien atau objek konfigurasi, atau terkadang saat Anda memanggil API individual.
-
-
Hanya Java/Kotlin: Properti sistem JVM untuk pengaturan dicentang. Jika disetel, nilai itu digunakan untuk mengkonfigurasi klien.
-
Variabel lingkungan diperiksa. Jika disetel, nilai itu digunakan untuk mengkonfigurasi klien.
-
SDK memeriksa
credentials
file bersama untuk pengaturan. Jika sudah diatur, klien menggunakannya. -
config
File bersama untuk pengaturan. Jika pengaturan ada, SDK menggunakannya.-
Variabel
AWS_PROFILE
lingkungan atau properti sistemaws.profile
JVM dapat digunakan untuk menentukan profil mana yang dimuat SDK.
-
-
Setiap nilai default yang disediakan oleh kode sumber SDK itu sendiri digunakan terakhir.
catatan
Beberapa SDKs dan alat mungkin memeriksa dalam urutan yang berbeda. Juga, beberapa SDKs dan alat mendukung metode lain untuk menyimpan dan mengambil parameter. Misalnya, AWS SDK for .NET mendukung sumber tambahan yang disebut SDK Store. Untuk informasi selengkapnya tentang penyedia yang unik untuk SDK atau alat, lihat panduan khusus untuk SDK atau alat yang Anda gunakan.
Urutan menentukan metode mana yang diutamakan dan mengesampingkan yang lain. Misalnya, jika Anda mengatur profil di config
file bersama, profil tersebut hanya ditemukan dan digunakan setelah SDK atau alat memeriksa tempat lain terlebih dahulu. Ini berarti bahwa jika Anda meletakkan pengaturan dalam credentials
file, itu digunakan sebagai pengganti yang ditemukan dalam config
file. Jika Anda mengonfigurasi variabel lingkungan dengan pengaturan dan nilai, itu akan menimpa pengaturan itu di config
file credentials
dan file. Dan akhirnya, pengaturan pada operasi individu (parameter AWS CLI
baris perintah atau parameter API) atau dalam kode akan mengesampingkan semua nilai lain untuk satu perintah itu.
Memahami halaman pengaturan panduan ini
Halaman-halaman dalam bagian referensi Pengaturan panduan ini merinci pengaturan yang tersedia yang dapat diatur melalui berbagai mekanisme. Tabel berikut mencantumkan pengaturan file konfigurasi dan kredensi, variabel lingkungan, dan (untuk Java dan Kotlin SDKs) setelan JVM yang dapat digunakan di luar kode Anda untuk mengonfigurasi fitur. Setiap topik tertaut di setiap daftar membawa Anda ke halaman pengaturan yang sesuai.
Setiap penyedia kredensi atau fitur memiliki halaman tempat pengaturan yang digunakan untuk mengonfigurasi fungsionalitas tersebut terdaftar. Untuk setiap pengaturan, Anda sering dapat mengatur nilai baik dengan menambahkan pengaturan ke file konfigurasi, atau dengan menyetel variabel lingkungan, atau (hanya untuk Java dan Kotlin) dengan menyetel properti sistem JVM. Setiap pengaturan mencantumkan semua metode yang didukung untuk mengatur nilai dalam blok di atas detail deskripsi. Meskipun prioritas bervariasi, fungsionalitas yang dihasilkan adalah sama terlepas dari bagaimana Anda mengaturnya.
Deskripsi akan mencakup nilai default, jika ada, yang berlaku jika Anda tidak melakukan apa-apa. Ini juga mendefinisikan apa nilai yang valid untuk pengaturan itu.
Sebagai contoh, mari kita lihat pengaturan dari halaman Minta kompresi fitur.
Informasi pengaturan disable_request_compression
contoh mendokumentasikan hal-hal berikut:
-
Ada tiga cara yang setara untuk mengontrol kompresi permintaan di luar basis kode Anda. Anda dapat:
-
Setel di file konfigurasi Anda menggunakan
disable_request_compression
-
Tetapkan sebagai variabel lingkungan menggunakan
AWS_DISABLE_REQUEST_COMPRESSION
-
Atau, jika Anda menggunakan Java atau Kotlin SDK, atur sebagai properti sistem JVM menggunakan
aws.disableRequestCompression
catatan
Mungkin juga ada cara untuk mengonfigurasi fungsionalitas yang sama secara langsung di kode Anda, tetapi Referensi ini tidak mencakup ini karena unik untuk setiap SDK. Jika Anda ingin menyetel konfigurasi dalam kode itu sendiri, lihat panduan SDK atau referensi API spesifik Anda.
-
-
Jika Anda tidak melakukan apa-apa, nilainya akan default ke
false
. -
Satu-satunya nilai yang valid untuk pengaturan Boolean ini adalah
true
danfalse
.
Di bagian bawah setiap halaman fitur terdapat tabel Support by AWS SDKs and tools.
Tabel ini menunjukkan apakah SDK Anda mendukung pengaturan yang tercantum di halaman. Supported
Kolom menunjukkan tingkat dukungan dengan nilai-nilai berikut:
-
Yes
— Pengaturan sepenuhnya didukung oleh SDK seperti yang tertulis. -
Partial
— Beberapa pengaturan didukung atau perilaku menyimpang dari deskripsi. UntukPartial
, catatan tambahan menunjukkan penyimpangan. -
No
— Tidak ada pengaturan yang didukung. Ini tidak membuat klaim apakah fungsionalitas yang sama dapat dicapai dalam kode; itu hanya menunjukkan bahwa pengaturan konfigurasi eksternal yang terdaftar tidak didukung.
Config
daftar pengaturan file
Pengaturan yang tercantum dalam tabel berikut dapat ditetapkan dalam AWS config
file bersama. Mereka global dan mempengaruhi semua Layanan AWS. SDKs dan alat juga dapat mendukung pengaturan unik dan variabel lingkungan. Untuk melihat setelan dan variabel lingkungan yang hanya didukung oleh SDK atau alat individual, lihat SDK atau panduan alat tertentu.
Credentials
daftar pengaturan file
Pengaturan yang tercantum dalam tabel berikut dapat ditetapkan dalam AWS credentials
file bersama. Mereka global dan mempengaruhi semua Layanan AWS. SDKs dan alat juga dapat mendukung pengaturan unik dan variabel lingkungan. Untuk melihat setelan dan variabel lingkungan yang hanya didukung oleh SDK atau alat individual, lihat SDK atau panduan alat tertentu.
Nama pengaturan | Detail |
---|---|
aws_access_key_id
|
AWS kunci akses |
aws_secret_access_key
|
AWS kunci akses |
aws_session_token
|
AWS kunci akses |
Daftar variabel lingkungan
Variabel lingkungan yang didukung oleh sebagian besar SDKs tercantum dalam tabel berikut. Mereka global dan mempengaruhi semua Layanan AWS. SDKs dan alat juga dapat mendukung pengaturan unik dan variabel lingkungan. Untuk melihat setelan dan variabel lingkungan yang hanya didukung oleh SDK atau alat individual, lihat SDK atau panduan alat tertentu.
Nama pengaturan | Detail |
---|---|
AWS_ACCESS_KEY_ID
|
AWS kunci akses |
AWS_ACCOUNT_ID
|
Titik akhir berbasis akun |
AWS_ACCOUNT_ID_ENDPOINT_MODE
|
Titik akhir berbasis akun |
AWS_CA_BUNDLE
|
Pengaturan konfigurasi umum |
AWS_CONFIG_FILE
|
Lokasi berbagi config dan credentials file |
AWS_CONTAINER_AUTHORIZATION_TOKEN
|
Penyedia kredensi kontainer |
AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE
|
Penyedia kredensi kontainer |
AWS_CONTAINER_CREDENTIALS_FULL_URI
|
Penyedia kredensi kontainer |
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
|
Penyedia kredensi kontainer |
AWS_DEFAULTS_MODE
|
Default konfigurasi cerdas |
AWS_DISABLE_REQUEST_COMPRESSION
|
Minta kompresi |
AWS_EC2_METADATA_DISABLED
|
Penyedia kredensi IMDS |
AWS_EC2_METADATA_SERVICE_ENDPOINT
|
Penyedia kredensi IMDS |
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE
|
Penyedia kredensi IMDS |
AWS_EC2_METADATA_V1_DISABLED
|
Penyedia kredensi IMDS |
AWS_ENABLE_ENDPOINT_DISCOVERY
|
Penemuan titik akhir |
AWS_ENDPOINT_URL
|
Titik akhir khusus layanan |
AWS_ENDPOINT_URL_<SERVICE>
|
Titik akhir khusus layanan |
AWS_IGNORE_CONFIGURED_ENDPOINT_URLS
|
Titik akhir khusus layanan |
AWS_MAX_ATTEMPTS
|
Coba lagi perilaku |
AWS_METADATA_SERVICE_NUM_ATTEMPTS
|
EC2 Metadata contoh Amazon |
AWS_METADATA_SERVICE_TIMEOUT
|
EC2 Metadata contoh Amazon |
AWS_PROFILE
|
Berbagi config dan credentials file |
AWS_REGION
|
Wilayah AWS |
AWS_REQUEST_CHECKSUM_CALCULATION
|
Perlindungan Integritas Data untuk Amazon S3 |
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES
|
Minta kompresi |
AWS_RESPONSE_CHECKSUM_VALIDATION
|
Perlindungan Integritas Data untuk Amazon S3 |
AWS_RETRY_MODE
|
Coba lagi perilaku |
AWS_ROLE_ARN
|
Asumsikan penyedia kredensi peran |
AWS_ROLE_SESSION_NAME
|
Asumsikan penyedia kredensi peran |
AWS_S3_DISABLE_MULTIREGION_ACCESS_POINTS
|
Titik Akses Multi-Wilayah Amazon S3 |
AWS_S3_USE_ARN_REGION
|
Titik akses Amazon S3 |
AWS_SDK_UA_APP_ID
|
ID Aplikasi |
AWS_SECRET_ACCESS_KEY
|
AWS kunci akses |
AWS_SESSION_TOKEN
|
AWS kunci akses |
AWS_SHARED_CREDENTIALS_FILE
|
Lokasi berbagi config dan credentials file |
AWS_STS_REGIONAL_ENDPOINTS
|
AWS STS Titik akhir regional |
AWS_USE_DUALSTACK_ENDPOINT
|
Dual-stack dan titik akhir FIPS |
AWS_USE_FIPS_ENDPOINT
|
Dual-stack dan titik akhir FIPS |
AWS_WEB_IDENTITY_TOKEN_FILE
|
Asumsikan penyedia kredensi peran |
Daftar properti sistem JVM
Anda dapat menggunakan properti sistem JVM berikut untuk AWS SDK untuk Java dan AWS SDK for Kotlin (menargetkan JVM). Lihat Cara mengatur properti sistem JVM petunjuk tentang cara mengatur properti sistem JVM.