Package software.amazon.awssdk.client.builder

Class DefaultClientBuilder<B extends ClientBuilder<B,C>,C>

java.lang.Object

software.amazon.awssdk.client.builder.DefaultClientBuilder<B,C>

Type Parameters:

B - The type of builder, for chaining.

C - The type of client generated by this builder.

All Implemented Interfaces:

ClientBuilder<B,C>, SdkBuilder<B,C>

public abstract class DefaultClientBuilder<B extends ClientBuilder<B,C>,C>
extends Object
implements ClientBuilder<B,C>

An SDK-internal implementation of the methods in ClientBuilder, AsyncClientBuilder and SyncClientBuilder. This implements all methods required by those interfaces, allowing service-specific builders to just implement the configuration they wish to add.

By implementing both the sync and async interface's methods, service-specific builders can share code between their sync and async variants without needing one to extend the other. Note: This only defines the methods in the sync and async builder interfaces. It does not implement the interfaces themselves. This is because the sync and async client builder interfaces both require a type-constrained parameter for use in fluent chaining, and a generic type parameter conflict is introduced into the class hierarchy by this interface extending the builder interfaces themselves.

Like all ClientBuilders, this class is not thread safe.

Method Summary

Modifier and Type	Method	Description
B	asyncExecutorProvider(ExecutorProvider asyncExecutorProvider)
B	asyncHttpConfiguration(ClientAsyncHttpConfiguration asyncHttpConfiguration)
C	build()	Build a client using the current state of this builder.
B	credentialsProvider(AwsCredentialsProvider credentialsProvider)	Configure the credentials that should be used to authenticate with AWS.
B	endpointOverride(URI endpointOverride)	Configure the endpoint with which the SDK should communicate.
B	httpConfiguration(ClientHttpConfiguration httpConfiguration)
B	overrideConfiguration(ClientOverrideConfiguration overrideConfiguration)	Specify overrides to the default SDK configuration that should be used for clients created by this builder.
B	region(Region region)	Configure the region with which the SDK should communicate.
void	setAsyncExecutorProvider(ExecutorProvider asyncExecutorProvider)
void	setAsyncHttpConfiguration(ClientAsyncHttpConfiguration asyncHttpConfiguration)
void	setCredentialsProvider(AwsCredentialsProvider credentialsProvider)
void	setEndpointOverride(URI endpointOverride)
void	setHttpConfiguration(ClientHttpConfiguration httpConfiguration)
void	setOverrideConfiguration(ClientOverrideConfiguration overrideConfiguration)
void	setRegion(Region region)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply

Method Detail

build

public final C build()

Build a client using the current state of this builder. This is marked final in order to allow this class to add standard "build" logic between all service clients. Service clients are expected to implement the buildClient() method, that accepts the immutable client configuration generated by this build method.

Specified by:

build in interface SdkBuilder<B extends ClientBuilder<B,C>,C>

Returns:

an instance of T

region

public final B region(Region region)

Description copied from interface: ClientBuilder

Configure the region with which the SDK should communicate.

If this is not specified, the SDK will attempt to identify the endpoint automatically using the following logic:

1. Check the 'aws.region' system property for the region.
2. Check the 'AWS_REGION' environment variable for the region.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the region.
4. If running in EC2, check the EC2 metadata service for the region.

Specified by:

region in interface ClientBuilder<B extends ClientBuilder<B,C>,C>

setRegion

public final void setRegion(Region region)

endpointOverride

public B endpointOverride(URI endpointOverride)

Description copied from interface: ClientBuilder

Configure the endpoint with which the SDK should communicate. This will take precedent over the endpoint derived from the ClientBuilder.region(Region). Even when this is used, the ClientBuilder.region(Region) must still be specified for the purposes of message signing.

Specified by:

endpointOverride in interface ClientBuilder<B extends ClientBuilder<B,C>,C>

setEndpointOverride

public void setEndpointOverride(URI endpointOverride)

asyncExecutorProvider

public B asyncExecutorProvider(ExecutorProvider asyncExecutorProvider)

setAsyncExecutorProvider

public void setAsyncExecutorProvider(ExecutorProvider asyncExecutorProvider)

overrideConfiguration

public final B overrideConfiguration(ClientOverrideConfiguration overrideConfiguration)

Description copied from interface: ClientBuilder

Specify overrides to the default SDK configuration that should be used for clients created by this builder.

Specified by:

overrideConfiguration in interface ClientBuilder<B extends ClientBuilder<B,C>,C>

setOverrideConfiguration

public final void setOverrideConfiguration(ClientOverrideConfiguration overrideConfiguration)

httpConfiguration

public final B httpConfiguration(ClientHttpConfiguration httpConfiguration)

setHttpConfiguration

public final void setHttpConfiguration(ClientHttpConfiguration httpConfiguration)

asyncHttpConfiguration

public final B asyncHttpConfiguration(ClientAsyncHttpConfiguration asyncHttpConfiguration)

setAsyncHttpConfiguration

public final void setAsyncHttpConfiguration(ClientAsyncHttpConfiguration asyncHttpConfiguration)

credentialsProvider

public final B credentialsProvider(AwsCredentialsProvider credentialsProvider)

Description copied from interface: ClientBuilder

Configure the credentials that should be used to authenticate with AWS.

The default provider will attempt to identify the credentials automatically using the following checks:

1. Java System Properties - aws.accessKeyId and aws.secretKey
2. Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
3. Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
4. Credentials delivered through the Amazon EC2 container service if AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment variable is set and security manager has permission to access the variable.
5. Instance profile credentials delivered through the Amazon EC2 metadata service

If the credentials are not found in any of the locations above, an exception will be thrown at SdkBuilder.build() time.

Specified by:

credentialsProvider in interface ClientBuilder<B extends ClientBuilder<B,C>,C>

setCredentialsProvider

public final void setCredentialsProvider(AwsCredentialsProvider credentialsProvider)