software.amazon.awssdk.awscore.client.builder

Class AwsDefaultClientBuilder<B extends AwsClientBuilder<B,C>,C>

java.lang.Object

software.amazon.awssdk.core.client.builder.SdkDefaultClientBuilder<B,C>

software.amazon.awssdk.awscore.client.builder.AwsDefaultClientBuilder<B,C>

Type Parameters:

B - The type of builder, for chaining.

C - The type of client generated by this builder.

All Implemented Interfaces:

AwsClientBuilder<B,C>, SdkClientBuilder<B,C>, SdkBuilder<B,C>

public abstract class AwsDefaultClientBuilder<B extends AwsClientBuilder<B,C>,C>
extends SdkDefaultClientBuilder<B,C>
implements AwsClientBuilder<B,C>

An SDK-internal implementation of the methods in AwsClientBuilder, AwsAsyncClientBuilder and AwsSyncClientBuilder. 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 AwsClientBuilders, this class is not thread safe.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awssdk.core.client.builder.SdkDefaultClientBuilder

SdkDefaultClientBuilder.NonManagedSdkAsyncHttpClient, SdkDefaultClientBuilder.NonManagedSdkHttpClient

Method Summary

Modifier and Type	Method and Description
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	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	setCredentialsProvider(AwsCredentialsProvider credentialsProvider)
void	setRegion(Region region)

Methods inherited from class software.amazon.awssdk.core.client.builder.SdkDefaultClientBuilder

asyncExecutorProvider, asyncHttpConfiguration, build, httpConfiguration, setAsyncExecutorProvider, setAsyncHttpConfiguration, setEndpointOverride, setHttpConfiguration, setOverrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.core.client.builder.SdkClientBuilder

overrideConfiguration

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

apply, build

Method Detail

endpointOverride

public B endpointOverride(URI endpointOverride)

Description copied from interface: SdkClientBuilder

Configure the endpoint with which the SDK should communicate.

Specified by:

endpointOverride in interface SdkClientBuilder<B extends AwsClientBuilder<B,C>,C>

Overrides:

endpointOverride in class SdkDefaultClientBuilder<B extends AwsClientBuilder<B,C>,C>

overrideConfiguration

public final B overrideConfiguration(ClientOverrideConfiguration overrideConfiguration)

Description copied from interface: SdkClientBuilder

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

Specified by:

overrideConfiguration in interface SdkClientBuilder<B extends AwsClientBuilder<B,C>,C>

Overrides:

overrideConfiguration in class SdkDefaultClientBuilder<B extends AwsClientBuilder<B,C>,C>

region

public final B region(Region region)

Description copied from interface: AwsClientBuilder

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 AwsClientBuilder<B extends AwsClientBuilder<B,C>,C>

setRegion

public final void setRegion(Region region)

credentialsProvider

public final B credentialsProvider(AwsCredentialsProvider credentialsProvider)

Description copied from interface: AwsClientBuilder

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 AwsClientBuilder<B extends AwsClientBuilder<B,C>,C>

setCredentialsProvider

public final void setCredentialsProvider(AwsCredentialsProvider credentialsProvider)