Mengkonfigurasi titik akhir klien di AWS SDK for Java 2.x

SDK for Java 2.x menyediakan beberapa cara untuk mengonfigurasi titik akhir layanan. Endpoint adalah URL yang digunakan SDK untuk melakukan panggilan API. Layanan AWS Secara default, SDK secara otomatis menentukan titik akhir yang sesuai untuk setiap layanan berdasarkan konfigurasi yang telah Wilayah AWS Anda konfigurasi. Namun, ada skenario di mana Anda mungkin perlu menyesuaikan atau mengganti titik akhir ini:

Opsi konfigurasi titik akhir

AWS SDK for Java 2.x Ini menyediakan beberapa cara untuk mengkonfigurasi titik akhir:

Konfigurasi titik akhir dalam kode

Menggunakan endpointOverride

Cara paling langsung untuk mengonfigurasi titik akhir adalah dengan menggunakan endpointOverride metode pada pembuat klien layanan. Metode ini menerima URI objek yang mewakili URL endpoint kustom.

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import java.net.URI;

S3Client s3 = S3Client.builder()
        .region(Region.US_WEST_2)
        .endpointOverride(URI.create("https://my-custom-s3-endpoint.example.com"))
        .build();
                

Saat menggunakanendpointOverride, Anda masih harus menentukan wilayah untuk klien, meskipun titik akhir disetel secara eksplisit. Wilayah ini digunakan untuk menandatangani permintaan.

Penemuan titik akhir

Beberapa Layanan AWS mendukung penemuan titik akhir, di mana SDK dapat secara otomatis menemukan titik akhir optimal untuk digunakan. Anda dapat mengaktifkan atau menonaktifkan fitur ini menggunakan endpointDiscoveryEnabled metode pada pembuat klien layanan.

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;

DynamoDbClient dynamoDb = DynamoDbClient.builder()
        .region(Region.US_WEST_2)
        .endpointDiscoveryEnabled(true)
        .build();
                

Konfigurasi titik akhir tingkat permintaan

Dalam beberapa kasus, Anda mungkin perlu mengganti titik akhir untuk permintaan tertentu saat menggunakan klien yang sama untuk permintaan lain dengan titik akhir default. AWS SDK for Java 2.x Mendukung ini melalui penggantian permintaan.

import software.amazon.awssdk.core.SdkRequest;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.GetObjectRequest;
import software.amazon.awssdk.http.SdkHttpRequest;

S3Client s3 = S3Client.builder()
        .region(Region.US_WEST_2)
        .build();

// Create a request
GetObjectRequest getObjectRequest = GetObjectRequest.builder()
        .bucket("my-bucket")
        .key("my-key")
        .overrideConfiguration(c -> c.putHeader("Host", "custom-endpoint.example.com"))
        .build();

// Execute the request with the custom endpoint
s3.getObject(getObjectRequest);
            

Perhatikan bahwa penggantian titik akhir tingkat permintaan terbatas dan mungkin tidak berfungsi untuk semua layanan atau skenario. Untuk kebanyakan kasus, disarankan untuk menggunakan konfigurasi titik akhir tingkat klien.

Konfigurasi titik akhir eksternal

Menggunakan variabel lingkungan

Anda dapat mengonfigurasi titik akhir menggunakan variabel lingkungan. SDK mendukung konfigurasi titik akhir khusus layanan melalui variabel lingkungan dalam formatAWS_ENDPOINT_URL_[SERVICE], di mana [SERVICE] adalah pengenal layanan huruf besar.

# For Linux/macOS
export AWS_ENDPOINT_URL_S3=https://my-custom-s3-endpoint.example.com

# For Windows
set AWS_ENDPOINT_URL_S3=https://my-custom-s3-endpoint.example.com
                

Anda juga dapat mengatur awalan atau akhiran URL endpoint global menggunakan variabel lingkungan berikut:

Menggunakan properti sistem JVM

Anda juga dapat mengonfigurasi titik akhir menggunakan properti sistem JVM. Formatnya mirip dengan variabel lingkungan tetapi menggunakan konvensi penamaan yang berbeda.

java -Daws.endpointUrl.s3=https://my-custom-s3-endpoint.example.com -jar your-application.jar
                

Konfigurasi endpoint global juga tersedia melalui properti sistem:

Menggunakan file AWS konfigurasi bersama

Ini AWS SDK for Java 2.x juga mendukung konfigurasi titik akhir melalui file AWS konfigurasi bersama, biasanya terletak di ~/.aws/config (Linux/macOS) atau (Windows). %USERPROFILE%\.aws\config Lihat Panduan Referensi Alat AWS SDKs dan untuk informasi dan contoh.

Konfigurasi diutamakan

Ketika beberapa konfigurasi titik akhir hadir, SDK mengikuti urutan prioritas ini (dari tertinggi ke terendah):

Konfigurasi titik akhir khusus layanan

Beberapa Layanan AWS memiliki opsi konfigurasi titik akhir tambahan khusus untuk layanan itu. Berikut adalah beberapa contoh:

Konfigurasi Titik Akhir Amazon S3

Amazon S3 mendukung beberapa konfigurasi titik akhir melalui kelas: S3Configuration

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.S3Configuration;

S3Client s3 = S3Client.builder()
        .region(Region.US_WEST_2)
        .serviceConfiguration(S3Configuration.builder()
                .accelerateModeEnabled(true)
                .dualstackEnabled(true)
                .pathStyleAccessEnabled(false)
                .fipsModeEnabled(true)
                .build())
        .build();
                

Konfigurasi titik akhir DynamoDB

Untuk DynamoDB, Anda mungkin ingin menggunakan penemuan titik akhir atau terhubung ke DynamoDB lokal untuk pengujian:

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import java.net.URI;

DynamoDbClient dynamoDb = DynamoDbClient.builder()
        .endpointOverride(URI.create("http://localhost:8000"))
        // The region is meaningless for DynamoDB local but required for the client builder.
        .region(Region.US_WEST_2)
        .build();
                

DynamoDB juga mendukung penggunaan endpoint berbasis akun, yang dapat Anda konfigurasi dalam kode atau menggunakan pengaturan eksternal. Contoh berikut menunjukkan cara menonaktifkan penggunaan endpoint berbasis akun dalam kode saat Anda membuat klien (pengaturan default lebih disukai):

DynamoDbClient dynamoDbClient = DynamoDbClient.builder()
    .region(Region.US_EAST_1)
    .accountIdEndpointMode(AccountIdEndpointMode.DISABLED)
    .build();

Praktik terbaik

Saat mengonfigurasi titik akhir di AWS SDK for Java 2.x, pertimbangkan praktik terbaik ini: