のコードでサービスクライアントを設定する AWS SDK for Java 2.x

外部でサービスクライアントを設定する代わりに、または追加して、プログラムでコードでサービスクライアントを設定できます。

サービスクライアントをコードで設定することで、利用可能な多くのオプションをきめ細かく制御できます。外部で設定できる設定のほとんどは、コードで設定することもできます。

コードの基本設定

たとえば、次のスニペットでは、Amazon S3 サービスクライアントの AWS リージョン EU_SOUTH_2 をコードで に設定します。

S3Client s3Client = S3Client.builder()
        .region(Region.EU_SOUTH_2)
        .build();

前のスニペットは、静的ファクトリメソッド を示していますbuilder()。builder() メソッドは、サービスクライアントをカスタマイズできる builder オブジェクトを返します。流暢なセッターメソッドは、この場合はS3ClientBuilderインスタンスである builder オブジェクトを返すため、メソッドの呼び出しを連鎖させて利便性を高め、コードを読みやすくすることができます。必要なプロパティを設定した後、build() メソッドを呼び出してクライアントを作成します。

コードの高度な設定

次のスニペットは、追加の設定オプションを示しています。

ClientOverrideConfiguration clientOverrideConfiguration =
        ClientOverrideConfiguration.builder()
                .apiCallAttemptTimeout(Duration.ofSeconds(1))
                .addMetricPublisher(CloudWatchMetricPublisher.create())
                .build();

S3Client s3Client = S3Client.builder()
        .region(Region.EU_SOUTH_2)
        .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
        .overrideConfiguration(clientOverrideConfiguration)
        .httpClientBuilder(
                ApacheHttpClient.builder()
                        .maxConnections(100)
                        .connectionTimeout(Duration.ofSeconds(5))
                        .proxyConfiguration(ProxyConfiguration.builder()
                                .endpoint(URI.create("http://proxy:8080"))
                                .build())
        ).build();

前のスニペットでは、サービスクライアントを設定するためのいくつかのエントリポイントを確認できます。

S3Client s3Client = S3Client.builder()
        .region(Region.EU_SOUTH_2)
        .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
        .overrideConfiguration(b -> b
                .apiCallAttemptTimeout(Duration.ofSeconds(1))
                .addMetricPublisher(CloudWatchMetricPublisher.create()))
        .httpClientBuilder(ApacheHttpClient.builder()
                .maxConnections(100)
                .connectionTimeout(Duration.ofSeconds(5))
                .proxyConfiguration(ProxyConfiguration.builder()
                        .endpoint(URI.create("http://proxy:8080"))
                        .build()))
        .build();

コードで使用できない設定オプション

次の設定は SDK の基本的な初期化プロセスに影響するため、次の設定は外部でのみ設定でき、コードでは設定できません。

ファイルの場所の設定

これらの設定は、共有設定ファイルと認証情報ファイルの場所を制御し、SDK がファイルを読み込んだ後にプログラムで上書きすることはできません。

これらの設定は、SDK が設定ファイルを読み込む前に設定する必要があります。SDK が設定を検索する場所を決定します。SDK が初期化されると、これらの値を変更しても効果はありません。

インスタンスメタデータサービスの無効化

この設定は、SDK が EC2 インスタンスメタデータサービスをまったく使用しようとするかどうかを制御します。SDK が初期化されると、この設定をプログラムで変更することはできません。

プロファイルの選択

この設定は、共有設定ファイルと認証情報ファイルからロードするプロファイルを SDK に指示します。ロード後、この値を変更しても効果はありません。

コンテナ認証情報パス

これらの環境変数を使用して、コンテナサービスから認証情報を取得する方法を SDK に指示します。サービスクライアントの初期化中に認証情報プロバイダーチェーンが確立されると、これらの設定を変更することはできません。

デフォルトの HTTP 実装の選択

これらのグローバル設定は、個々のサービスクライアントのコードで上書きされない限り、SDK がすべてのサービスクライアントに使用する HTTP クライアントの実装を決定します。SDK が HTTP クライアントを初期化する前にこれらを設定する必要があります。後で変更することはできません。