Package software.amazon.awssdk.services.s3

Class S3Utilities.Builder

java.lang.Object

software.amazon.awssdk.services.s3.S3Utilities.Builder

Enclosing class:

S3Utilities

public static final class S3Utilities.Builder
extends Object

Builder class to construct S3Utilities object

Method Summary

Modifier and Type	Method	Description
S3Utilities	build()	Construct a S3Utilities object.
S3Utilities.Builder	dualstackEnabled(Boolean dualstackEnabled)	Configure whether the SDK should use the AWS dualstack endpoint.
S3Utilities.Builder	endpoint(URI endpoint)	The default endpoint to use when working with the methods in S3Utilities class.
S3Utilities.Builder	fipsEnabled(Boolean fipsEnabled)	Configure whether the SDK should use the AWS fips endpoint.
S3Utilities.Builder	region(Region region)	The default region to use when working with the methods in S3Utilities class.
S3Utilities.Builder	s3Configuration(S3Configuration s3Configuration)	Sets the S3 configuration to enable options like path style access, dual stack, accelerate mode etc.

Methods inherited from class java.lang.Object

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

Method Detail

region

public S3Utilities.Builder region(Region region)

The default region to use when working with the methods in S3Utilities class. There can be methods in S3Utilities that don't need the region info. In that case, this option will be ignored when using those methods.

Returns:

This object for method chaining

endpoint

public S3Utilities.Builder endpoint(URI endpoint)

The default endpoint to use when working with the methods in S3Utilities class. There can be methods in S3Utilities that don't need the endpoint info. In that case, this option will be ignored when using those methods.

Returns:

This object for method chaining

dualstackEnabled

public S3Utilities.Builder dualstackEnabled(Boolean dualstackEnabled)

Configure whether the SDK should use the AWS dualstack endpoint.

If this is not specified, the SDK will attempt to determine whether the dualstack endpoint should be used automatically using the following logic:

1. Check the 'aws.useDualstackEndpoint' system property for 'true' or 'false'.
2. Check the 'AWS_USE_DUALSTACK_ENDPOINT' environment variable for 'true' or 'false'.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the 'use_dualstack_endpoint' property set to 'true' or 'false'.

If the setting is not found in any of the locations above, 'false' will be used.

fipsEnabled

public S3Utilities.Builder fipsEnabled(Boolean fipsEnabled)

Configure whether the SDK should use the AWS fips endpoint.

If this is not specified, the SDK will attempt to determine whether the fips endpoint should be used automatically using the following logic:

1. Check the 'aws.useFipsEndpoint' system property for 'true' or 'false'.
2. Check the 'AWS_USE_FIPS_ENDPOINT' environment variable for 'true' or 'false'.
3. Check the {user.home}/.aws/credentials and {user.home}/.aws/config files for the 'use_fips_endpoint' property set to 'true' or 'false'.

If the setting is not found in any of the locations above, 'false' will be used.

s3Configuration

public S3Utilities.Builder s3Configuration(S3Configuration s3Configuration)

Sets the S3 configuration to enable options like path style access, dual stack, accelerate mode etc. There can be methods in S3Utilities that don't need the region info. In that case, this option will be ignored when using those methods.

Returns:

This object for method chaining

build

public S3Utilities build()

Construct a S3Utilities object.