Package software.amazon.awssdk.services.dynamodb.datamodeling

Class S3ClientCache

java.lang.Object

software.amazon.awssdk.services.dynamodb.datamodeling.S3ClientCache

public class S3ClientCache
extends Object

A smart Map for S3Client objects. S3ClientCache keeps the clients organized by region, and if provided AwsCredentials will create clients on the fly. Otherwise it just return clients given to it with useClient(S3Client, Region).

Method Summary

Modifier and Type	Method	Description
S3Client	getClient(String region)	Returns a client for the requested region, or throws an exception when unable.
S3Client	getClient(Region region)	Returns a client for the requested region, or throws an exception when unable.
void	useClient(S3Client client, Region region)	Force the client cache to provide a certain client for the region which that client is configured.

Methods inherited from class java.lang.Object

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

Method Detail

useClient

public void useClient(S3Client client,
                      Region region)

Force the client cache to provide a certain client for the region which that client is configured. This can be useful to provide clients with different S3AdvancedConfiguration.

Parameters:

client - An S3Client to use in the cache. Its region will be detected automatically.

getClient

public S3Client getClient(Region region)

Returns a client for the requested region, or throws an exception when unable.

Parameters:

region - The region the returned S3Client will be configured to use.

Returns:

A client for the given region from the cache, either instantiated automatically from the provided AwsCredentials or provided with useClient(S3Client, Region).

Throws:

IllegalArgumentException - When a region is requested that has not been provided to the cache with useClient(S3Client, Region), and the cache has no AwsCredentials with which a client may be instantiated.

getClient

public S3Client getClient(String region)

Returns a client for the requested region, or throws an exception when unable.

Parameters:

region - The region the returned S3Client will be configured to use.

Returns:

A client for the given region from the cache, either instantiated automatically from the provided AwsCredentials or provided with useClient(S3Client, Region).

Throws:

IllegalArgumentException - When a region is requested that has not been provided to the cache with useClient(S3Client, Region), and the cache has no AwsCredentials with which a client may be instantiated.