Referensi pengaturan

SDKsmenyediakan bahasa khusus APIs untuk. Layanan AWS Mereka menangani beberapa pekerjaan berat yang diperlukan dalam berhasil melakukan API panggilan, 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 SDKsdan Penyedia kredensi standar Alat— Penyedia kredensi umum distandarisasi di beberapa. SDKs

• AWS SDKsdan 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 AmazonEC2, 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 besarSDKs, 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:

1. 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 AWS Tools for PowerShell, ini mengambil bentuk parameter per operasi yang Anda masukkan pada baris perintah. UntukSDK, tugas eksplisit dapat mengambil bentuk parameter yang Anda tetapkan ketika Anda membuat instance Layanan AWS klien atau objek konfigurasi, atau kadang-kadang ketika Anda memanggil individu. API

2. Hanya Java/Kotlin: Properti JVM sistem untuk pengaturan dicentang. Jika disetel, nilai itu digunakan untuk mengkonfigurasi klien.

3. Variabel lingkungan diperiksa. Jika disetel, nilai itu digunakan untuk mengkonfigurasi klien.

4. SDKMemeriksa credentials file bersama untuk pengaturan. Jika sudah diatur, klien menggunakannya.

5. configFile bersama untuk pengaturan. Jika pengaturan hadir, SDK menggunakannya.

   • Variabel AWS_PROFILE lingkungan atau properti aws.profile JVM sistem dapat digunakan untuk menentukan profil mana yang SDK dimuat.

6. Setiap nilai default yang disediakan oleh kode SDK sumber 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 SDKStore. Untuk informasi selengkapnya tentang penyedia yang unik untuk alat SDK atau, 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, itu hanya ditemukan dan digunakan setelah alat SDK atau 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 API parameter) atau dalam kode akan mengesampingkan semua nilai lain untuk satu perintah itu.

Halaman pengaturan

Halaman-halaman dalam bagian referensi Pengaturan dari 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 KotlinSDKs) JVM setelan yang dapat digunakan di luar kode Anda untuk mengonfigurasi fitur. Setiap topik tertaut di setiap daftar membawa Anda ke halaman pengaturan yang sesuai.

• Configdaftar pengaturan file

• Credentialsdaftar pengaturan file

• Daftar variabel lingkungan

• JVMdaftar properti sistem

Setiap penyedia kredensi atau fitur memiliki halaman di mana 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 JVM sistem. 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 mengkomunikasikan 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 KotlinSDK, atur sebagai properti JVM sistem menggunakan aws.disableRequestCompression

  catatan

  Mungkin juga ada cara untuk mengonfigurasi fungsionalitas yang sama secara langsung dalam kode Anda, tetapi Referensi ini tidak mencakup ini karena unik untuk masing-masingSDK. Jika Anda ingin mengatur konfigurasi Anda dalam kode itu sendiri, lihat SDK panduan atau API referensi khusus Anda.

• Jika Anda tidak melakukan apa-apa, nilainya akan default kefalse.

• Satu-satunya nilai yang valid untuk pengaturan Boolean ini adalah true danfalse.

Di bagian bawah setiap halaman fitur ada Kompatibilitas dengan AWS SDKs tabel.

Tabel ini menunjukkan apakah Anda SDK mendukung pengaturan yang tercantum pada halaman. SupportedKolom 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.

Configdaftar pengaturan file

Pengaturan yang tercantum dalam tabel berikut dapat ditetapkan dalam AWS config file bersama. Mereka global dan mempengaruhi semua Layanan AWS. SDKsdan alat juga dapat mendukung pengaturan unik dan variabel lingkungan. Untuk melihat pengaturan dan variabel lingkungan yang hanya didukung oleh individu SDK atau alat, lihat panduan khusus SDK atau alat tersebut.

Nama pengaturan	Detail
account_id_endpoint_mode	Titik akhir berbasis akun
api_versions	Pengaturan konfigurasi umum
aws_access_key_id	AWS kunci akses
aws_account_id	Titik akhir berbasis akun
aws_secret_access_key	AWS kunci akses
aws_session_token	AWS kunci akses
ca_bundle	Pengaturan konfigurasi umum
credential_process	Penyedia kredensi proses
credential_source	Asumsikan penyedia kredensi peran
defaults_mode	Default konfigurasi cerdas
disable_request_compression	Minta kompresi
duration_seconds	Asumsikan penyedia kredensi peran
ec2_metadata_service_endpoint	IMDSpenyedia kredensi
ec2_metadata_service_endpoint_mode	IMDSpenyedia kredensi
ec2_metadata_v1_disabled	IMDSpenyedia kredensi
endpoint_discovery_enabled	Penemuan titik akhir
endpoint_url	Titik akhir khusus layanan
external_id	Asumsikan penyedia kredensi peran
ignore_configured_endpoint_urls	Titik akhir khusus layanan
max_attempts	Coba lagi perilaku
metadata_service_num_attempts	EC2Metadata contoh Amazon
metadata_service_timeout	EC2Metadata contoh Amazon
mfa_serial	Asumsikan penyedia kredensi peran
output	Pengaturan konfigurasi umum
parameter_validation	Pengaturan konfigurasi umum
region	Wilayah AWS
request_min_compression_size_bytes	Minta kompresi
retry_mode	Coba lagi perilaku
role_arn	Asumsikan penyedia kredensi peran
role_session_name	Asumsikan penyedia kredensi peran
s3_disable_multiregion_access_points	Titik Akses Multi-Wilayah Amazon S3
s3_use_arn_region	Titik akses Amazon S3
sdk_ua_app_id	ID Aplikasi
source_profile	Asumsikan penyedia kredensi peran
sso_account_id	IAMPenyedia kredensi Pusat Identitas
sso_region	IAMPenyedia kredensi Pusat Identitas
sso_registration_scopes	IAMPenyedia kredensi Pusat Identitas
sso_role_name	IAMPenyedia kredensi Pusat Identitas
sso_start_url	IAMPenyedia kredensi Pusat Identitas
sts_regional_endpoints	AWS STS Titik akhir regional
use_dualstack_endpoint	Tumpukan ganda dan titik akhir FIPS
use_fips_endpoint	Tumpukan ganda dan titik akhir FIPS
web_identity_token_file	Asumsikan penyedia kredensi peran

Credentialsdaftar pengaturan file

Pengaturan yang tercantum dalam tabel berikut dapat ditetapkan dalam AWS credentials file bersama. Mereka global dan mempengaruhi semua Layanan AWS. SDKsdan alat juga dapat mendukung pengaturan unik dan variabel lingkungan. Untuk melihat pengaturan dan variabel lingkungan yang hanya didukung oleh individu SDK atau alat, lihat panduan khusus SDK atau alat tersebut.

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. SDKsdan alat juga dapat mendukung pengaturan unik dan variabel lingkungan. Untuk melihat pengaturan dan variabel lingkungan yang hanya didukung oleh individu SDK atau alat, lihat panduan khusus SDK atau alat tersebut.

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 yang dibagikan 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	IMDSpenyedia kredensi
AWS_EC2_METADATA_SERVICE_ENDPOINT	IMDSpenyedia kredensi
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE	IMDSpenyedia kredensi
AWS_EC2_METADATA_V1_DISABLED	IMDSpenyedia kredensi
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	EC2Metadata contoh Amazon
AWS_METADATA_SERVICE_TIMEOUT	EC2Metadata contoh Amazon
AWS_PROFILE	Berbagi config dan credentials file
AWS_REGION	Wilayah AWS
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES	Minta kompresi
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 yang dibagikan config dan credentials file
AWS_STS_REGIONAL_ENDPOINTS	AWS STS Titik akhir regional
AWS_USE_DUALSTACK_ENDPOINT	Tumpukan ganda dan titik akhir FIPS
AWS_USE_FIPS_ENDPOINT	Tumpukan ganda dan titik akhir FIPS
AWS_WEB_IDENTITY_TOKEN_FILE	Asumsikan penyedia kredensi peran

JVMdaftar properti sistem

Anda dapat menggunakan properti JVM sistem berikut untuk AWS SDK for Java dan AWS SDK for Kotlin (menargetkanJVM). Lihat Cara mengatur properti sistem JVM petunjuk tentang cara mengatur properti JVM sistem.

Nama pengaturan	Detail
aws.accessKeyId	AWS kunci akses
aws.accountId	Titik akhir berbasis akun
aws.accountIdEndpointMode	Titik akhir berbasis akun
aws.configFile	Lokasi yang dibagikan config dan credentials file
aws.defaultsMode	Default konfigurasi cerdas
aws.disableEc2MetadataV1	IMDSpenyedia kredensi
aws.disableRequestCompression	Minta kompresi
aws.ec2MetadataServiceEndpoint	IMDSpenyedia kredensi
aws.ec2MetadataServiceEndpointMode	IMDSpenyedia kredensi
aws.endpointDiscoveryEnabled	Penemuan titik akhir
aws.endpointUrl	Titik akhir khusus layanan
aws.endpointUrl<ServiceName>	Titik akhir khusus layanan
aws.ignoreConfiguredEndpointUrls	Titik akhir khusus layanan
aws.maxAttempts	Coba lagi perilaku
aws.profile	Berbagi config dan credentials file
aws.region	Wilayah AWS
aws.requestMinCompressionSizeBytes	Minta kompresi
aws.retryMode	Coba lagi perilaku
aws.roleArn	Asumsikan penyedia kredensi peran
aws.roleSessionName	Asumsikan penyedia kredensi peran
aws.s3DisableMultiRegionAccessPoints	Titik Akses Multi-Wilayah Amazon S3
aws.s3UseArnRegion	Titik akses Amazon S3
aws.secretAccessKey	AWS kunci akses
aws.sessionToken	AWS kunci akses
aws.sharedCredentialsFile	Lokasi yang dibagikan config dan credentials file
aws.useDualstackEndpoint	Tumpukan ganda dan titik akhir FIPS
aws.useFipsEndpoint	Tumpukan ganda dan titik akhir FIPS
aws.userAgentAppId	ID Aplikasi
aws.webIdentityTokenFile	Asumsikan penyedia kredensi peran